Testing Module

Helpers for unit tests

author:

Doug Skrypa

class cli_command_parser.testing.AssertRaisesWithStringContext(test_case: TestCase, expected_exc: Type[BaseException], text: OptStr = None, msg: OptStr = None)

Bases: object

Simplified version of the stdlib _AssertRaisesContext that tests whether the raised exception’s string contains the given text rather than matching it against a regex pattern. This avoids the regex overhead when it isn’t necessary, which is the majority of the time for such checks in this project.

test_case

expected_exc

expected_text

msg

class cli_command_parser.testing.ParserTest(methodName='runTest')

Bases: TestCase

assert_dict_equal(d1, d2, msg: OptStr = None)

assert_raises_contains_str(expected_exc: Type[BaseException], expected_text: str, msg: OptStr = None)

assert_parse_results(cmd_cls: CommandCls, argv: Argv, expected: Expected, msg: OptStr = None) → Command

assert_parse_results_cases(cmd_cls: CommandCls, cases: Iterable[Case], msg: OptStr = None)

assert_env_parse_results(cmd_cls: CommandCls, argv: Argv, env: Env, expected: Expected, msg: OptStr = None) → Command

assert_env_parse_results_cases(cmd_cls: CommandCls, cases: Iterable[EnvCase], msg: OptStr = None)

assert_parse_fails(cmd_cls: CommandCls, argv: Argv, expected_exc: ExcType = <class 'cli_command_parser.exceptions.UsageError'>, expected_pattern: OptStr = None, msg: OptStr = None, regex: bool = False)

assert_parse_fails_cases(cmd_cls: CommandCls, cases: ExcCases, exc: ExcType | None = None, msg: OptStr = None)

assert_argv_parse_fails_cases(cmd_cls: CommandCls, cases: Iterable[Argv], exc: ExcType = <class 'cli_command_parser.exceptions.UsageError'>, msg: OptStr = None)

Convenience method for calling assert_parse_fails_cases() with a default exception type.

assert_call_fails(func: Callable, kwargs: Kwargs, exc: ExcType = <class 'Exception'>, expected_exc_msg: OptStr = None, msg: OptStr = None)

assert_call_fails_cases(func: Callable, cases: Iterable[CallExceptionCase], msg: OptStr = None)

assert_strings_equal(expected: str, actual: str, message: OptStr = None, diff_lines: int = 3, trim: bool = False)

Assert that two strings are equal. Primarily intended for cases involving multi-line text.

Parameters:

• expected – Expected string

• actual – Actual string that was produced by code that is being tested

• message – Message to be displayed if the strings do not match (default: a multi-line colored diff is displayed)

• diff_lines – Number of lines of context before/after differing lines that should be displayed in the diff

• trim – Whether the expected and actual strings should be normalized by removing trailing whitespace

assert_str_starts_with_line(prefix: str, text: str)

assert_str_contains(sub_text: str, text: str, diff_lines: int = 3)

env_vars(case: str, **env_vars)

cli_command_parser.testing.format_diff(a: str, b: str, name_a: str = 'expected', name_b: str = '  actual', n: int = 3) → str

cli_command_parser.testing.format_dict_diff(a: dict[str, Any], b: dict[str, Any]) → str

class cli_command_parser.testing.RedirectStreams(stdin: IO | str | bytes | None = None)

Bases: AbstractContextManager

property stdout: str

property stderr: str

cli_command_parser.testing.get_usage_text(cmd: Type[Command]) → str

cli_command_parser.testing.get_help_text(cmd: Type[Command] | Command, terminal_width: int = 199) → str

cli_command_parser.testing.get_rst_text(cmd: Type[Command] | Command) → str

cli_command_parser.testing.sealed_mock(*args, **kwargs) → Mock

cli_command_parser.testing.load_command(directory: Path, name: str, cmd_name: str, **kwargs) → Iterator[Type[Command]]

class cli_command_parser.testing.TemporaryDir(suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False, *, delete=True)

Bases: TemporaryDirectory