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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
|
"""
Dispatching tests
~~~~~~~~~~~~~~~~~
"""
import argparse
import io
from unittest.mock import Mock, patch
import pytest
import argh
def _dispatch_and_capture(func, command_string, **kwargs):
if hasattr(command_string, "split"):
args = command_string.split()
else:
args = command_string
_io = io.StringIO()
if "output_file" not in kwargs:
kwargs["output_file"] = _io
result = argh.dispatch_command(func, args, **kwargs)
if kwargs.get("output_file") is None:
return result
else:
_io.seek(0)
return _io.read()
def run_func(func, command_string, **kwargs):
try:
result = _dispatch_and_capture(func, command_string, **kwargs)
except SystemExit:
raise
else:
return result
@patch("argh.dispatching.argparse.ArgumentParser")
@patch("argh.dispatching.dispatch")
@patch("argh.dispatching.set_default_command")
def test_dispatch_command(mock_set_default_command, mock_dispatch, mock_parser_class):
def func():
pass
argh.dispatching.dispatch_command(func)
mock_parser_class.assert_called_once()
mock_parser = mock_parser_class.return_value
mock_set_default_command.assert_called_with(
mock_parser,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
mock_dispatch.assert_called_with(mock_parser)
@pytest.mark.parametrize("always_flush", [True, False])
def test_run_endpoint_function__always_flush(always_flush):
def func():
return ["first line", "second line"]
out_io = Mock(spec=io.StringIO)
argh.dispatching.run_endpoint_function(
func, argparse.Namespace(), output_file=out_io, always_flush=always_flush
)
if always_flush:
assert out_io.flush.call_count == 2
else:
out_io.flush.assert_not_called()
@patch("argh.dispatching.parse_and_resolve")
@patch("argh.dispatching.run_endpoint_function")
def test_dispatch_command_two_stage(mock_run_endpoint_function, mock_parse_and_resolve):
def func() -> str:
return "function output"
mock_parser = Mock(argparse.ArgumentParser)
mock_parser.parse_args.return_value = argparse.Namespace(foo=123)
argv = ["foo", "bar", "baz"]
completion = False
mock_output_file = Mock(io.TextIOBase)
mock_errors_file = Mock(io.TextIOBase)
raw_output = False
skip_unknown_args = False
always_flush = True
mock_endpoint_function = Mock()
mock_namespace = Mock(argparse.Namespace)
mock_namespace_obj = Mock(argparse.Namespace)
mock_parse_and_resolve.return_value = (mock_endpoint_function, mock_namespace_obj)
mock_run_endpoint_function.return_value = "run_endpoint_function retval"
retval = argh.dispatching.dispatch(
parser=mock_parser,
argv=argv,
completion=completion,
namespace=mock_namespace,
skip_unknown_args=skip_unknown_args,
output_file=mock_output_file,
errors_file=mock_errors_file,
raw_output=raw_output,
always_flush=always_flush,
)
mock_parse_and_resolve.assert_called_with(
parser=mock_parser,
argv=argv,
completion=completion,
namespace=mock_namespace,
skip_unknown_args=skip_unknown_args,
)
mock_run_endpoint_function.assert_called_with(
function=mock_endpoint_function,
namespace_obj=mock_namespace_obj,
output_file=mock_output_file,
errors_file=mock_errors_file,
raw_output=raw_output,
always_flush=always_flush,
)
assert retval == "run_endpoint_function retval"
@patch("argh.dispatching.argparse.ArgumentParser")
@patch("argh.dispatching.dispatch")
@patch("argh.dispatching.add_commands")
def test_dispatch_commands(mock_add_commands, mock_dispatch, mock_parser_class):
def func():
pass
argh.dispatching.dispatch_commands([func])
mock_parser_class.assert_called_once()
mock_parser = mock_parser_class.return_value
mock_add_commands.assert_called_with(
mock_parser,
[func],
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
mock_dispatch.assert_called_with(mock_parser)
@patch("argh.dispatching.dispatch")
@patch("argh.dispatching.add_commands")
@patch("argparse.ArgumentParser")
def test_entrypoint(ap_cls_mock, add_commands_mock, dispatch_mock):
entrypoint = argh.EntryPoint("my cool app")
# no commands
with pytest.raises(argh.exceptions.DispatchingError) as excinfo:
entrypoint()
assert excinfo.exconly().endswith(
'DispatchingError: no commands for entry point "my cool app"'
)
mocked_parser = Mock()
ap_cls_mock.return_value = mocked_parser
# a single command
@entrypoint
def greet():
return "hello"
entrypoint()
assert add_commands_mock.called
add_commands_mock.assert_called_with(mocked_parser, [greet])
assert dispatch_mock.called
dispatch_mock.assert_called_with(mocked_parser)
# multiple commands
add_commands_mock.reset_mock()
dispatch_mock.reset_mock()
@entrypoint
def hit():
return "knight with a chicken"
entrypoint()
assert add_commands_mock.called
add_commands_mock.assert_called_with(mocked_parser, [greet, hit])
assert dispatch_mock.called
dispatch_mock.assert_called_with(mocked_parser)
@patch("argh.dispatching.dispatch")
@patch("argh.dispatching.set_default_command")
@patch("argparse.ArgumentParser")
def test_dispatch_command_naming_policy(
parser_cls_mock, set_default_command_mock, dispatch_mock
):
def func(): ...
parser_mock = Mock()
parser_cls_mock.return_value = parser_mock
argh.dispatching.dispatch_command(func)
set_default_command_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
set_default_command_mock.reset_mock()
argh.dispatching.dispatch_command(func, old_name_mapping_policy=True)
set_default_command_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
set_default_command_mock.reset_mock()
argh.dispatching.dispatch_command(func, old_name_mapping_policy=False)
set_default_command_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_KWONLY,
)
@patch("argh.dispatching.dispatch")
@patch("argh.dispatching.add_commands")
@patch("argparse.ArgumentParser")
def test_dispatch_commands_naming_policy(
parser_cls_mock, add_commands_mock, dispatch_mock
):
def func(): ...
parser_mock = Mock()
parser_cls_mock.return_value = parser_mock
argh.dispatching.dispatch_commands(func)
add_commands_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
add_commands_mock.reset_mock()
argh.dispatching.dispatch_commands(func, old_name_mapping_policy=True)
add_commands_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_HAS_DEFAULT,
)
add_commands_mock.reset_mock()
argh.dispatching.dispatch_commands(func, old_name_mapping_policy=False)
add_commands_mock.assert_called_with(
parser_mock,
func,
name_mapping_policy=argh.assembling.NameMappingPolicy.BY_NAME_IF_KWONLY,
)
|