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
|
#
# Copyright (c) 2021, 2022 StorPool
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
"""Test the Config classes."""
import dataclasses
import sys
from unittest import mock
from typing import Any, IO, Optional, Type, Union
import pytest
import cfg_diag
TEST_CLASSES = (
cfg_diag.Config,
cfg_diag.ConfigStdOut,
cfg_diag.ConfigUnfrozen,
cfg_diag.ConfigUnfrozenStdOut,
)
ConfigType = Union[Type[cfg_diag.Config], Type[cfg_diag.ConfigUnfrozen]]
@pytest.mark.parametrize("cls", TEST_CLASSES)
def test_frozen(cls: ConfigType) -> None:
"""Test some aspect of the Config classes."""
obj = cls(verbose=False)
assert not obj.verbose
if "Unfrozen" in cls.__name__:
obj.verbose = True # type: ignore
assert obj.verbose
else:
with pytest.raises(dataclasses.FrozenInstanceError):
obj.verbose = True # type: ignore
assert not obj.verbose
@pytest.mark.parametrize("cls", TEST_CLASSES)
def test_no_output(cls: ConfigType) -> None:
"""Make sure there is no output with verbose=False."""
res = []
def mock_print(msg: str, file: Optional[IO[Any]] = None) -> None:
"""Mock the print() builtin function."""
res.append((msg, file))
obj = cls(verbose=False)
assert not obj.verbose
with mock.patch("builtins.print", new=mock_print):
obj.diag_("This is not a diagnostic message.")
obj.diag(lambda: "This is not a diagnostic message either.")
assert not res
@pytest.mark.parametrize("cls", TEST_CLASSES)
def test_output(cls: ConfigType) -> None:
"""Make sure something is output with verbose=True."""
to_stdout = "StdOut" in cls.__name__
res = []
def mock_print(msg: str, file: Optional[IO[Any]] = None) -> None:
"""Mock the print() builtin function."""
res.append((msg, file))
obj = cls(verbose=True)
assert obj.verbose
with mock.patch("builtins.print", new=mock_print):
obj.diag_("This is a diagnostic message.")
obj.diag(lambda: "This is also a diagnostic message.")
assert res == [
(
"This is a diagnostic message.",
sys.stdout if to_stdout else sys.stderr,
),
(
"This is also a diagnostic message.",
sys.stdout if to_stdout else sys.stderr,
),
]
|
