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
|
from __future__ import annotations
import datetime
import sys
from pathlib import Path
from typing import Any
import pytest
import tomli_w
from packaging.markers import Marker
from packaging.pylock import (
Package,
PackageDirectory,
PackageVcs,
PackageWheel,
Pylock,
PylockUnsupportedVersionError,
PylockValidationError,
is_valid_pylock_path,
)
from packaging.specifiers import SpecifierSet
from packaging.utils import NormalizedName
from packaging.version import Version
if sys.version_info >= (3, 11):
import tomllib
else:
import tomli as tomllib
@pytest.mark.parametrize(
("file_name", "valid"),
[
("pylock.toml", True),
("pylock.spam.toml", True),
("pylock.json", False),
("pylock..toml", False),
],
)
def test_pylock_file_name(file_name: str, valid: bool) -> None:
assert is_valid_pylock_path(Path(file_name)) is valid
def test_toml_roundtrip() -> None:
pep751_example = (
Path(__file__).parent / "pylock" / "pylock.spec-example.toml"
).read_text()
pylock_dict = tomllib.loads(pep751_example)
pylock = Pylock.from_dict(pylock_dict)
# Check that the roundrip via Pylock dataclasses produces the same TOML
# output, modulo TOML serialization differences.
assert tomli_w.dumps(pylock.to_dict()) == tomli_w.dumps(pylock_dict)
@pytest.mark.parametrize("version", ["1.0", "1.1"])
def test_pylock_version(version: str) -> None:
data = {
"lock-version": version,
"created-by": "pip",
"packages": [],
}
Pylock.from_dict(data)
@pytest.mark.parametrize("version", ["0.9", "2", "2.0", "2.1"])
def test_pylock_unsupported_version(version: str) -> None:
data = {
"lock-version": version,
"created-by": "pip",
"packages": [],
}
with pytest.raises(PylockUnsupportedVersionError):
Pylock.from_dict(data)
def test_pylock_invalid_version() -> None:
data = {
"lock-version": "2.x",
"created-by": "pip",
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == "Invalid version: '2.x' in 'lock-version'"
def test_pylock_unexpected_type() -> None:
data = {
"lock-version": 1.0,
"created-by": "pip",
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Unexpected type float (expected str) in 'lock-version'"
)
def test_pylock_missing_version() -> None:
data = {
"created-by": "pip",
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == "Missing required value in 'lock-version'"
def test_pylock_missing_created_by() -> None:
data = {
"lock-version": "1.0",
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == "Missing required value in 'created-by'"
def test_pylock_missing_packages() -> None:
data = {
"lock-version": "1.0",
"created-by": "uv",
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == "Missing required value in 'packages'"
def test_pylock_packages_without_dist() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [{"name": "example", "version": "1.0"}],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Exactly one of vcs, directory, archive must be set "
"if sdist and wheels are not set "
"in 'packages[0]'"
)
def test_pylock_packages_with_dist_and_archive() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "example",
"version": "1.0",
"archive": {
"path": "example.tar.gz",
"hashes": {"sha256": "f" * 40},
},
"sdist": {
"path": "example.tar.gz",
"hashes": {"sha256": "f" * 40},
},
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"None of vcs, directory, archive must be set "
"if sdist or wheels are set "
"in 'packages[0]'"
)
def test_pylock_packages_with_archive_directory_and_vcs() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "example",
"version": "1.0",
"archive": {
"path": "example.tar.gz",
"hashes": {"sha256": "f" * 40},
},
"vcs": {
"type": "git",
"url": "https://githhub/pypa/packaging",
"commit-id": "...",
},
"directory": {
"path": ".",
"editable": False,
},
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Exactly one of vcs, directory, archive must be set "
"if sdist and wheels are not set "
"in 'packages[0]'"
)
def test_pylock_basic_package() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"requires-python": ">=3.10",
"environments": ['os_name == "posix"'],
"packages": [
{
"name": "example",
"version": "1.0",
"marker": 'os_name == "posix"',
"requires-python": "!=3.10.1,>=3.10",
"directory": {
"path": ".",
"editable": False,
},
}
],
}
pylock = Pylock.from_dict(data)
assert pylock.environments == [Marker('os_name == "posix"')]
package = pylock.packages[0]
assert package.version == Version("1.0")
assert package.marker == Marker('os_name == "posix"')
assert package.requires_python == SpecifierSet(">=3.10, !=3.10.1")
assert pylock.to_dict() == data
def test_pylock_vcs_package() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "packaging",
"vcs": {
"type": "git",
"url": "https://githhub/pypa/packaging",
"commit-id": "...",
},
}
],
}
pylock = Pylock.from_dict(data)
assert pylock.to_dict() == data
def test_pylock_invalid_archive() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"requires-python": ">=3.10",
"environments": ['os_name == "posix"'],
"packages": [
{
"name": "example",
"archive": {
# "path": "example.tar.gz",
"hashes": {"sha256": "f" * 40},
},
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"path or url must be provided in 'packages[0].archive'"
)
def test_pylock_invalid_vcs() -> None:
with pytest.raises(PylockValidationError) as exc_info:
PackageVcs._from_dict({"type": "git", "commit-id": "f" * 40})
assert str(exc_info.value) == "path or url must be provided"
def test_pylock_invalid_wheel() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"requires-python": ">=3.10",
"environments": ['os_name == "posix"'],
"packages": [
{
"name": "example",
"wheels": [
{
"name": "example-1.0-py3-none-any.whl",
"path": "./example-1.0-py3-none-any.whl",
# Purposefully no "hashes" key.
}
],
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Missing required value in 'packages[0].wheels[0].hashes'"
)
def test_pylock_invalid_environments() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"environments": [
'os_name == "posix"',
'invalid_marker == "..."',
],
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Expected a marker variable or quoted string\n"
' invalid_marker == "..."\n'
" ^ "
"in 'environments[1]'"
)
def test_pylock_invalid_environments_type() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"environments": [
'os_name == "posix"',
1,
],
"packages": [],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Unexpected type int (expected str) in 'environments[1]'"
)
def test_pylock_extras_and_groups() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"extras": ["feat1", "feat2"],
"dependency-groups": ["dev", "docs"],
"default-groups": ["dev"],
"packages": [],
}
pylock = Pylock.from_dict(data)
assert pylock.extras == ["feat1", "feat2"]
assert pylock.dependency_groups == ["dev", "docs"]
assert pylock.default_groups == ["dev"]
def test_pylock_tool() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "example",
"sdist": {
"name": "example-1.0.tar.gz",
"path": "./example-1.0.tar.gz",
"upload-time": datetime.datetime(
2023, 10, 1, 0, 0, tzinfo=datetime.timezone.utc
),
"hashes": {"sha256": "f" * 40},
},
"tool": {"pip": {"foo": "bar"}},
}
],
"tool": {"pip": {"version": "25.2"}},
}
pylock = Pylock.from_dict(data)
assert pylock.tool == {"pip": {"version": "25.2"}}
package = pylock.packages[0]
assert package.tool == {"pip": {"foo": "bar"}}
def test_pylock_package_not_a_table() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": ["example"],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Unexpected type str (expected Mapping) in 'packages[0]'"
)
@pytest.mark.parametrize(
("hashes", "expected_error"),
[
(
{
"sha256": "f" * 40,
"md5": 1,
},
"Hash values must be strings in 'hashes'",
),
(
{},
"At least one hash must be provided in 'hashes'",
),
(
"sha256:...",
"Unexpected type str (expected Mapping) in 'hashes'",
),
],
)
def test_hash_validation(hashes: dict[str, Any], expected_error: str) -> None:
with pytest.raises(PylockValidationError) as exc_info:
PackageWheel._from_dict(
dict(
name="example-1.0-py3-none-any.whl",
upload_time=None,
url="https://example.com/example-1.0-py3-none-any.whl",
path=None,
size=None,
hashes=hashes,
)
)
assert str(exc_info.value) == expected_error
def test_package_name_validation() -> None:
with pytest.raises(PylockValidationError) as exc_info:
Package._from_dict({"name": "Example"})
assert str(exc_info.value) == "Name 'Example' is not normalized in 'name'"
def test_extras_name_validation() -> None:
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(
{
"lock-version": "1.0",
"created-by": "pip",
"extras": ["extra", "Feature"],
"packages": [],
}
)
assert str(exc_info.value) == "Name 'Feature' is not normalized in 'extras[1]'"
def test_is_direct() -> None:
direct_package = Package(
name=NormalizedName("example"),
directory=PackageDirectory(path="."),
)
assert direct_package.is_direct
wheel_package = Package(
name=NormalizedName("example"),
wheels=[
PackageWheel(
url="https://example.com/example-1.0-py3-none-any.whl",
hashes={"sha256": "f" * 40},
)
],
)
assert not wheel_package.is_direct
def test_validate() -> None:
pylock = Pylock(
lock_version=Version("1.0"),
created_by="some_tool",
packages=[
Package(
name=NormalizedName("example-package"),
version=Version("1.0.0"),
wheels=[
PackageWheel(
url="https://example.com/example_package-1.0.0-py3-none-any.whl",
hashes={"sha256": "0fd.."},
)
],
)
],
)
pylock.validate() # Should not raise any exceptions
pylock = Pylock(
lock_version=Version("1.0"),
created_by="some_tool",
packages=[
Package(
name=NormalizedName("example_package"), # not normalized
version=Version("1.0.0"),
wheels=[
PackageWheel(
url="https://example.com/example_package-1.0.0-py3-none-any.whl",
hashes={"sha256": "0fd.."},
)
],
)
],
)
with pytest.raises(PylockValidationError) as exc_info:
pylock.validate()
assert (
str(exc_info.value)
== "Name 'example_package' is not normalized in 'packages[0].name'"
)
def test_validate_sequence_of_str() -> None:
pylock = Pylock(
lock_version=Version("1.0"),
created_by="some_tool",
packages=[],
dependency_groups="abc", # should be a sequence of str
)
with pytest.raises(PylockValidationError) as exc_info:
pylock.validate()
assert str(exc_info.value) == (
"Unexpected type str (expected Sequence) in 'dependency-groups'"
)
def test_validate_attestation_identity_missing_kind() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "example",
"version": "1.0",
"directory": {
"path": ".",
},
"attestation-identities": [
{
# missing "kind" field
"value": "some-value",
}
],
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Missing required value in 'packages[0].attestation-identities[0].kind'"
)
def test_validate_attestation_identity_invalid_kind() -> None:
data = {
"lock-version": "1.0",
"created-by": "pip",
"packages": [
{
"name": "example",
"version": "1.0",
"directory": {
"path": ".",
},
"attestation-identities": [
{
"kind": 123,
"value": "some-value",
}
],
}
],
}
with pytest.raises(PylockValidationError) as exc_info:
Pylock.from_dict(data)
assert str(exc_info.value) == (
"Unexpected type int (expected str) "
"in 'packages[0].attestation-identities[0].kind'"
)
|