Files
@ 31146b884361
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_cliutil.py
31146b884361
10.5 KiB
text/x-python
reconcile: Add initial FR support to statement reconciler.
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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | """Test CLI utilities"""
# Copyright © 2020, 2021 Brett Smith
# License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
#
# Full copyright and licensing details can be found at toplevel file
# LICENSE.txt in the repository.
import argparse
import datetime
import enum
import errno
import io
import inspect
import logging
import os
import re
import sys
import traceback
import pytest
from pathlib import Path
from . import testutil
from conservancy_beancount import cliutil, errors
FILE_NAMES = ['-foobar', '-foo.bin']
STREAM_PATHS = [None, Path('-')]
class ArgChoices(enum.Enum):
AA = 'aa'
AB = 'ab'
BB = 'bb'
START = AA
END = BB
class MockTraceback:
def __init__(self, stack=None, index=0):
if stack is None:
stack = inspect.stack(context=False)
self._stack = stack
self._index = index
frame_record = self._stack[self._index]
self.tb_frame = frame_record.frame
self.tb_lineno = frame_record.lineno
@property
def tb_next(self):
try:
return type(self)(self._stack, self._index + 1)
except IndexError:
return None
@pytest.fixture(scope='module')
def arg_enum():
return cliutil.EnumArgument(ArgChoices)
@pytest.fixture(scope='module')
def argparser():
parser = argparse.ArgumentParser(prog='test_cliutil')
cliutil.add_loglevel_argument(parser)
cliutil.add_version_argument(parser)
return parser
@pytest.mark.parametrize('path_name', FILE_NAMES)
def test_bytes_output_path(path_name, tmp_path):
path = tmp_path / path_name
stream = io.BytesIO()
actual = cliutil.bytes_output(path, stream)
assert actual is not stream
assert str(actual.name) == str(path)
assert 'w' in actual.mode
assert 'b' in actual.mode
@pytest.mark.parametrize('path', STREAM_PATHS)
def test_bytes_output_stream(path):
stream = io.BytesIO()
actual = cliutil.bytes_output(path, stream)
assert actual is stream
@pytest.mark.parametrize('year,month,day', [
(2000, 1, 1),
(2016, 2, 29),
(2020, 12, 31),
])
def test_date_arg_valid(year, month, day):
expected = datetime.date(year, month, day)
assert cliutil.date_arg(expected.isoformat()) == expected
@pytest.mark.parametrize('arg', [
'2000',
'20-02-12',
'2019-02-29',
'two thousand',
])
def test_date_arg_invalid(arg):
with pytest.raises(ValueError):
cliutil.date_arg(arg)
@pytest.mark.parametrize('year', [
1990,
2000,
2009,
])
def test_year_or_date_arg_year(year):
assert cliutil.year_or_date_arg(str(year)) == year
@pytest.mark.parametrize('year,month,day', [
(2000, 1, 1),
(2016, 2, 29),
(2020, 12, 31),
])
def test_year_or_date_arg_date(year, month, day):
expected = datetime.date(year, month, day)
assert cliutil.year_or_date_arg(expected.isoformat()) == expected
@pytest.mark.parametrize('arg', [
'-1',
str(sys.maxsize),
'MMDVIII',
'2019-02-29',
])
def test_year_or_date_arg_invalid(arg):
with pytest.raises(ValueError):
cliutil.year_or_date_arg(arg)
@pytest.mark.parametrize('func_name', [
'bytes_output',
'text_output',
])
def test_default_output(func_name):
actual = getattr(cliutil, func_name)()
assert actual.fileno() == sys.stdout.fileno()
@pytest.mark.parametrize('path_name', FILE_NAMES)
def test_text_output_path(path_name, tmp_path):
path = tmp_path / path_name
stream = io.StringIO()
actual = cliutil.text_output(path, stream)
assert actual is not stream
assert str(actual.name) == str(path)
assert 'w' in actual.mode
@pytest.mark.parametrize('path', STREAM_PATHS)
def test_text_output_stream(path):
stream = io.StringIO()
actual = cliutil.text_output(path, stream)
assert actual is stream
@pytest.mark.parametrize('errnum', [
errno.EACCES,
errno.EPERM,
errno.ENOENT,
])
def test_excepthook_oserror(errnum, caplog):
error = OSError(errnum, os.strerror(errnum), 'TestFilename')
with pytest.raises(SystemExit) as exc_check:
cliutil.ExceptHook()(type(error), error, None)
assert exc_check.value.args[0] == os.EX_IOERR
assert caplog.records
for log in caplog.records:
assert log.levelname == 'CRITICAL'
assert log.message == f"I/O error: {error.filename}: {error.strerror}"
@pytest.mark.parametrize('errcls', [
errors.RewriteRuleActionError,
errors.RewriteRuleConditionError,
errors.RewriteRuleLoadError,
errors.RewriteRuleValidationError,
])
def test_excepthook_rewrite_rule_error(errcls, caplog):
name = errcls.__name__
error = errcls("bad rewrite rule", f"{name}.yml", 170, [name])
with pytest.raises(SystemExit) as exc_check:
cliutil.ExceptHook()(type(error), error, None)
assert exc_check.value.args[0] == cliutil.ExitCode.RewriteRulesError
assert caplog.records
for log in caplog.records:
assert log.levelname == 'CRITICAL'
lines = log.message.splitlines()
assert lines[0].startswith(f"{name}: bad rewrite rule in {name}.yml rule #170")
assert re.match(rf' source:\W+{name}\b', lines[-1])
@pytest.mark.parametrize('exc_type', [
AttributeError,
RuntimeError,
ValueError,
])
def test_excepthook_bug(exc_type, caplog):
error = exc_type("test message")
with pytest.raises(SystemExit) as exc_check:
cliutil.ExceptHook()(exc_type, error, None)
assert exc_check.value.args[0] == os.EX_SOFTWARE
assert caplog.records
for log in caplog.records:
assert log.levelname == 'CRITICAL'
assert log.message == f"internal {exc_type.__name__}: {error.args[0]}"
def test_excepthook_traceback(caplog):
error = KeyError('test')
args = (type(error), error, MockTraceback())
caplog.set_level(logging.DEBUG)
with pytest.raises(SystemExit) as exc_check:
cliutil.ExceptHook()(*args)
assert caplog.records
assert caplog.records[-1].message == ''.join(traceback.format_exception(*args))
@pytest.mark.parametrize('arg,expected', [
('debug', logging.DEBUG),
('info', logging.INFO),
('warning', logging.WARNING),
('warn', logging.WARNING),
('error', logging.ERROR),
('err', logging.ERROR),
('critical', logging.CRITICAL),
('crit', logging.CRITICAL),
])
def test_loglevel_argument(argparser, arg, expected):
for method in ['lower', 'title', 'upper']:
args = argparser.parse_args(['--loglevel', getattr(arg, method)()])
assert args.loglevel is expected
def test_setup_logger():
stream = io.StringIO()
logger = cliutil.setup_logger(
'test_cliutil', stream, '%(name)s %(levelname)s: %(message)s',
)
logger.critical("test crit")
assert stream.getvalue() == "test_cliutil CRITICAL: test crit\n"
@pytest.mark.parametrize('arg', [
'--license',
'--version',
'--copyright',
])
def test_version_argument(argparser, capsys, arg):
with pytest.raises(SystemExit) as exc_check:
args = argparser.parse_args(['--version'])
assert exc_check.value.args[0] == 0
stdout, _ = capsys.readouterr()
lines = iter(stdout.splitlines())
assert re.match(r'^test_cliutil version \d+\.\d+\.\d+', next(lines, "<EOF>"))
@pytest.mark.parametrize('date,diff,expected', [
(datetime.date(2010, 2, 28), 0, datetime.date(2010, 2, 28)),
(datetime.date(2010, 2, 28), 1, datetime.date(2011, 2, 28)),
(datetime.date(2010, 2, 28), 2, datetime.date(2012, 2, 28)),
(datetime.date(2010, 2, 28), -1, datetime.date(2009, 2, 28)),
(datetime.date(2010, 2, 28), -2, datetime.date(2008, 2, 28)),
(datetime.date(2012, 2, 29), 2, datetime.date(2014, 3, 1)),
(datetime.date(2012, 2, 29), 4, datetime.date(2016, 2, 29)),
(datetime.date(2012, 2, 29), -2, datetime.date(2010, 2, 28)),
(datetime.date(2012, 2, 29), -4, datetime.date(2008, 2, 29)),
(datetime.date(2010, 3, 1), 1, datetime.date(2011, 3, 1)),
(datetime.date(2010, 3, 1), 2, datetime.date(2012, 3, 1)),
(datetime.date(2010, 3, 1), -1, datetime.date(2009, 3, 1)),
(datetime.date(2010, 3, 1), -2, datetime.date(2008, 3, 1)),
])
def test_diff_year(date, diff, expected):
assert cliutil.diff_year(date, diff) == expected
@pytest.mark.parametrize('cmd,expected', [
(['true'], True),
(['true', '--version'], True),
(['false'], False),
(['false', '--version'], False),
([str(testutil.TESTS_DIR)], False),
])
def test_can_run(cmd, expected):
assert cliutil.can_run(cmd) == expected
@pytest.mark.parametrize('name,choice', ArgChoices.__members__.items())
def test_enum_arg_enum_type(arg_enum, name, choice):
assert arg_enum.enum_type(name.lower()) is choice
assert arg_enum.enum_type(choice.value) is choice
@pytest.mark.parametrize('arg', 'az\0')
def test_enum_arg_no_enum_match(arg_enum, arg):
with pytest.raises(ValueError):
arg_enum.enum_type(arg)
@pytest.mark.parametrize('name,choice', ArgChoices.__members__.items())
def test_enum_arg_value_type(arg_enum, name, choice):
assert arg_enum.value_type(name.lower()) == choice.value
assert arg_enum.value_type(choice.value) == choice.value
@pytest.mark.parametrize('arg', 'az\0')
def test_enum_arg_no_value_match(arg_enum, arg):
with pytest.raises(ValueError):
arg_enum.value_type(arg)
def test_enum_arg_choices_str_defaults(arg_enum):
assert arg_enum.choices_str() == ', '.join(repr(c.value) for c in ArgChoices)
def test_enum_arg_choices_str_args(arg_enum):
sep = '/'
assert arg_enum.choices_str(sep, '{}') == sep.join(c.value for c in ArgChoices)
@pytest.mark.parametrize('values,sep', testutil.combine_values(
[['foo'], ['bar', 'baz'], ['qu', 'quu', 'quux']],
[',', ', ', ' ,', ' , '],
))
def test_extend_action_once(values, sep):
action = cliutil.ExtendAction(['-t'], 'result')
args = argparse.Namespace()
action(None, args, sep.join(values), '-t')
assert args.result == values
def test_extend_action_multi():
action = cliutil.ExtendAction(['-t'], 'result')
args = argparse.Namespace()
action(None, args, 'foo,bar', '-t')
action(None, args, 'baz, quux', '-t')
assert args.result == ['foo', 'bar', 'baz', 'quux']
def test_extend_action_from_default():
action = cliutil.ExtendAction(['-t'], 'result')
args = argparse.Namespace(result=['foo'])
action(None, args, 'bar , baz', '-t')
assert args.result == ['foo', 'bar', 'baz']
@pytest.mark.parametrize('pattern,expected', [
(',', ['foo', ' bar']),
(r'\s+', ['foo,', 'bar']),
])
def test_extend_action_custom_pattern(pattern, expected):
action = cliutil.ExtendAction(['-t'], 'result', const=pattern)
args = argparse.Namespace()
action(None, args, 'foo, bar', '-t')
assert args.result == expected
|