/
test_requirements.py
612 lines (513 loc) · 17.5 KB
/
test_requirements.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
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
# This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
from typing import Optional, Set
import pytest
from packaging.markers import Marker
from packaging.requirements import InvalidRequirement, Requirement
from packaging.specifiers import SpecifierSet
EQUAL_DEPENDENCIES = [
("packaging>20.1", "packaging>20.1"),
(
'requests[security, tests]>=2.8.1,==2.8.*;python_version<"2.7"',
'requests [security,tests] >= 2.8.1, == 2.8.* ; python_version < "2.7"',
),
(
'importlib-metadata; python_version<"3.8"',
"importlib-metadata; python_version<'3.8'",
),
(
'appdirs>=1.4.4,<2; os_name=="posix" and extra=="testing"',
"appdirs>=1.4.4,<2; os_name == 'posix' and extra == 'testing'",
),
]
DIFFERENT_DEPENDENCIES = [
("package_one", "package_two"),
("packaging>20.1", "packaging>=20.1"),
("packaging>20.1", "packaging>21.1"),
("packaging>20.1", "package>20.1"),
(
'requests[security,tests]>=2.8.1,==2.8.*;python_version<"2.7"',
'requests [security,tests] >= 2.8.1 ; python_version < "2.7"',
),
(
'importlib-metadata; python_version<"3.8"',
"importlib-metadata; python_version<'3.7'",
),
(
'appdirs>=1.4.4,<2; os_name=="posix" and extra=="testing"',
"appdirs>=1.4.4,<2; os_name == 'posix' and extra == 'docs'",
),
]
@pytest.mark.parametrize(
"name",
[
"package",
"pAcKaGe",
"Package",
"foo-bar.quux_bAz",
"installer",
"android12",
],
)
@pytest.mark.parametrize(
"extras",
[
set(),
{"a"},
{"a", "b"},
{"a", "B", "CDEF123"},
],
)
@pytest.mark.parametrize(
("url", "specifier"),
[
(None, ""),
("https://example.com/packagename.zip", ""),
("ssh://user:pass%20word@example.com/packagename.zip", ""),
("https://example.com/name;v=1.1/?query=foo&bar=baz#blah", ""),
("git+ssh://git.example.com/MyProject", ""),
("git+ssh://git@github.com:pypa/packaging.git", ""),
("git+https://git.example.com/MyProject.git@master", ""),
("git+https://git.example.com/MyProject.git@v1.0", ""),
("git+https://git.example.com/MyProject.git@refs/pull/123/head", ""),
(None, "==={ws}arbitrarystring"),
(None, "({ws}==={ws}arbitrarystring{ws})"),
(None, "=={ws}1.0"),
(None, "({ws}=={ws}1.0{ws})"),
(None, "<={ws}1!3.0.0.rc2"),
(None, ">{ws}2.2{ws},{ws}<{ws}3"),
(None, "(>{ws}2.2{ws},{ws}<{ws}3)"),
],
)
@pytest.mark.parametrize(
"marker",
[
None,
"python_version{ws}>={ws}'3.3'",
'({ws}python_version{ws}>={ws}"3.4"{ws}){ws}and extra{ws}=={ws}"oursql"',
(
"sys_platform{ws}!={ws}'linux' and(os_name{ws}=={ws}'linux' or "
"python_version{ws}>={ws}'3.3'{ws}){ws}"
),
],
)
@pytest.mark.parametrize("whitespace", ["", " ", "\t"])
def test_basic_valid_requirement_parsing(
name: str,
extras: Set[str],
specifier: str,
url: Optional[str],
marker: str,
whitespace: str,
) -> None:
# GIVEN
parts = [name]
if extras:
parts.append("[")
parts.append("{ws},{ws}".format(ws=whitespace).join(sorted(extras)))
parts.append("]")
if specifier:
parts.append(specifier.format(ws=whitespace))
if url is not None:
parts.append("@")
parts.append(url.format(ws=whitespace))
if marker is not None:
if url is not None:
parts.append(" ;")
else:
parts.append(";")
parts.append(marker.format(ws=whitespace))
to_parse = whitespace.join(parts)
# WHEN
req = Requirement(to_parse)
# THEN
assert req.name == name
assert req.extras == extras
assert req.url == url
assert req.specifier == specifier.format(ws="").strip("()")
assert req.marker == (Marker(marker.format(ws="")) if marker else None)
class TestRequirementParsing:
@pytest.mark.parametrize(
"marker",
[
"python_implementation == ''",
"platform_python_implementation == ''",
"os.name == 'linux'",
"os_name == 'linux'",
"'8' in platform.version",
"'8' not in platform.version",
],
)
def test_valid_marker(self, marker: str) -> None:
# GIVEN
to_parse = f"name; {marker}"
# WHEN
Requirement(to_parse)
@pytest.mark.parametrize(
"url",
[
"file:///absolute/path",
"file://.",
],
)
def test_file_url(self, url: str) -> None:
# GIVEN
to_parse = f"name @ {url}"
# WHEN
req = Requirement(to_parse)
# THEN
assert req.url == url
def test_empty_extras(self) -> None:
# GIVEN
to_parse = "name[]"
# WHEN
req = Requirement(to_parse)
# THEN
assert req.name == "name"
assert req.extras == set()
def test_empty_specifier(self) -> None:
# GIVEN
to_parse = "name()"
# WHEN
req = Requirement(to_parse)
# THEN
assert req.name == "name"
assert req.specifier == ""
# ----------------------------------------------------------------------------------
# Everything below this (in this class) should be parsing failure modes
# ----------------------------------------------------------------------------------
# Start all method names with with `test_error_`
# to make it easier to run these tests with `-k error`
def test_error_when_empty_string(self) -> None:
# GIVEN
to_parse = ""
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected package name at the start of dependency specifier\n"
" \n"
" ^"
)
def test_error_no_name(self) -> None:
# GIVEN
to_parse = "==0.0"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected package name at the start of dependency specifier\n"
" ==0.0\n"
" ^"
)
def test_error_when_missing_comma_in_extras(self) -> None:
# GIVEN
to_parse = "name[bar baz]"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected comma between extra names\n"
" name[bar baz]\n"
" ^"
)
def test_error_when_trailing_comma_in_extras(self) -> None:
# GIVEN
to_parse = "name[bar, baz,]"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected extra name after comma\n"
" name[bar, baz,]\n"
" ^"
)
def test_error_when_parens_not_closed_correctly(self) -> None:
# GIVEN
to_parse = "name (>= 1.0"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected closing RIGHT_PARENTHESIS\n"
" name (>= 1.0\n"
" ~~~~~~~^"
)
def test_error_when_bracket_not_closed_correctly(self) -> None:
# GIVEN
to_parse = "name[bar, baz >= 1.0"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected closing RIGHT_BRACKET\n"
" name[bar, baz >= 1.0\n"
" ~~~~~~~~~~^"
)
def test_error_when_extras_bracket_left_unclosed(self) -> None:
# GIVEN
to_parse = "name[bar, baz"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected closing RIGHT_BRACKET\n"
" name[bar, baz\n"
" ~~~~~~~~~^"
)
def test_error_no_space_after_url(self) -> None:
# GIVEN
to_parse = "name @ https://example.com/; extra == 'example'"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected end or semicolon (after URL and whitespace)\n"
" name @ https://example.com/; extra == 'example'\n"
" ~~~~~~~~~~~~~~~~~~~~~~^"
)
def test_error_no_url_after_at(self) -> None:
# GIVEN
to_parse = "name @ "
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected URL after @\n"
" name @ \n"
" ^"
)
def test_error_invalid_marker_lvalue(self) -> None:
# GIVEN
to_parse = "name; invalid_name"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected a marker variable or quoted string\n"
" name; invalid_name\n"
" ^"
)
def test_error_invalid_marker_rvalue(self) -> None:
# GIVEN
to_parse = "name; '3.7' <= invalid_name"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected a marker variable or quoted string\n"
" name; '3.7' <= invalid_name\n"
" ^"
)
def test_error_invalid_marker_notin_without_whitespace(self) -> None:
# GIVEN
to_parse = "name; '3.7' notin python_version"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected marker operator, one of <=, <, !=, ==, >=, >, ~=, ===, "
"in, not in\n"
" name; '3.7' notin python_version\n"
" ^"
)
def test_error_when_no_word_boundary(self) -> None:
# GIVEN
to_parse = "name; '3.6'inpython_version"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected marker operator, one of <=, <, !=, ==, >=, >, ~=, ===, "
"in, not in\n"
" name; '3.6'inpython_version\n"
" ^"
)
def test_error_invalid_marker_not_without_in(self) -> None:
# GIVEN
to_parse = "name; '3.7' not python_version"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected 'in' after 'not'\n"
" name; '3.7' not python_version\n"
" ^"
)
def test_error_invalid_marker_with_invalid_op(self) -> None:
# GIVEN
to_parse = "name; '3.7' ~ python_version"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected marker operator, one of <=, <, !=, ==, >=, >, ~=, ===, "
"in, not in\n"
" name; '3.7' ~ python_version\n"
" ^"
)
@pytest.mark.parametrize(
"url",
[
"gopher:/foo/com",
"file:.",
"file:/.",
],
)
def test_error_on_invalid_url(self, url: str) -> None:
# GIVEN
to_parse = f"name @ {url}"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert "Invalid URL" in ctx.exconly()
def test_error_on_legacy_version_outside_triple_equals(self) -> None:
# GIVEN
to_parse = "name==1.0.org1"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected end or semicolon (after version specifier)\n"
" name==1.0.org1\n"
" ~~~~~^"
)
def test_error_on_missing_version_after_op(self) -> None:
# GIVEN
to_parse = "name=="
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected version after operator\n"
" name==\n"
" ^"
)
def test_error_on_missing_op_after_name(self) -> None:
# GIVEN
to_parse = "name 1.0"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected end or semicolon (after name and no valid version specifier)\n"
" name 1.0\n"
" ^"
)
def test_error_on_random_char_after_specifier(self) -> None:
# GIVEN
to_parse = "name >= 1.0 #"
# WHEN
with pytest.raises(InvalidRequirement) as ctx:
Requirement(to_parse)
# THEN
assert ctx.exconly() == (
"packaging.requirements.InvalidRequirement: "
"Expected end or semicolon (after version specifier)\n"
" name >= 1.0 #\n"
" ~~~~~~~^"
)
class TestRequirementBehaviour:
def test_types_with_nothing(self) -> None:
# GIVEN
to_parse = "foobar"
# WHEN
req = Requirement(to_parse)
# THEN
assert isinstance(req.name, str)
assert isinstance(req.extras, set)
assert req.url is None
assert isinstance(req.specifier, SpecifierSet)
assert req.marker is None
def test_types_with_specifier_and_marker(self) -> None:
# GIVEN
to_parse = "foobar[quux]<2,>=3; os_name=='a'"
# WHEN
req = Requirement(to_parse)
# THEN
assert isinstance(req.name, str)
assert isinstance(req.extras, set)
assert req.url is None
assert isinstance(req.specifier, SpecifierSet)
assert isinstance(req.marker, Marker)
def test_types_with_url(self) -> None:
req = Requirement("foobar @ http://foo.com")
assert isinstance(req.name, str)
assert isinstance(req.extras, set)
assert isinstance(req.url, str)
assert isinstance(req.specifier, SpecifierSet)
assert req.marker is None
@pytest.mark.parametrize(
"url_or_specifier",
["", "@ https://url ", "!=2.0", "==2.*"],
)
@pytest.mark.parametrize("extras", ["", "[a]", "[a,b]", "[a1,b1,b2]"])
@pytest.mark.parametrize(
"marker",
["", '; python_version == "3.11"', '; "3." not in python_version'],
)
def test_str_and_repr(
self, extras: str, url_or_specifier: str, marker: str
) -> None:
# GIVEN
to_parse = f"name{extras}{url_or_specifier}{marker}".strip()
# WHEN
req = Requirement(to_parse)
# THEN
assert str(req) == to_parse
assert repr(req) == f"<Requirement({to_parse!r})>"
@pytest.mark.parametrize("dep1, dep2", EQUAL_DEPENDENCIES)
def test_equal_reqs_equal_hashes(self, dep1: str, dep2: str) -> None:
"""Requirement objects created from equivalent strings should be equal."""
# GIVEN / WHEN
req1, req2 = Requirement(dep1), Requirement(dep2)
assert req1 == req2
assert hash(req1) == hash(req2)
@pytest.mark.parametrize("dep1, dep2", DIFFERENT_DEPENDENCIES)
def test_different_reqs_different_hashes(self, dep1: str, dep2: str) -> None:
"""Requirement objects created from non-equivalent strings should differ."""
# GIVEN / WHEN
req1, req2 = Requirement(dep1), Requirement(dep2)
# THEN
assert req1 != req2
assert hash(req1) != hash(req2)
def test_compare_with_string(self) -> None:
assert Requirement("packaging>=21.3") != "packaging>=21.3"