Skip to content

fix(sbom): preserve source version in upstream entry #1377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kocaemre wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(sbom): preserve source version in upstream entry #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/fromager/sbom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ def _build_upstream_purl(
"""Build the upstream source package URL.

If ``upstream`` is set in the per-package ``PurlConfig``, it is
used as-is. Otherwise, the upstream purl is derived from the same
base as the downstream purl but without the ``repository_url``
qualifier.
used as-is. Otherwise, the upstream purl uses the resolved source
version rather than a downstream wheel version override, and excludes
the ``repository_url`` qualifier.
"""
pc = pbi.purl_config
if pc and pc.upstream:
Expand All @@ -78,12 +78,11 @@ def _build_upstream_purl(
purl_type = pc.type if pc else None
purl_namespace = pc.namespace if pc else None
purl_name = pc.name if pc else None
purl_version = pc.version if pc else None
return PackageURL(
type=purl_type or sbom_settings.purl_type,
namespace=purl_namespace,
name=purl_name or name,
version=purl_version or str(version),
version=str(version),
)


Expand Down
27 changes: 27 additions & 0 deletions tests/test_sbom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,33 @@ def test_generate_sbom_document_identity_follows_purl_version_override(
_validate_spdx(doc)


def test_generate_sbom_upstream_uses_source_version_without_upstream_override(
tmp_path: pathlib.Path,
) -> None:
"""Keep the source release distinct from a locally versioned wheel."""
ctx = make_sbom_ctx(
tmp_path,
sbom_settings=SbomSettings(),
package_overrides={"purl": {"version": "0.5.5+local.1"}},
)
doc = sbom.generate_sbom(
ctx=ctx,
req=Requirement("test-pkg==0.5.5"),
version=Version("0.5.5"),
)

wheel, upstream = doc["packages"]
assert wheel["versionInfo"] == "0.5.5+local.1"
assert wheel["externalRefs"][0]["referenceLocator"] == (
"pkg:pypi/test-pkg@0.5.5%2Blocal.1"
)
assert upstream["versionInfo"] == "0.5.5"
assert upstream["externalRefs"][0]["referenceLocator"] == (
"pkg:pypi/test-pkg@0.5.5"
)
_validate_spdx(doc)


def test_generate_sbom_namespace_is_unique_per_document(
tmp_path: pathlib.Path,
) -> None:
Expand Down
Loading