-
-
Notifications
You must be signed in to change notification settings - Fork 612
/
test_resolver.py
577 lines (515 loc) · 23.2 KB
/
test_resolver.py
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
from __future__ import annotations
import pytest
from pip._internal.exceptions import DistributionNotFound
from pip._internal.utils.urls import path_to_url
from piptools.exceptions import NoCandidateFound
from piptools.resolver import RequirementSummary, combine_install_requirements
@pytest.mark.parametrize(
("input", "expected", "prereleases", "unsafe_constraints"),
(
(tup + (False, set())[len(tup) - 2 :])
for tup in [
(["Django"], ["django==1.8"]),
(
["Flask"],
[
"flask==0.10.1",
"itsdangerous==0.24 (from flask==0.10.1)",
"markupsafe==0.23 (from jinja2==2.7.3->flask==0.10.1)",
"jinja2==2.7.3 (from flask==0.10.1)",
"werkzeug==0.10.4 (from flask==0.10.1)",
],
),
(["Jinja2", "markupsafe"], ["jinja2==2.7.3", "markupsafe==0.23"]),
# We should return a normal release version if prereleases is False
(["SQLAlchemy"], ["sqlalchemy==0.9.9"]),
# We should return the prerelease version if prereleases is True
(["SQLAlchemy"], ["sqlalchemy==1.0.0b5"], True),
# Ipython has extras available, but we don't require them in this test
(
["ipython"],
["ipython==2.1.0", "gnureadline==6.3.3 (from ipython==2.1.0)"],
),
# We should get dependencies for extras
(
["ipython[notebook]"],
[
"ipython[notebook]==2.1.0",
"pyzmq==2.1.12 (from ipython[notebook]==2.1.0)",
"jinja2==2.7.3 (from ipython[notebook]==2.1.0)",
"tornado==3.2.2 (from ipython[notebook]==2.1.0)",
"markupsafe==0.23 (from jinja2==2.7.3->ipython[notebook]==2.1.0)",
"gnureadline==6.3.3 (from ipython[notebook]==2.1.0)",
],
),
# We should get dependencies for multiple extras
(
["ipython[notebook,nbconvert]"],
[
# Note that the extras should be sorted
"ipython[nbconvert,notebook]==2.1.0",
"pyzmq==2.1.12 (from ipython[nbconvert,notebook]==2.1.0)",
"jinja2==2.7.3 (from ipython[nbconvert,notebook]==2.1.0)",
"tornado==3.2.2 (from ipython[nbconvert,notebook]==2.1.0)",
(
"markupsafe==0.23 "
"(from jinja2==2.7.3->ipython[nbconvert,notebook]==2.1.0)"
),
"gnureadline==6.3.3 (from ipython[nbconvert,notebook]==2.1.0)",
"pygments==1.5 (from ipython[nbconvert,notebook]==2.1.0)",
"sphinx==0.3 (from ipython[nbconvert,notebook]==2.1.0)",
],
),
# We must take the union of all extras
(
["ipython[notebook]", "ipython[nbconvert]"],
[
# Note that the extras should be sorted
"ipython[nbconvert,notebook]==2.1.0",
"pyzmq==2.1.12 (from ipython[nbconvert,notebook]==2.1.0)",
"jinja2==2.7.3 (from ipython[nbconvert,notebook]==2.1.0)",
"tornado==3.2.2 (from ipython[nbconvert,notebook]==2.1.0)",
(
"markupsafe==0.23 "
"(from jinja2==2.7.3->ipython[nbconvert,notebook]==2.1.0)"
),
"gnureadline==6.3.3 (from ipython[nbconvert,notebook]==2.1.0)",
"pygments==1.5 (from ipython[nbconvert,notebook]==2.1.0)",
"sphinx==0.3 (from ipython[nbconvert,notebook]==2.1.0)",
],
),
# We must remove child dependencies from result if parent
# is removed (e.g. vine from amqp>=2.0)
# See: GH-370
# because of updated dependencies in the test index, we need to pin celery
# in order to reproduce vine removal (because it was added in later
# releases)
(
["celery<=3.1.23", "librabbitmq"],
[
"amqp==1.4.9 (from librabbitmq==1.6.1)",
"anyjson==0.3.3 (from kombu==3.0.35->celery==3.1.23)",
"billiard==3.5.0.2 (from celery==3.1.23)",
"celery==3.1.23",
"kombu==3.0.35 (from celery==3.1.23)",
"librabbitmq==1.6.1",
"pytz==2016.4 (from celery==3.1.23)",
],
),
# Support specifying loose top-level requirements that could also appear as
# pinned subdependencies.
(
["billiard", "celery", "fake-piptools-test-with-pinned-deps"],
[
"amqp==1.4.9 (from kombu==3.0.35->celery==3.1.18)",
"anyjson==0.3.3 (from kombu==3.0.35->celery==3.1.18)",
"billiard==3.3.0.23",
"celery==3.1.18", # this is pinned from test subdependency
"fake-piptools-test-with-pinned-deps==0.1",
"kombu==3.0.35 (from celery==3.1.18)",
"pytz==2016.4 (from celery==3.1.18)",
],
),
# Exclude package dependency of setuptools as it is unsafe.
(
["html5lib"],
["html5lib==0.999999999"],
False,
{"setuptools==35.0.0 (from html5lib==0.999999999)"},
),
# We shouldn't include irrelevant pip constraints
# See: GH-471
(
["Flask", ("click", True), ("itsdangerous", True)],
[
"flask==0.10.1",
"itsdangerous==0.24",
"markupsafe==0.23 (from jinja2==2.7.3->flask==0.10.1)",
"jinja2==2.7.3 (from flask==0.10.1)",
"werkzeug==0.10.4 (from flask==0.10.1)",
],
),
# We shouldn't fail on invalid irrelevant pip constraints
# See: GH-1178
(
["Flask", ("missing-dependency<1.0", True), ("itsdangerous", True)],
[
"flask==0.10.1",
"itsdangerous==0.24",
"markupsafe==0.23 (from jinja2==2.7.3->flask==0.10.1)",
"jinja2==2.7.3 (from flask==0.10.1)",
"werkzeug==0.10.4 (from flask==0.10.1)",
],
),
# Unsafe dependencies should be filtered
(
["setuptools==35.0.0", "anyjson==0.3.3"],
["anyjson==0.3.3"],
False,
{"setuptools==35.0.0"},
),
(
["fake-piptools-test-with-unsafe-deps==0.1"],
[
"appdirs==1.4.9 (from "
"setuptools==34.0.0->fake-piptools-test-with-unsafe-deps==0.1)",
"fake-piptools-test-with-unsafe-deps==0.1",
"packaging==16.8 (from "
"setuptools==34.0.0->fake-piptools-test-with-unsafe-deps==0.1)",
],
False,
{
(
"setuptools==34.0.0 (from "
"fake-piptools-test-with-unsafe-deps==0.1)"
),
},
),
# Git URL requirement
# See: GH-851
(
[
"git+https://github.com/celery/billiard#egg=billiard==3.5.9999",
"celery==4.0.2",
],
[
"amqp==2.1.4 (from kombu==4.0.2->celery==4.0.2)",
"kombu==4.0.2 (from celery==4.0.2)",
"billiard<3.6.0,==3.5.9999,>=3.5.0.2 from "
"git+https://github.com/celery/billiard#egg=billiard==3.5.9999",
"vine==1.1.3 (from amqp==2.1.4->kombu==4.0.2->celery==4.0.2)",
"celery==4.0.2",
"pytz==2016.4 (from celery==4.0.2)",
],
),
# Check that dependencies of relevant constraints are resolved
(
["aiohttp", ("yarl==1.4.2", True)],
["aiohttp==3.6.2", "idna==2.8 (from yarl==1.4.2)", "yarl==1.4.2"],
),
]
),
)
def test_resolver(
resolver, from_line, input, expected, prereleases, unsafe_constraints
):
input = [line if isinstance(line, tuple) else (line, False) for line in input]
input = [from_line(req[0], constraint=req[1]) for req in input]
resolver = resolver(input, prereleases=prereleases)
output = resolver.resolve()
output = {str(line) for line in output}
assert output == {str(line) for line in expected}
assert {str(line) for line in resolver.unsafe_constraints} == unsafe_constraints
@pytest.mark.parametrize(
("input", "expected", "prereleases"),
(
(tup + (False,))[:3]
for tup in [
(
["setuptools==34.0.0"],
[
"appdirs==1.4.9 (from setuptools==34.0.0)",
"packaging==16.8 (from setuptools==34.0.0)",
"setuptools==34.0.0",
],
),
(
["fake-piptools-test-with-unsafe-deps==0.1"],
[
(
"appdirs==1.4.9 (from "
"setuptools==34.0.0->fake-piptools-test-with-unsafe-deps==0.1)"
),
(
"setuptools==34.0.0 "
"(from fake-piptools-test-with-unsafe-deps==0.1)"
),
(
"packaging==16.8 (from "
"setuptools==34.0.0->fake-piptools-test-with-unsafe-deps==0.1)"
),
"fake-piptools-test-with-unsafe-deps==0.1",
],
),
]
),
)
def test_resolver__allows_unsafe_deps(
resolver, from_line, input, expected, prereleases
):
input = [line if isinstance(line, tuple) else (line, False) for line in input]
input = [from_line(req[0], constraint=req[1]) for req in input]
output = resolver(input, prereleases=prereleases, allow_unsafe=True).resolve()
output = {str(line) for line in output}
assert output == {str(line) for line in expected}
@pytest.mark.parametrize(
(
"input",
"expected",
"unsafe_packages",
"unsafe_constraints",
),
(
(
["fake-piptools-test-with-pinned-deps==0.1"],
{
"fake-piptools-test-with-pinned-deps==0.1",
"pytz==2016.4 (from celery==3.1.18->fake-piptools-test-with-pinned-deps==0.1)",
"billiard==3.3.0.23 (from "
"celery==3.1.18->fake-piptools-test-with-pinned-deps==0.1)",
"celery==3.1.18 (from fake-piptools-test-with-pinned-deps==0.1)",
"anyjson==0.3.3 (from "
"kombu==3.0.35->celery==3.1.18->fake-piptools-test-with-pinned-deps==0.1)",
"amqp==1.4.9 (from "
"kombu==3.0.35->celery==3.1.18->fake-piptools-test-with-pinned-deps==0.1)",
},
{"kombu"},
{
"kombu==3.0.35 (from celery==3.1.18->fake-piptools-test-with-pinned-deps==0.1)",
},
),
),
)
def test_resolver__custom_unsafe_deps(
resolver,
from_line,
input,
expected,
unsafe_packages,
unsafe_constraints,
):
input = [line if isinstance(line, tuple) else (line, False) for line in input]
input = [from_line(req[0], constraint=req[1]) for req in input]
resolver = resolver(
input,
unsafe_packages=unsafe_packages,
)
output = resolver.resolve()
output = {str(line) for line in output}
assert output == expected
assert {str(line) for line in resolver.unsafe_constraints} == unsafe_constraints
def test_resolver__max_number_rounds_reached(resolver, from_line):
"""
Resolver should raise an exception if max round has been reached.
"""
input = [from_line("django")]
with pytest.raises(RuntimeError, match="after 0 rounds of resolving"):
resolver(input).resolve(max_rounds=0)
def test_iter_dependencies(resolver, from_line):
"""
Dependencies should be pinned or editable.
"""
ireq = from_line("django>=1.8")
res = resolver([])
with pytest.raises(
TypeError, match="Expected pinned or editable requirement, got django>=1.8"
):
next(res._iter_dependencies(ireq))
def test_iter_dependencies_results(resolver, from_line):
res = resolver([])
ireq = from_line("aiohttp==3.6.2")
assert next(res._iter_dependencies(ireq)).comes_from == ireq
def test_iter_dependencies_ignores_constraints(resolver, from_line):
res = resolver([])
ireq = from_line("aiohttp==3.6.2", constraint=True)
with pytest.raises(StopIteration):
next(res._iter_dependencies(ireq))
def test_iter_dependencies_after_combine_install_requirements(
pypi_repository, base_resolver, make_package, from_line
):
res = base_resolver([], repository=pypi_repository)
sub_deps = ["click"]
package_a = make_package("package-a", install_requires=sub_deps)
package_b = make_package("package-b", install_requires=["package-a"])
local_package_a = from_line(path_to_url(package_a))
assert [dep.name for dep in res._iter_dependencies(local_package_a)] == sub_deps
package_a_from_b = from_line("package-a", comes_from=path_to_url(package_b))
combined = combine_install_requirements([local_package_a, package_a_from_b])
assert [dep.name for dep in res._iter_dependencies(combined)] == sub_deps
def test_iter_dependencies_after_combine_install_requirements_extras(
pypi_repository, base_resolver, make_package, from_line
):
res = base_resolver([], repository=pypi_repository)
package_a = make_package(
"package-a", extras_require={"click": ["click"], "celery": ["celery"]}
)
package_b = make_package("package-b", install_requires=["package-a"])
local_package_a = from_line(path_to_url(package_a))
assert [dep.name for dep in res._iter_dependencies(local_package_a)] == []
package_a_from_b = from_line("package-a[click]", comes_from=path_to_url(package_b))
package_a_with_other_extra = from_line("package-a[celery]")
combined = combine_install_requirements(
[local_package_a, package_a_from_b, package_a_with_other_extra]
)
dependency_names = {dep.name for dep in res._iter_dependencies(combined)}
assert {"celery", "click"}.issubset(dependency_names)
def test_combine_install_requirements(from_line):
celery30 = from_line("celery>3.0", comes_from="-r requirements.in")
celery31 = from_line("celery==3.1.1", comes_from=from_line("fake-package"))
celery32 = from_line("celery<3.2")
combined = combine_install_requirements([celery30, celery31])
assert combined.comes_from == celery31.comes_from # shortest string
assert set(combined._source_ireqs) == {celery30, celery31}
assert str(combined.req.specifier) == "==3.1.1,>3.0"
combined_all = combine_install_requirements([celery32, combined])
assert combined_all.comes_from is None
assert set(combined_all._source_ireqs) == {celery30, celery31, celery32}
assert str(combined_all.req.specifier) == "<3.2,==3.1.1,>3.0"
def _test_combine_install_requirements_extras(with_extra, without_extra):
combined = combine_install_requirements([without_extra, with_extra])
assert str(combined) == str(with_extra)
assert combined.extras == with_extra.extras
combined = combine_install_requirements([with_extra, without_extra])
assert str(combined) == str(with_extra)
assert combined.extras == with_extra.extras
def test_combine_install_requirements_extras_req(from_line, make_package):
"""
Extras should be unioned in combined install requirements
(whether or not InstallRequirement.req is None, and testing either order of the inputs)
"""
with_extra = from_line("edx-opaque-keys[django]==1.0.1")
assert with_extra.req is not None
without_extra = from_line("edx-opaque-keys")
assert without_extra.req is not None
_test_combine_install_requirements_extras(with_extra, without_extra)
def test_combine_install_requirements_extras_no_req(from_line, make_package):
"""
Extras should be unioned in combined install requirements
(whether or not InstallRequirement.req is None, and testing either order of the inputs)
"""
test_package = make_package("test-package", extras_require={"extra": []})
local_package_with_extra = from_line(f"{test_package}[extra]")
assert local_package_with_extra.req is None
local_package_without_extra = from_line(path_to_url(test_package))
assert local_package_without_extra.req is None
_test_combine_install_requirements_extras(
local_package_with_extra, local_package_without_extra
)
def test_combine_install_requirements_with_paths(from_line, make_package):
name = "fake_package_b"
version = "1.0.0"
test_package = make_package(name, version=version)
fake_package = from_line(f"{name} @ {path_to_url(test_package)}")
fake_package_name = from_line(f"{name}=={version}", comes_from=from_line(name))
for pair in [(fake_package, fake_package_name), (fake_package_name, fake_package)]:
combined = combine_install_requirements(pair)
assert str(combined.specifier) == str(fake_package_name.specifier)
assert str(combined.link) == str(fake_package.link)
assert str(combined.local_file_path) == str(fake_package.local_file_path)
assert str(combined.original_link) == str(fake_package.original_link)
def test_combine_install_requirements_for_one_package_with_multiple_extras(
from_line,
):
"""Regression test for https://github.com/jazzband/pip-tools/pull/1512"""
pkg1 = from_line("ray[default]==1.1.1")
pkg2 = from_line("ray[tune]==1.1.1")
combined = combine_install_requirements([pkg1, pkg2])
assert str(combined) == "ray[default,tune]==1.1.1"
def test_compile_failure_shows_provenance(resolver, from_line):
"""
Provenance of conflicting dependencies should be printed on failure.
"""
requirements = [
from_line("fake-piptools-test-with-pinned-deps==0.1"),
from_line("celery>3.2"),
]
with pytest.raises(NoCandidateFound) as err:
resolver(requirements).resolve()
lines = str(err.value).splitlines()
assert lines[-2].strip() == "celery>3.2"
assert (
lines[-1].strip()
== "celery==3.1.18 (from fake-piptools-test-with-pinned-deps==0.1)"
)
@pytest.mark.parametrize(
("left_hand", "right_hand", "expected"),
(
("test_package", "test_package", True),
("test_package==1.2.3", "test_package==1.2.3", True),
("test_package>=1.2.3", "test_package>=1.2.3", True),
("test_package==1.2", "test_package==1.2.0", True),
("test_package>=1.2", "test_package>=1.2.0", True),
("test_package[foo,bar]==1.2", "test_package[bar,foo]==1.2", True),
("test_package[foo,bar]>=1.2", "test_package[bar,foo]>=1.2", True),
("test_package[foo,bar]==1.2", "test_package[bar,foo]==1.2.0", True),
("test_package[foo,bar]>=1.2", "test_package[bar,foo]>=1.2.0", True),
("test_package", "other_test_package", False),
("test_package==1.2.3", "other_test_package==1.2.3", False),
("test_package==1.2.3", "test_package==1.2.4", False),
("test_package>=1.2.3", "test_package>=1.2.4", False),
("test_package>=1.2.3", "test_package<=1.2.3", False),
("test_package==1.2", "test_package==1.2.3", False),
("test_package>=1.2", "test_package>=1.2.3", False),
("test_package[foo]==1.2", "test_package[bar]==1.2.0", False),
("test_package[foo]>=1.2", "test_package[bar]>=1.2.0", False),
("test_package[foo,bar]>=1.2", "test_package[bar]>=1.2.0", False),
("test_package[foo,bar]>=1.2", "test_package[bar,zee]>=1.2.0", False),
),
)
def test_RequirementSummary_equality(from_line, left_hand, right_hand, expected):
"""
RequirementSummary should report proper equality.
"""
lh_summary = RequirementSummary(from_line(left_hand))
rh_summary = RequirementSummary(from_line(right_hand))
assert (lh_summary == rh_summary) is expected
@pytest.mark.parametrize(
("left_hand", "right_hand", "expected"),
(
("test_package", "test_package", True),
("test_package==1.2.3", "test_package==1.2.3", True),
("test_package>=1.2.3", "test_package>=1.2.3", True),
("test_package==1.2", "test_package==1.2.0", True),
("test_package>=1.2", "test_package>=1.2.0", True),
("test_package[foo,bar]==1.2", "test_package[bar,foo]==1.2", True),
("test_package[foo,bar]>=1.2", "test_package[bar,foo]>=1.2", True),
("test_package[foo,bar]==1.2", "test_package[bar,foo]==1.2.0", True),
("test_package[foo,bar]>=1.2", "test_package[bar,foo]>=1.2.0", True),
("test_package", "other_test_package", False),
("test_package==1.2.3", "other_test_package==1.2.3", False),
("test_package==1.2.3", "test_package==1.2.4", False),
("test_package>=1.2.3", "test_package>=1.2.4", False),
("test_package>=1.2.3", "test_package<=1.2.3", False),
("test_package==1.2", "test_package==1.2.3", False),
("test_package>=1.2", "test_package>=1.2.3", False),
("test_package[foo]==1.2", "test_package[bar]==1.2.0", False),
("test_package[foo]>=1.2", "test_package[bar]>=1.2.0", False),
("test_package[foo,bar]>=1.2", "test_package[bar]>=1.2.0", False),
("test_package[foo,bar]>=1.2", "test_package[bar,zee]>=1.2.0", False),
),
)
def test_RequirementSummary_hash_equality(from_line, left_hand, right_hand, expected):
"""
RequirementSummary hash for equivalent requirements should be equal.
"""
lh_summary = RequirementSummary(from_line(left_hand))
rh_summary = RequirementSummary(from_line(right_hand))
assert (hash(lh_summary) == hash(rh_summary)) is expected
def test_requirement_summary_with_other_objects(from_line):
"""
RequirementSummary should not be equal to any other object
"""
requirement_summary = RequirementSummary(from_line("test_package==1.2.3"))
other_object = object()
assert requirement_summary != other_object
@pytest.mark.parametrize(
("exception", "cause"),
(
pytest.param(DistributionNotFound, None, id="without cause"),
pytest.param(DistributionNotFound, ZeroDivisionError, id="with cause"),
),
)
def test_catch_distribution_not_found_error(backtracking_resolver, exception, cause):
"""
Test internal edge-cases when backtracking resolver catches
and re-raises ``DistributionNotFound`` error with/without causes.
"""
resolver = backtracking_resolver([])
class FakePipResolver:
def resolve(self, *args, **kwargs):
raise exception from cause
with pytest.raises(DistributionNotFound):
resolver._do_resolve(
resolver=FakePipResolver(),
compatible_existing_constraints={},
)