1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
"""Define acceptance tests for better logging (#619)."""
from __future__ import annotations
import itertools
import logging
from pathlib import Path
from unittest.mock import MagicMock
import click.testing
import pyspry
import pytest
import pytest_mock
import typer
from typer import testing
from config_ninja import cli
from config_ninja import settings as settings_module
try:
from typing import TypedDict
except ImportError:
from typing_extensions import TypedDict
# pylint: disable=redefined-outer-name
CONFIG_OBJECTS = ['example-local', 'example-local-template']
GLOBAL_OPTION_ANNOTATIONS = {
'config': cli.ConfigAnnotation,
'get_help': cli.HelpAnnotation,
'verbose': cli.VerbosityAnnotation,
'version': cli.VersionAnnotation,
}
def _recurse_sub_apps(app: typer.Typer | None) -> list[typer.Typer]:
if not app:
return []
return [app] + [sub_app for group in app.registered_groups for sub_app in _recurse_sub_apps(group.typer_instance)]
all_apps = _recurse_sub_apps(cli.app)
typer_cmd_infos = [
callable
for app in all_apps
for callable in app.registered_commands + ([app.registered_callback] if app.registered_callback else [])
if not callable.deprecated
]
runner = testing.CliRunner()
class TruthT(TypedDict):
"""Type annotation for the structure of the truth dictionary."""
dest: settings_module.DestSpec
source: pyspry.Source
source_path: str
def config_ninja(*args: str) -> click.testing.Result:
"""Run the `config-ninja` command with the given arguments."""
return runner.invoke(cli.app, args, prog_name='config-ninja')
@pytest.fixture
def settings() -> pyspry.Settings:
"""Return a dictionary with settings for the test."""
return settings_module.load(Path('config-ninja-settings.yaml')).settings
@pytest.fixture
def mock_rich_print(mocker: pytest_mock.MockFixture) -> MagicMock:
"""Patch the `rich.print` function."""
return mocker.patch('rich.print')
@pytest.mark.parametrize(('config_key', 'command'), tuple(itertools.product(CONFIG_OBJECTS, ['get', 'apply'])))
def test_output_message_per_config(
caplog: pytest.LogCaptureFixture,
settings: pyspry.Settings,
mock_rich_print: MagicMock,
config_key: str,
command: str,
) -> None:
"""Verify that `config-ninja get|apply` prints a single message for each applied controller.
- `config-ninja apply` should invoke `rich.print` for each controller
- `config-ninja get` should log a message with the `logging` module for each controller
"""
# Arrange
truth: TruthT = {
'dest': settings_module.DestSpec.from_primitives(settings.OBJECTS[config_key]['dest']),
'source': (source := settings.OBJECTS[config_key]['source']),
'source_path': source['init' if 'init' in source else 'new']['kwargs']['path'],
}
message = (
f'{command.capitalize()} [yellow]{config_key}[/yellow]: '
f'{truth["source_path"]} ({truth["source"]["format"]}) -> {truth["dest"]}'
)
# Act
with caplog.at_level(logging.DEBUG):
out = config_ninja(command, *CONFIG_OBJECTS)
# Assert
assert 0 == out.exit_code, out.stdout
assert len(CONFIG_OBJECTS) == mock_rich_print.call_count, mock_rich_print.call_args_list
if command == 'get':
assert 1 == caplog.messages.count(message)
else:
mock_rich_print.assert_any_call(message)
@pytest.mark.usefixtures('monkeypatch_systemd')
@pytest.mark.parametrize(
'command',
[
[],
['version'],
['get', 'example-local'],
['apply', 'example-local'],
['self'],
['self', 'install'],
['self', 'uninstall'],
['self', 'print'],
],
)
def test_verbosity_argument(command: list[str], caplog: pytest.LogCaptureFixture) -> None:
"""Verify that `config-ninja` commands support the verbosity argument."""
# Arrange
command.append('--verbose')
# Act
with caplog.at_level(logging.DEBUG):
out = config_ninja(*command)
# Assert
assert 0 == out.exit_code, out.stdout
assert cli.LOG_VERBOSITY_MESSAGE % 'DEBUG' in caplog.messages, caplog.text
@pytest.mark.parametrize('cmd_func_arg', itertools.product(typer_cmd_infos, GLOBAL_OPTION_ANNOTATIONS))
def test_global_options(cmd_func_arg: tuple[typer.models.CommandInfo | typer.models.TyperInfo, str]) -> None:
"""Verify that all registered commands support the global arguments."""
cmd_func, arg_name = cmd_func_arg
assert arg_name in cmd_func.callback.__annotations__, cmd_func.callback
assert GLOBAL_OPTION_ANNOTATIONS[arg_name] is cmd_func.callback.__annotations__[arg_name], cmd_func.callback
|