|
1 | 1 | import json |
2 | 2 | import pathlib |
| 3 | +import re |
3 | 4 | import typing |
4 | 5 | import uuid |
5 | 6 | from unittest.mock import patch |
@@ -391,14 +392,97 @@ def test_generate_sbom_relationships(tmp_path: pathlib.Path) -> None: |
391 | 392 | version=Version("0.1.0"), |
392 | 393 | ) |
393 | 394 |
|
| 395 | + wheel_id, upstream_id = (p["SPDXID"] for p in doc["packages"]) |
394 | 396 | rels = doc["relationships"] |
395 | 397 | assert len(rels) == 2 |
396 | 398 | assert rels[0]["spdxElementId"] == "SPDXRef-DOCUMENT" |
397 | 399 | assert rels[0]["relationshipType"] == "DESCRIBES" |
398 | | - assert rels[0]["relatedSpdxElement"] == "SPDXRef-wheel" |
399 | | - assert rels[1]["spdxElementId"] == "SPDXRef-wheel" |
| 400 | + assert rels[0]["relatedSpdxElement"] == wheel_id |
| 401 | + assert rels[1]["spdxElementId"] == wheel_id |
400 | 402 | assert rels[1]["relationshipType"] == "GENERATED_FROM" |
401 | | - assert rels[1]["relatedSpdxElement"] == "SPDXRef-upstream" |
| 403 | + assert rels[1]["relatedSpdxElement"] == upstream_id |
| 404 | + _validate_spdx(doc) |
| 405 | + |
| 406 | + |
| 407 | +def test_generate_sbom_spdx_ids_name_package_and_document( |
| 408 | + tmp_path: pathlib.Path, |
| 409 | +) -> None: |
| 410 | + """Verify package SPDX ids carry name, version, and a document suffix.""" |
| 411 | + ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings()) |
| 412 | + fixed_uuid = uuid.UUID("12345678-1234-5678-1234-567812345678") |
| 413 | + with patch("fromager.sbom.uuid.uuid4", return_value=fixed_uuid): |
| 414 | + doc = sbom.generate_sbom( |
| 415 | + ctx=ctx, |
| 416 | + req=Requirement("test==0.1.0"), |
| 417 | + version=Version("0.1.0"), |
| 418 | + ) |
| 419 | + |
| 420 | + assert [p["SPDXID"] for p in doc["packages"]] == [ |
| 421 | + "SPDXRef-wheel-test-0.1.0-12345678", |
| 422 | + "SPDXRef-upstream-test-0.1.0-12345678", |
| 423 | + ] |
| 424 | + _validate_spdx(doc) |
| 425 | + |
| 426 | + |
| 427 | +def test_generate_sbom_spdx_ids_differ_between_packages( |
| 428 | + tmp_path: pathlib.Path, |
| 429 | +) -> None: |
| 430 | + """Verify SBOMs of different wheels share no package SPDX ids. |
| 431 | +
|
| 432 | + Tools such as syft merge packages from several SBOMs by SPDX id, so |
| 433 | + shared ids would attribute one wheel's data to another. Both documents |
| 434 | + get the same UUID so only the name and version can keep the ids apart. |
| 435 | + """ |
| 436 | + ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings()) |
| 437 | + fixed_uuid = uuid.UUID("12345678-1234-5678-1234-567812345678") |
| 438 | + with patch("fromager.sbom.uuid.uuid4", return_value=fixed_uuid): |
| 439 | + docs = [ |
| 440 | + sbom.generate_sbom(ctx=ctx, req=Requirement(req), version=Version(ver)) |
| 441 | + for req, ver in [("idna==3.6", "3.6"), ("packaging==26.3", "26.3")] |
| 442 | + ] |
| 443 | + |
| 444 | + ids = [{p["SPDXID"] for p in doc["packages"]} for doc in docs] |
| 445 | + assert ids[0].isdisjoint(ids[1]) |
| 446 | + |
| 447 | + |
| 448 | +def test_generate_sbom_spdx_ids_differ_between_documents( |
| 449 | + tmp_path: pathlib.Path, |
| 450 | +) -> None: |
| 451 | + """Verify two SBOMs of the same package share no package SPDX ids. |
| 452 | +
|
| 453 | + Two builds of one version (e.g. for different variants) can carry |
| 454 | + different data; shared ids would let tools merge them into one package. |
| 455 | + """ |
| 456 | + ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings()) |
| 457 | + docs = [ |
| 458 | + sbom.generate_sbom( |
| 459 | + ctx=ctx, req=Requirement("idna==3.6"), version=Version("3.6") |
| 460 | + ) |
| 461 | + for _ in range(2) |
| 462 | + ] |
| 463 | + |
| 464 | + ids = [{p["SPDXID"] for p in doc["packages"]} for doc in docs] |
| 465 | + assert ids[0].isdisjoint(ids[1]) |
| 466 | + |
| 467 | + |
| 468 | +def test_generate_sbom_spdx_ids_are_sanitized(tmp_path: pathlib.Path) -> None: |
| 469 | + """Verify characters SPDX ids do not allow are replaced.""" |
| 470 | + ctx = make_sbom_ctx( |
| 471 | + tmp_path, |
| 472 | + sbom_settings=SbomSettings(), |
| 473 | + package_overrides={"purl": {"version": "0.5.5+local.1"}}, |
| 474 | + ) |
| 475 | + doc = sbom.generate_sbom( |
| 476 | + ctx=ctx, |
| 477 | + req=Requirement("test-pkg==0.5.5"), |
| 478 | + version=Version("0.5.5"), |
| 479 | + ) |
| 480 | + |
| 481 | + wheel_id, upstream_id = (p["SPDXID"] for p in doc["packages"]) |
| 482 | + assert re.fullmatch( |
| 483 | + r"SPDXRef-wheel-test-pkg-0\.5\.5-local\.1-[0-9a-f]{8}", wheel_id |
| 484 | + ) |
| 485 | + assert re.fullmatch(r"SPDXRef-upstream-test-pkg-0\.5\.5-[0-9a-f]{8}", upstream_id) |
402 | 486 | _validate_spdx(doc) |
403 | 487 |
|
404 | 488 |
|
|
0 commit comments