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
|
"""Tests for `find_missing_reqs.py`."""
from __future__ import annotations
import logging
import textwrap
from pathlib import Path
import black
import pytest
from pip_check_reqs import common, find_missing_reqs
def test_find_missing_reqs(tmp_path: Path) -> None:
installed_imported_not_required_package = pytest
installed_imported_required_package = black
fake_requirements_file = tmp_path / "requirements.txt"
fake_requirements_file.write_text(
textwrap.dedent(
f"""\
not_installed_package_12345==1
{installed_imported_required_package.__name__}
""",
),
)
source_dir = tmp_path / "source"
source_dir.mkdir()
source_file = source_dir / "source.py"
source_file.write_text(
textwrap.dedent(
f"""\
import pprint
import {installed_imported_not_required_package.__name__}
import {installed_imported_required_package.__name__}
""",
),
)
result = find_missing_reqs.find_missing_reqs(
requirements_filename=fake_requirements_file,
paths=[source_dir],
ignore_files_function=common.ignorer(ignore_cfg=[]),
ignore_modules_function=common.ignorer(ignore_cfg=[]),
)
expected_result = [
(
installed_imported_not_required_package.__name__,
[
common.FoundModule(
modname=installed_imported_not_required_package.__name__,
filename=Path(
installed_imported_not_required_package.__file__,
).parent,
locations=[(str(source_file), 3)],
),
],
),
]
assert result == expected_result
def test_main_failure(
caplog: pytest.LogCaptureFixture,
tmp_path: Path,
) -> None:
requirements_file = tmp_path / "requirements.txt"
requirements_file.touch()
source_dir = tmp_path / "source"
source_dir.mkdir()
source_file = source_dir / "source.py"
# We need to import something which is installed.
# We choose `pytest` because we know it is installed.
source_file.write_text("import pytest")
caplog.set_level(logging.WARN)
with pytest.raises(SystemExit) as excinfo:
find_missing_reqs.main(
arguments=[
"--requirements",
str(requirements_file),
str(source_dir),
],
)
assert excinfo.value.code == 1
assert caplog.records[0].message == "Missing requirements:"
assert (
caplog.records[1].message
== f"{source_file}:1 dist=pytest module=pytest"
)
def test_main_no_spec(capsys: pytest.CaptureFixture[str]) -> None:
with pytest.raises(SystemExit) as excinfo:
find_missing_reqs.main(arguments=[])
expected_code = 2
assert excinfo.value.code == expected_code
err = capsys.readouterr().err
assert err.endswith("error: no source files or directories specified\n")
@pytest.mark.parametrize(
("verbose_cfg", "debug_cfg", "expected_log_levels"),
[
(False, False, {logging.WARNING}),
(True, False, {logging.INFO, logging.WARNING}),
(False, True, {logging.DEBUG, logging.INFO, logging.WARNING}),
(True, True, {logging.DEBUG, logging.INFO, logging.WARNING}),
],
)
def test_logging_config(
*,
caplog: pytest.LogCaptureFixture,
verbose_cfg: bool,
debug_cfg: bool,
expected_log_levels: set[int],
tmp_path: Path,
) -> None:
source_dir = tmp_path / "source"
source_dir.mkdir()
arguments = [str(source_dir)]
if verbose_cfg:
arguments.append("--verbose")
if debug_cfg:
arguments.append("--debug")
find_missing_reqs.main(arguments=arguments)
for event in [
(logging.DEBUG, "debug"),
(logging.INFO, "info"),
(logging.WARN, "warn"),
]:
find_missing_reqs.log.log(*event)
log_levels = {r.levelno for r in caplog.records}
assert log_levels == expected_log_levels
def test_main_version(capsys: pytest.CaptureFixture[str]) -> None:
with pytest.raises(SystemExit):
find_missing_reqs.main(arguments=["--version"])
assert capsys.readouterr().out == common.version_info() + "\n"
|
