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
|
from __future__ import annotations
from itertools import chain
from typing import TYPE_CHECKING, Any
import pytest
from pipdeptree._models import DistPackage, PackageDAG, ReqPackage, ReversedPackageDAG
from pipdeptree._models.dag import IncludeExcludeOverlapError, IncludePatternNotFoundError
if TYPE_CHECKING:
from collections.abc import Callable, Iterator
from unittest.mock import Mock
from tests.our_types import MockGraph
def test_package_dag_get_node_as_parent(example_dag: PackageDAG) -> None:
node = example_dag.get_node_as_parent("b")
assert node is not None
assert node.key == "b"
node = example_dag.get_node_as_parent("c")
assert node is not None
assert node.key == "c"
@pytest.fixture(scope="session")
def t_fnmatch(mock_pkgs: Callable[[MockGraph], Iterator[Mock]]) -> PackageDAG:
graph: MockGraph = {
("a-a", "1"): [("a-b", []), ("a-c", [])],
("a-b", "1"): [("a-c", [])],
("b-a", "1"): [("b-b", [])],
("b-b", "1"): [("a-b", [])],
}
return PackageDAG.from_pkgs(list(mock_pkgs(graph)))
def dag_to_dict(g: PackageDAG) -> dict[str, list[str]]:
return {k.key: [v.key for v in vs] for k, vs in g._obj.items()} # noqa: SLF001
def test_package_dag_filter_fnmatch_include_a(t_fnmatch: PackageDAG) -> None:
# test include for a-*in the result we got only a-* nodes
graph = dag_to_dict(t_fnmatch.filter_nodes(["a-*"], None))
assert graph == {"a-a": ["a-b", "a-c"], "a-b": ["a-c"]}
def test_package_dag_filter_fnmatch_include_b(t_fnmatch: PackageDAG) -> None:
# test include for b-*, which has a-b and a-c in tree, but not a-a
# in the result we got the b-* nodes plus the a-b node as child in the tree
graph = dag_to_dict(t_fnmatch.filter_nodes(["b-*"], None))
assert graph == {"b-a": ["b-b"], "b-b": ["a-b"], "a-b": ["a-c"]}
def test_package_dag_filter_fnmatch_exclude_c(t_fnmatch: PackageDAG) -> None:
# test exclude for b-* in the result we got only a-* nodes
graph = dag_to_dict(t_fnmatch.filter_nodes(None, {"b-*"}))
assert graph == {"a-a": ["a-b", "a-c"], "a-b": ["a-c"]}
def test_package_dag_filter_fnmatch_exclude_a(t_fnmatch: PackageDAG) -> None:
# test exclude for a-* in the result we got only b-* nodes
graph = dag_to_dict(t_fnmatch.filter_nodes(None, {"a-*"}))
assert graph == {"b-a": ["b-b"], "b-b": []}
def test_package_dag_filter_include_exclude_normal(t_fnmatch: PackageDAG) -> None:
graph = dag_to_dict(t_fnmatch.filter_nodes(["a-*"], {"a-a"}))
assert graph == {"a-b": ["a-c"]}
def test_package_dag_filter_include_exclude_overlap(t_fnmatch: PackageDAG) -> None:
with pytest.raises(IncludeExcludeOverlapError):
t_fnmatch.filter_nodes(["a-a", "a-b"], {"a-b"})
def test_package_dag_filter_include_nonexistent_packages(t_fnmatch: PackageDAG) -> None:
with pytest.raises(IncludePatternNotFoundError, match="No packages matched using the following patterns: x, y, z"):
t_fnmatch.filter_nodes(["x", "y", "z"], None)
def test_package_dag_filter_packages_uses_pep503normalize(
mock_pkgs: Callable[[MockGraph], Iterator[Mock]],
) -> None:
graph: MockGraph = {
("Pie.Pie", "1"): [],
}
pkgs = PackageDAG.from_pkgs(list(mock_pkgs(graph)))
pkgs = pkgs.filter_nodes(["Pie.Pie"], None)
assert len(pkgs) == 1
assert pkgs.get_node_as_parent("pie-pie") is not None
pkgs = pkgs.filter_nodes(None, {"Pie.Pie"})
assert len(pkgs) == 0
@pytest.mark.parametrize(
("graph", "exclude", "expected"),
[
pytest.param(
{
("a", "1.0.0"): [("b", []), ("c", []), ("d", []), ("e", [])],
("b", "2.0.0"): [("x", []), ("y", []), ("z", [])],
("c", "3.0.0"): [("d", [])],
("d", "4.0.0"): [],
("e", "5.0.0"): [("y", [])],
("f", "6.0.0"): [("d", [])], # Make sure that "d" is not removed since "f" is not excluded
("g", "7.0.0"): [],
("x", "8.0.0"): [],
("y", "9.0.0"): [],
("z", "10.0.0"): [],
},
{"a"},
{"d", "f", "g"},
id="with-dependencies",
),
pytest.param(
{
("acorn", "1.0.0"): [("b", []), ("c", []), ("d", []), ("e", [])],
("b", "2.0.0"): [("x", []), ("y", []), ("z", [])],
("c", "3.0.0"): [("d", [])],
("d", "4.0.0"): [],
("e", "5.0.0"): [("y", [])],
("f", "6.0.0"): [("d", [])],
("g", "7.0.0"): [],
("x", "8.0.0"): [],
("y", "9.0.0"): [],
("z", "10.0.0"): [],
},
{"a*", "g"},
{"d", "f"},
id="with-multiple-excludes-and-with-patterns",
),
pytest.param(
{
("b", "2.0.0"): [("x", []), ("y", []), ("z", [])],
("x", "8.0.0"): [],
("y", "9.0.0"): [],
("z", "10.0.0"): [],
},
{"dontexist"},
{"b", "x", "y", "z"},
id="with-non-existent-exclude",
),
pytest.param(
{
("a", "1.0.0"): [("b", [])],
("b", "2.0.0"): [("c", [])],
("c", "3.0.0"): [("d", [])],
("d", "4.0.0"): [("e", [])],
("e", "5.0.0"): [("f", [])],
("f", "6.0.0"): [("g", [])],
("g", "7.0.0"): [("x", [])],
("x", "8.0.0"): [("y", [])],
("y", "9.0.0"): [("z", [])],
("z", "10.0.0"): [],
},
{"c"},
{"a", "b"},
id="with-package-having-large-depth",
),
],
)
def test_package_dag_filter_packages_given_exclude_dependencies(
mock_pkgs: Callable[[MockGraph], Iterator[Mock]], graph: MockGraph, exclude: set[str], expected: list[str]
) -> None:
pkgs = PackageDAG.from_pkgs(list(mock_pkgs(graph)))
pkgs = pkgs.filter_nodes(None, exclude, exclude_deps=True)
assert len(pkgs) == len(expected)
assert all(p.key in expected for p in pkgs)
def test_package_dag_reverse(example_dag: PackageDAG) -> None:
def sort_map_values(m: dict[str, Any]) -> dict[str, Any]:
return {k: sorted(v) for k, v in m.items()}
t1 = example_dag.reverse()
expected = {"a": [], "b": ["a", "f"], "c": ["a"], "d": ["b", "c"], "e": ["c", "d", "g"], "f": ["g"], "g": []}
assert isinstance(t1, ReversedPackageDAG)
assert sort_map_values(expected) == sort_map_values(dag_to_dict(t1))
assert all(isinstance(k, ReqPackage) for k in t1)
assert all(isinstance(v, DistPackage) for v in chain.from_iterable(t1.values()))
# testing reversal of ReversedPackageDAG instance
expected = {"a": ["b", "c"], "b": ["d"], "c": ["d", "e"], "d": ["e"], "e": [], "f": ["b"], "g": ["e", "f"]}
t2 = t1.reverse()
assert isinstance(t2, PackageDAG)
assert sort_map_values(expected) == sort_map_values(dag_to_dict(t2))
assert all(isinstance(k, DistPackage) for k in t2)
assert all(isinstance(v, ReqPackage) for v in chain.from_iterable(t2.values()))
def test_package_dag_from_pkgs(mock_pkgs: Callable[[MockGraph], Iterator[Mock]]) -> None:
# when pip's _vendor.packaging.requirements.Requirement's requires() gives a lowercased package name but the actual
# package name in PyPI is mixed case, expect the mixed case version
graph: MockGraph = {
("examplePy", "1.2.3"): [("hellopy", [(">=", "2.0.0")])],
("HelloPy", "2.2.0"): [],
}
package_dag = PackageDAG.from_pkgs(list(mock_pkgs(graph)))
parent_key = "examplepy"
c = package_dag.get_children(parent_key)
assert len(c) == 1
assert c[0].project_name == "HelloPy"
def test_package_dag_from_pkgs_uses_pep503normalize(mock_pkgs: Callable[[MockGraph], Iterator[Mock]]) -> None:
# ensure that requirement gets matched with a dists even when it's key needs pep503 normalization to match
graph: MockGraph = {
("parent-package", "1.2.3"): [("flufl.lock", [(">=", "2.0.0")])],
("flufl-lock", "2.2.0"): [],
}
package_dag = PackageDAG.from_pkgs(list(mock_pkgs(graph)))
parent_key = "parent-package"
c = package_dag.get_children(parent_key)
assert c[0].dist
assert c[0].key == "flufl-lock"
def test_package_from_pkgs_given_invalid_requirements(
mock_pkgs: Callable[[MockGraph], Iterator[Mock]], capfd: pytest.CaptureFixture[str]
) -> None:
graph: MockGraph = {
("a-package", "1.2.3"): [("BAD**requirement", [(">=", "2.0.0")])],
}
package_dag = PackageDAG.from_pkgs(list(mock_pkgs(graph)))
assert len(package_dag) == 1
out, err = capfd.readouterr()
assert not out
assert err == (
"Warning!!! Invalid requirement strings found for the following distributions:\na-package\n "
'Skipping "BAD**requirement>=2.0.0"\n------------------------------------------------------------------------\n'
)
|
