-
Notifications
You must be signed in to change notification settings - Fork 86
Expand file tree
/
Copy pathtest_requirement.py
More file actions
909 lines (739 loc) · 29.6 KB
/
test_requirement.py
File metadata and controls
909 lines (739 loc) · 29.6 KB
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
from __future__ import annotations
import os
import sys
from email.message import EmailMessage
from pathlib import Path
from tempfile import NamedTemporaryFile, TemporaryDirectory
from threading import Thread
import pretend # type: ignore
import pytest
from packaging.version import Version
from pip_audit._dependency_source import (
PYPI_URL,
DependencyFixError,
DependencySourceError,
requirement,
)
from pip_audit._fix import ResolvedFixVersion
from pip_audit._service import ResolvedDependency, SkippedDependency
from pip_audit._state import AuditState
from pip_audit._virtual_env import VirtualEnv, VirtualEnvError
def get_metadata_mock():
return EmailMessage()
def _init_requirement(
files: list[tuple[Path, str]],
**kwargs,
) -> requirement.RequirementSource:
paths: list[Path] = []
for path, contents in files:
with open(path, mode="w") as f:
f.write(contents)
paths.append(path)
return requirement.RequirementSource(paths, **kwargs)
@pytest.mark.online
def test_requirement_source(req_file):
source = _init_requirement([(req_file(), "flask==2.0.1")])
specs = list(source.collect())
assert ResolvedDependency("Flask", Version("2.0.1")) in specs
@pytest.mark.online
def test_requirement_source_multiple_files(req_file):
source = _init_requirement(
[
(req_file(), "flask==2.0.1"),
(req_file(), "requests==2.8.1"),
(req_file(), "pip-api==0.0.22\npackaging==21.0"),
]
)
specs = list(source.collect())
assert ResolvedDependency("Flask", Version("2.0.1")) in specs
assert ResolvedDependency("requests", Version("2.8.1")) in specs
assert ResolvedDependency("pip-api", Version("0.0.22")) in specs
assert ResolvedDependency("packaging", Version("21.0")) in specs
def test_requirement_source_impossible_resolution(req_file):
source = _init_requirement([(req_file(), "flask==2.0.1\nflask==2.0.0")])
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_virtualenv_error(monkeypatch, req_file):
class MockVirtualEnv:
def __init__(
self,
install_args: list[str],
index_url: str,
extra_index_url: list[str],
state: AuditState,
) -> None:
pass
def create(self, dir: Path) -> None:
raise VirtualEnvError
source = _init_requirement(
[
(
req_file(),
"flask==2.0.1",
)
]
)
monkeypatch.setattr(requirement, "VirtualEnv", MockVirtualEnv)
with pytest.raises(DependencySourceError):
list(source.collect())
@pytest.mark.online
def test_requirement_source_duplicate_dependencies(req_file):
# Return the same requirements for both files
source = _init_requirement([(req_file(), "flask==2.0.1"), (req_file(), "flask==2.0.1")])
specs = list(source.collect())
# If the dependency list has duplicates, then converting to a set will reduce the length of the
# collection
assert len(specs) == len(set(specs))
def test_requirement_source_invalid_lines(req_file):
source = _init_requirement([(req_file(), "a#b#c")])
with pytest.raises(DependencySourceError):
list(source.collect())
@pytest.mark.online
def test_requirement_source_git(req_file):
source = _init_requirement(
[
(
req_file(),
"git+https://github.com/pypa/sampleproject.git@5d277956b5a571dac16b28db74e5f2b780d9af5f",
)
]
)
specs = list(source.collect())
assert ResolvedDependency(name="sampleproject", version=Version("3.0.0")) in specs
@pytest.mark.online
def test_requirement_source_url(req_file):
source = _init_requirement(
[
(
req_file(),
"https://github.com/pallets/flask/archive/refs/tags/2.0.1.tar.gz\n",
)
],
)
specs = list(source.collect())
assert (
ResolvedDependency(
name="Flask",
version=Version("2.0.1"),
)
in specs
)
@pytest.mark.online
def test_requirement_source_multiple_indexes(req_file):
source = _init_requirement(
[(req_file(), "flask==2.0.1")],
index_url=PYPI_URL,
extra_index_urls=["https://test.pypi.org/simple/"],
)
specs = list(source.collect())
assert ResolvedDependency("Flask", Version("2.0.1")) in specs
def _check_fixes(
input_reqs: list[str],
expected_reqs: list[str],
req_paths: list[Path],
fixes: list[ResolvedFixVersion],
) -> None:
# Populate the requirements files
for input_req, req_path in zip(input_reqs, req_paths, strict=True):
with open(req_path, "w") as f:
print(input_req, file=f)
source = requirement.RequirementSource(req_paths)
for fix in fixes:
source.fix(fix)
# Check the requirements files
for expected_req, req_path in zip(expected_reqs, req_paths, strict=True):
with open(req_path) as f:
# NOTE: We don't make any guarantees about non-semantic whitespace
# preservation, hence the strip.
assert expected_req == f.read().strip()
def test_requirement_source_fix(req_file):
_check_fixes(
["flask==0.5"],
["flask==1.0"],
[req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_roundtrip(req_file):
req_path = req_file()
with open(req_path, "w") as f:
f.write("flask==0.5")
source = requirement.RequirementSource([req_path])
specs = list(source.collect())
flask_dep: ResolvedDependency | None = None
for spec in specs:
if isinstance(spec, ResolvedDependency) and spec.canonical_name == "flask":
flask_dep = spec
break
assert flask_dep is not None
assert flask_dep == ResolvedDependency(name="Flask", version=Version("0.5"))
flask_fix = ResolvedFixVersion(dep=flask_dep, version=Version("1.0"))
source.fix(flask_fix)
with open(req_path) as f:
assert f.read().strip() == "flask==1.0"
def test_requirement_source_fix_roundtrip_non_canonical_name(req_file):
req_path = req_file()
with open(req_path, "w") as f:
f.write("Flask==0.5")
source = requirement.RequirementSource([req_path])
specs = list(source.collect())
flask_dep: ResolvedDependency | None = None
for spec in specs:
if isinstance(spec, ResolvedDependency) and spec.canonical_name == "flask":
flask_dep = spec
break
assert flask_dep is not None
assert flask_dep == ResolvedDependency(name="Flask", version=Version("0.5"))
flask_fix = ResolvedFixVersion(dep=flask_dep, version=Version("1.0"))
source.fix(flask_fix)
with open(req_path) as f:
assert f.read().strip() == "Flask==1.0"
def test_requirement_source_fix_multiple_files(req_file):
_check_fixes(
["flask==0.5", "requests==2.0\nflask==0.5"],
["flask==1.0", "requests==2.0\nflask==1.0"],
[req_file(), req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_specifier_match(req_file):
_check_fixes(
["flask<1.0", "requests==2.0\nflask<=0.6"],
["flask==1.0", "requests==2.0\nflask==1.0"],
[req_file(), req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_specifier_no_match(req_file):
# In order to make a fix, the specifier must match the current version and NOT the resolved fix
# version. If the specifier matches both, we don't apply the fix since installing from the given
# requirements file would already install the fixed version.
_check_fixes(
["flask>=0.5", "requests==2.0\nflask<2.0"],
["flask>=0.5", "requests==2.0\nflask<2.0"],
[req_file(), req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_preserve_marker(req_file):
# `pip-requirements-parser` preserves requirements with markers that don't apply to the current
# environment.
_check_fixes(
[
'flask<1.0; python_version > "2.7"',
'requests==2.0\nflask<=0.6; python_version <= "2.7"',
],
[
'flask==1.0; python_version > "2.7"',
'requests==2.0\nflask==1.0; python_version <= "2.7"',
],
[req_file(), req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_comments(req_file):
_check_fixes(
[
"# comment here\nflask==0.5",
"requests==2.0\n# another comment\nflask==0.5",
],
["# comment here\nflask==1.0", "requests==2.0\n# another comment\nflask==1.0"],
[req_file(), req_file()],
[
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
],
)
def test_requirement_source_fix_parse_failure(monkeypatch, req_file):
logger = pretend.stub(warning=pretend.call_recorder(lambda s: None))
monkeypatch.setattr(requirement, "logger", logger)
# If we encounter multiple of the same package in the requirements file, we will throw a parsing
# error
input_reqs = ["flask==0.5", "flask==0.5\nrequests==2.0\nflask==0.3"]
req_paths = [req_file(), req_file()]
# Populate the requirements files
for input_req, req_path in zip(input_reqs, req_paths, strict=True):
with open(req_path, "w") as f:
f.write(input_req)
source = requirement.RequirementSource(req_paths)
with pytest.raises(DependencyFixError):
source.fix(
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
)
assert len(logger.warning.calls) == 1
# Check that the requirements files remain unchanged
# If we encounter a failure while applying a fix, the fix should be rolled back from all files
for expected_req, req_path in zip(input_reqs, req_paths, strict=True):
with open(req_path) as f:
assert expected_req == f.read().strip()
def test_requirement_source_fix_rollback_failure(monkeypatch, req_file):
logger = pretend.stub(warning=pretend.call_recorder(lambda s: None))
monkeypatch.setattr(requirement, "logger", logger)
# If we encounter multiple of the same package in the requirements file, we will throw a parsing
# error
input_reqs = ["flask==0.5", "flask==0.5\nrequests==2.0\nflask==0.3"]
req_paths = [req_file(), req_file()]
# Populate the requirements files
for input_req, req_path in zip(input_reqs, req_paths, strict=True):
with open(req_path, "w") as f:
f.write(input_req)
# Simulate an error being raised during file recovery
def mock_seek(*_args, **_kwargs):
raise OSError
from tempfile import _TemporaryFileWrapper
monkeypatch.setattr(_TemporaryFileWrapper, "seek", mock_seek, raising=False)
source = requirement.RequirementSource(req_paths)
with pytest.raises(DependencyFixError):
source.fix(
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
)
# One for the parsing error and one for each file that we failed to rollback
assert len(logger.warning.calls) == 3
# We couldn't move the original requirements files back so we should expect a partially applied
# fix. The first requirements file contains the fix, while the second one doesn't since we were
# in the process of writing it out and didn't flush.
expected_reqs = ["flask==1.0", "flask==0.5\nrequests==2.0\nflask==0.3"]
for expected_req, req_path in zip(expected_reqs, req_paths, strict=True):
with open(req_path) as f:
assert expected_req == f.read().strip()
@pytest.mark.online
def test_requirement_source_require_hashes(req_file):
source = _init_requirement(
[
(
req_file(),
"wheel==0.38.1 "
"--hash=sha256:7a95f9a8dc0924ef318bd55b616112c70903192f524d120acc614f59547a9e1f\n"
"setuptools==67.0.0 "
"--hash=sha256:9d790961ba6219e9ff7d9557622d2fe136816a264dd01d5997cfc057d804853d",
)
],
require_hashes=True,
)
specs = list(source.collect())
assert specs == [
ResolvedDependency(name="wheel", version=Version("0.38.1")),
ResolvedDependency(name="setuptools", version=Version("67.0.0")),
]
@pytest.mark.online
def test_requirement_source_require_hashes_not_fully_resolved(req_file):
# When using `--require-hashes`, `pip` requires a fully resolved list of requirements. If it
# finds a subdependency that is not listed in the requirements file, it will raise an error.
#
# In the case of Flask, this package has lots of subdependencies that aren't listed here so we
# expect an error.
source = _init_requirement(
[
(
req_file(),
"flask==2.0.1 "
"--hash=sha256:a6209ca15eb63fc9385f38e452704113d679511d9574d09b2cf9183ae7d20dc9",
)
],
require_hashes=True,
)
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_require_hashes_missing(req_file):
source = _init_requirement([(req_file(), "wheel==0.38.1")], require_hashes=True)
# All requirements must be hashed when collecting with `require-hashes`
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_require_hashes_inferred(req_file):
source = _init_requirement(
[
(
req_file(),
"wheel==0.38.1 "
"--hash=sha256:7a95f9a8dc0924ef318bd55b616112c70903192f524d120acc614f59547a9e1f\n"
"setuptools==67.0.0",
)
]
)
# If at least one requirement is hashed, this infers `require-hashes`
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_require_hashes_unpinned(req_file):
source = _init_requirement(
[
(
req_file(),
"wheel==0.38.1 "
"--hash=sha256:7a95f9a8dc0924ef318bd55b616112c70903192f524d120acc614f59547a9e1f\n"
"setuptools<=67.0.0 "
"--hash=sha256:9d790961ba6219e9ff7d9557622d2fe136816a264dd01d5997cfc057d804853d",
)
]
)
# When hashed dependencies are provided, all dependencies must be explicitly pinned to an exact
# version number
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_require_hashes_incorrect_hash(req_file):
source = _init_requirement(
[
(
req_file(),
"wheel==0.38.1 "
"--hash=sha256:7a95f9a8dc0924ef318bd55b616112c70903192f524d120acc614f59547a9e1f\n"
"setuptools<=67.0.0 "
"--hash=sha256:setuptools-hash",
)
]
)
# The `setuptools` hash is incorrect.
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_disable_pip_editable_skip(req_file):
source = _init_requirement(
[(req_file(), "-e file:flask.py#egg=flask==2.0.1")],
disable_pip=True,
no_deps=True,
skip_editable=True,
)
specs = list(source.collect())
assert SkippedDependency(name="flask", skip_reason="requirement marked as editable") in specs
def test_requirement_source_disable_pip_duplicate_dependencies(req_file):
source = _init_requirement(
[(req_file(), "flask==1.0\nflask==1.0")], disable_pip=True, no_deps=True
)
specs = list(source.collect())
# If the dependency list has duplicates, then converting to a set will reduce the length of the
# collection
assert len(specs) == len(set(specs))
def test_requirement_source_disable_pip_duplicate_dependencies_with_extras(req_file):
source = _init_requirement(
[(req_file(), "aiohttp==3.9\naiohttp[speedups]==3.9")], disable_pip=True, no_deps=True
)
specs = list(source.collect())
# If the dependency list has duplicates, then converting to a set will reduce the length of the
# collection
assert len(specs) == len(set(specs))
def test_requirement_source_disable_pip_duplicate_dependencies_diff_specifier(req_file):
source = _init_requirement(
[(req_file(), "flask==1.0\nflask==2.0")], disable_pip=True, no_deps=True
)
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_no_double_open(monkeypatch, req_file):
source = _init_requirement([(req_file(), "flask==2.0.1")])
# Intercept the calls to `NamedTemporaryFile` to get a handle on each file object.
tmp_files = []
def named_temp_file(*args, **kwargs):
tmp_file = NamedTemporaryFile(*args, **kwargs)
tmp_files.append(tmp_file)
return tmp_file
monkeypatch.setattr(
requirement,
"NamedTemporaryFile",
named_temp_file,
)
# Intercept the `VirtualEnv` constructor to check that all file handles are closed prior to
# the `pip` invocation.
#
# `pip` will open the file so we need to ensure that we've closed it.
def virtual_env(*args, **kwargs):
for tmp_file in tmp_files:
assert tmp_file.closed
return VirtualEnv(*args, **kwargs)
monkeypatch.setattr(requirement, "VirtualEnv", virtual_env)
specs = list(source.collect())
assert ResolvedDependency("Flask", Version("2.0.1")) in specs
@pytest.mark.skipif(sys.platform == "win32", reason="os.mkfifo does not exists on windows")
def test_requirement_source_fifo():
with TemporaryDirectory() as tmp_dir:
fifo_path = Path(os.path.join(tmp_dir, "fifo"))
os.mkfifo(fifo_path)
def write_to_fifo():
with open(fifo_path, "w") as f:
f.write("flask==2.0.1")
# Make sure we wait for the thread to be done regardless of whether an
# error gets thrown
t = Thread(target=write_to_fifo)
t.start()
try:
source = requirement.RequirementSource([fifo_path])
specs = list(source.collect())
finally:
t.join()
assert ResolvedDependency("Flask", Version("2.0.1")) in specs
def test_requirement_source_fix_explicit_subdep(monkeypatch, req_file):
logger = pretend.stub(warning=pretend.call_recorder(lambda s: None))
monkeypatch.setattr(requirement, "logger", logger)
source = _init_requirement([(req_file(), "flask==2.0.1")])
flask_deps = source.collect()
# Firstly, get a handle on the `jinja2` dependency. The version cannot be hardcoded since it
# depends what versions are available on PyPI when dependency resolution runs.
jinja_dep: ResolvedDependency | None = None
for dep in flask_deps:
if isinstance(dep, ResolvedDependency) and dep.canonical_name == "jinja2":
jinja_dep = dep
break
assert jinja_dep is not None
# Check that the `jinja2` dependency is explicitly added to the requirements file with an
# associated comment.
_check_fixes(
["flask==2.0.1"],
["flask==2.0.1\n # pip-audit: subdependency explicitly fixed\njinja2==4.0.0"],
[req_file()],
[
ResolvedFixVersion(
dep=jinja_dep,
version=Version("4.0.0"),
)
],
)
# When explicitly listing a fixed subdependency, we issue a warning.
assert len(logger.warning.calls) == 1
def test_requirement_source_fix_explicit_subdep_multiple_reqs(req_file):
# Recreate the vulnerable subdependency case.
source = _init_requirement([(req_file(), "flask==2.0.1")])
flask_deps = source.collect()
jinja_dep: ResolvedDependency | None = None
for dep in flask_deps:
if isinstance(dep, ResolvedDependency) and dep.canonical_name == "jinja2":
jinja_dep = dep
break
assert jinja_dep is not None
# This time our requirements file also lists `django-jinja`, another requirement that depends on
# `jinja2`. We're expecting that the comment generated above the `jinja2` requirement that gets
# added into the file will list both `flask` and `django-jinja` as sources.
_check_fixes(
["flask==2.0.1\ndjango-jinja==1.0"],
[
"flask==2.0.1\ndjango-jinja==1.0\n"
" # pip-audit: subdependency explicitly fixed\n"
"jinja2==4.0.0"
],
[req_file()],
[
ResolvedFixVersion(
dep=jinja_dep,
version=Version("4.0.0"),
)
],
)
def test_requirement_source_fix_explicit_subdep_resolver_error(req_file):
# Recreate the vulnerable subdependency case.
source = _init_requirement([(req_file(), "flask==2.0.1")])
flask_deps = source.collect()
jinja_dep: ResolvedDependency | None = None
for dep in flask_deps:
if isinstance(dep, ResolvedDependency) and dep.canonical_name == "jinja2":
jinja_dep = dep
break
assert jinja_dep is not None
# Dependee requirements are a attached to each dependency. We no longer resolve dependencies
# as part of `--fix` so we shouldn't call into dependency resolution.
mock_resolver = pretend.stub(resolve=pretend.call_recorder(lambda _reqs, _req_hashes: []))
source.fix(
ResolvedFixVersion(
dep=jinja_dep,
version=Version("4.0.0"),
)
)
assert len(mock_resolver.resolve.calls) == 0
def test_requirement_source_fix_explicit_subdep_comment_retention(req_file):
# This test is regression testing a weakness in the previous fix implementation.
#
# When fixing a subdependency and explicitly adding it to the requirements file, we add a
# comment above the line to explain its presence since it's unusual to explicitly pin a
# subdependency like this.
#
# When we "fix" dependencies, we parse the requirements file and write it back out with the
# relevant line amended or added. When we used `pip-api` for requirements parsing, our fix logic
# had the unfortunate side effect of stripping comments from the file. Importantly, when we
# applied subdependency fixes, the automated comments used to be removed by any subsequent
# fixes.
#
# Since we've switching `pip-requirements-parser`, we should no longer have this issue.
# Recreate the vulnerable subdependency case.
source = _init_requirement([(req_file(), "flask==2.0.1")])
flask_deps = source.collect()
jinja_dep: ResolvedDependency | None = None
for dep in flask_deps:
if isinstance(dep, ResolvedDependency) and dep.canonical_name == "jinja2":
jinja_dep = dep
break
assert jinja_dep is not None
# Now place a fix for the top-level `flask` requirement after the `jinja2` subdependency fix.
#
# When applying the `flask` fix, `pip-audit` reparses the requirements file, and writes it back
# out with the fixed `flask` version with the comments preserved.
#
# One quirk is that comment indentation isn't preserved (the automated comment was originally
# indented with 4 spaces).
_check_fixes(
["flask==2.0.1"],
["flask==3.0.0\n# pip-audit: subdependency explicitly fixed\njinja2==4.0.0"],
[req_file()],
[
ResolvedFixVersion(
dep=jinja_dep,
version=Version("4.0.0"),
),
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("2.0.1")),
version=Version("3.0.0"),
),
],
)
def test_requirement_source_fix_invalid_lines(req_file):
source = _init_requirement([(req_file(), "a#b#c\nflask==0.5")])
with pytest.raises(DependencyFixError):
source.fix(
ResolvedFixVersion(
dep=ResolvedDependency(name="flask", version=Version("0.5")),
version=Version("1.0"),
)
)
def test_requirement_source_disable_pip(req_file):
source = _init_requirement([(req_file(), "flask==2.0.1")], disable_pip=True, no_deps=True)
specs = list(source.collect())
assert specs == [ResolvedDependency("flask", Version("2.0.1"))]
def test_requirement_source_disable_pip_without_no_deps(req_file):
# In order to use `--disable-pip`, the requirements file must either be hashed or `--no-deps`
# must be provided.
#
# Since neither is true, we expect a failure.
source = _init_requirement(
[(req_file(), "flask==2.0.1")],
disable_pip=True,
)
with pytest.raises(
DependencySourceError,
match="the --disable-pip flag can only be used with a hashed requirements files or if the "
"--no-deps flag has been provided",
):
list(source.collect())
def test_requirement_source_disable_pip_hashes_without_no_deps(req_file):
# In this case, `--no-deps` is not provided but since the requirements file is hashed, providing
# `--disable-pip` is valid.
source = _init_requirement(
[
(
req_file(),
"flask==2.0.1 "
"--hash=sha256:a6209ca15eb63fc9385f38e452704113d679511d9574d09b2cf9183ae7d20dc9",
)
],
disable_pip=True,
)
specs = list(source.collect())
assert specs == [ResolvedDependency("flask", Version("2.0.1"))]
def test_requirement_source_disable_pip_incomplete_hashes(req_file):
# In this case, `--no-deps` is not provided but since the requirements file is hashed, providing
# `--disable-pip` is valid.
source = _init_requirement(
[
(
req_file(),
"flask==2.0.1 "
"--hash=sha256:a6209ca15eb63fc9385f38e452704113d679511d9574d09b2cf9183ae7d20dc9\n"
"requests==1.0",
)
],
disable_pip=True,
)
with pytest.raises(
DependencySourceError, match="requirement requests==1.0 does not contain a hash"
):
list(source.collect())
def test_requirement_source_disable_pip_unpinned(req_file):
source = _init_requirement(
[(req_file(), "flask\nrequests==1.0")], disable_pip=True, no_deps=True
)
# When dependency resolution is disabled, all requirements must be pinned.
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_disable_pip_not_exact_version(req_file):
source = _init_requirement(
[(req_file(), "flask==1.0\nrequests>=1.0")], disable_pip=True, no_deps=True
)
# When dependency resolution is disabled, all requirements must be pinned.
with pytest.raises(DependencySourceError):
list(source.collect())
def test_requirement_source_disable_pip_unpinned_url(req_file):
source = _init_requirement(
[
(
req_file(),
"https://github.com/pallets/flask/archive/refs/tags/2.0.1.tar.gz#egg=flask\n",
)
],
disable_pip=True,
no_deps=True,
)
assert list(source.collect()) == [
SkippedDependency(
name="flask",
skip_reason="URL requirements cannot be pinned to a specific package version",
)
]
def test_requirement_source_disable_pip_editable_with_egg_fragment(req_file):
source = _init_requirement(
[(req_file(), "-e file:flask.py#egg=flask==2.0.1")],
disable_pip=True,
no_deps=True,
)
specs = list(source.collect())
assert (
SkippedDependency(
name="flask",
skip_reason="URL requirements cannot be pinned to a specific package version",
)
in specs
)
def test_requirement_source_disable_pip_editable_without_egg_fragment(req_file):
source = _init_requirement([(req_file(), "-e file:flask.py")], disable_pip=True, no_deps=True)
specs = list(source.collect())
assert (
SkippedDependency(
name="-e file:flask.py",
skip_reason="could not deduce package version from URL requirement",
)
in specs
)
def test_requirement_source_non_normalized_version(req_file):
"""
This test verifies the fix for issue https://github.com/pypa/pip-audit/issues/464,
where non-normalized version strings in requirements files could cause parsing errors.
With packaging>=23.0.0, these versions should be parsed and normalized correctly.
"""
source = _init_requirement(
[(req_file(), "setuptools==80.9.1.0")], disable_pip=True, no_deps=True
)
specs = list(source.collect())
assert len(specs) == 1
assert isinstance(specs[0], ResolvedDependency)
assert specs[0].name == "setuptools"
# Both versions should be considered equal
assert specs[0].version == Version("80.9.1") == Version("80.9.1.0")