ApprovalTests.Python/tests/test_options.py at main · approvals/ApprovalTests.Python · GitHub

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
import importlib
import inspect
import sys

from approvaltests import (
    DiffReporter,
    ReporterForTesting,
    approvals,
    combination_approvals,  # noqa: F401
    get_default_reporter,
    verify,
    verify_all,
)
from approvaltests.core.options import Options
from approvaltests.reporters import MultiReporter, ReportByCreatingDiffFile
from approvaltests.utilities import command_line_approvals  # noqa: F401
from approvaltests.utilities.logger import simple_logger_approvals  # noqa: F401
from approvaltests.utilities.logging import logging_approvals  # noqa: F401

_approvals_modules = list(
    sorted(
        filter(
            lambda name: (
                name.startswith("approvaltests.") and name.endswith("approvals")
            ),
            sys.modules.keys(),
        )
    )
)


def test_list_of_modules() -> None:
    verify_all("", _approvals_modules)


def test_every_function_in_approvals_with_verify_has_an_options() -> None:
    for module_name in _approvals_modules:
        assert_verify_methods_have_options(importlib.import_module(module_name))


def assert_verify_methods_have_options(module) -> None:
    for function_name, obj in module.__dict__.items():
        if "verify" not in function_name:
            continue

        if not callable(obj):
            continue

        # if it has a decorator, we need to get the original function
        if hasattr(obj, "__wrapped__"):
            obj = obj.__wrapped__

        argspec = inspect.getfullargspec(obj)
        has_options = "options" in argspec.kwonlyargs
        assert has_options, (
            f"Missing Keyword only parameter `options` in {function_name}:\n\t{argspec}"
        )


def test_empty_options_has_default_reporter() -> None:
    ##approvals.set_default_reporter(None)
    options = Options()
    assert options.reporter == get_default_reporter()


def test_with_reporter() -> None:
    testr = ReporterForTesting()
    options = Options().with_reporter(testr)
    try:
        verify("Data2", options=options)
    except:
        pass

    assert testr.called


def test_setting_reporter() -> None:
    testr = ReporterForTesting()
    options = Options().with_reporter(testr)
    assert options.reporter == testr


def test_file_extensions() -> None:
    approvals.settings().allow_multiple_verify_calls_for_this_method()
    content = "# This is a markdown header\n"
    # begin-snippet: options_with_file_extension
    verify(content, options=Options().for_file.with_extension(".md"))
    # end-snippet
    verify(content, options=Options().for_file.with_extension("md"))


def test_overwrite_reporter() -> None:
    # current behaviour, override
    options0 = (
        Options()
        .with_reporter(ReportByCreatingDiffFile())
        .with_reporter(DiffReporter())
    )
    assert type(options0.reporter) == DiffReporter


def test_add_reporter() -> None:
    reporter1 = ReportByCreatingDiffFile()
    reporter2 = DiffReporter()
    handmade = MultiReporter(reporter1, reporter2)

    options0 = Options().with_reporter(reporter1).add_reporter(reporter2)
    assert str(options0.reporter) == str(handmade)