Skip to content

Commit

Permalink
better human readible display of the config (#45)
Browse files Browse the repository at this point in the history 
Signed-off-by: Alex Goodman <[email protected]>

Signed-off-by: Alex Goodman <[email protected]>
  • Loading branch information
@wagoodman
wagoodman authored Jan 17, 2023
1 parent de5e4f8 commit 66b2b06
Show file tree
Hide file tree
Showing 2 changed files with 229 additions and 1 deletion.
48 changes: 47 additions & 1 deletion src/vunnel/cli/cli.py
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import dataclasses
import enum
import logging
from typing import Any

import click
import yaml
Expand Down Expand Up @@ -77,7 +79,51 @@ class IndentDumper(yaml.Dumper):
def increase_indent(self, flow: bool = False, indentless: bool = False) -> None:
return super().increase_indent(flow, False)

cfg_dict = dataclasses.asdict(cfg)
def enum_asdict_factory(data: list[tuple[str, Any]]) -> dict[Any, Any]:
# prevents showing oddities such as
#
# wolfi:
# request_timeout: 125
# runtime:
# existing_input: !!python/object/apply:vunnel.provider.InputStatePolicy
# - keep
# existing_results: !!python/object/apply:vunnel.provider.ResultStatePolicy
# - delete-before-write
# on_error:
# action: !!python/object/apply:vunnel.provider.OnErrorAction
# - fail
# input: !!python/object/apply:vunnel.provider.InputStatePolicy
# - keep
# results: !!python/object/apply:vunnel.provider.ResultStatePolicy
# - keep
# retry_count: 3
# retry_delay: 5
# result_store: !!python/object/apply:vunnel.result.StoreStrategy
# - flat-file
#
# and instead preferring:
#
# wolfi:
# request_timeout: 125
# runtime:
# existing_input: keep
# existing_results: delete-before-write
# on_error:
# action: fail
# input: keep
# results: keep
# retry_count: 3
# retry_delay: 5
# result_store: flat-file

def convert_value(obj: Any) -> Any:
if isinstance(obj, enum.Enum):
return obj.value
return obj

return {k: convert_value(v) for k, v in data}

cfg_dict = dataclasses.asdict(cfg, dict_factory=enum_asdict_factory)
print(yaml.dump(cfg_dict, Dumper=IndentDumper, default_flow_style=False))


Expand Down
182 changes: 182 additions & 0 deletions tests/unit/cli/test_cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,185 @@ def test_clear(mocker, monkeypatch, args, clear, clear_input, clear_results) ->
assert workspace_mock.clear.call_count == clear
assert workspace_mock.clear_input.call_count == clear_input
assert workspace_mock.clear_results.call_count == clear_results


def test_config(monkeypatch) -> None:
envs = {
"NVD_API_KEY": "secret",
"GITHUB_TOKEN": "secret",
}
monkeypatch.setattr(os, "environ", envs)

runner = CliRunner()
res = runner.invoke(cli.cli, ["-c", "-", "config"])
assert res.exit_code == 0
expected_output = """
log:
level: INFO
slim: false
providers:
alpine:
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
amazon:
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
security_advisories:
'2': https://alas.aws.amazon.com/AL2/alas.rss
'2022': https://alas.aws.amazon.com/AL2022/alas.rss
centos:
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
skip_namespaces:
- centos:3
- centos:4
debian:
distro_map:
bookworm: '12'
bullseye: '11'
buster: '10'
jessie: '8'
sid: unstable
stretch: '9'
trixie: '13'
wheezy: '7'
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
github:
api_url: https://api.github.com/graphql
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
token: secret
nvd:
api_key: secret
request_timeout: 125
runtime:
existing_input: keep
existing_results: keep
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
oracle:
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
rhel:
full_sync_interval: 2
max_workers: 4
request_timeout: 125
runtime:
existing_input: keep
existing_results: keep
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
skip_namespaces:
- rhel:3
- rhel:4
sles:
allow_versions:
- '11'
- '12'
- '15'
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
ubuntu:
additional_versions: {}
enable_rev_history: true
max_workers: 8
request_timeout: 125
runtime:
existing_input: keep
existing_results: keep
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
wolfi:
request_timeout: 125
runtime:
existing_input: keep
existing_results: delete-before-write
on_error:
action: fail
input: keep
results: keep
retry_count: 3
retry_delay: 5
result_store: sqlite
root: ./data
"""
assert expected_output.strip() in res.output

0 comments on commit 66b2b06

Please sign in to comment.