Skip to content

Commit 292ec5e

Browse files
authored
Merge pull request #1386 from kocaemre/fix/1383-source-purl-identity
fix(sbom): keep wheel purl settings out of upstream identity
2 parents d86e496 + 40cd10b commit 292ec5e

4 files changed

Lines changed: 59 additions & 18 deletions

File tree

‎docs/reference/config-reference.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ For example `flash_attn.yaml`.
2626

2727
.. autopydantic_model:: fromager.packagesettings.SbomSettings
2828

29+
SBOM upstream purls
30+
^^^^^^^^^^^^^^^^^^^
31+
32+
When ``purl.upstream`` is absent, the upstream SBOM entry identifies the
33+
resolved source as ``pkg:pypi/<package name>@<resolved version>``. The
34+
per-package ``purl.name``, ``purl.type``, and ``purl.namespace`` settings and
35+
the global ``sbom.purl_type`` setting affect the wheel entry only. Previously,
36+
those settings also changed the upstream entry. Set ``purl.upstream`` to the
37+
full source purl when the source is not the resolved PyPI package.
38+
2939
Source Resolver
3040
^^^^^^^^^^^^^^^
3141

‎src/fromager/packagesettings/_models.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class SbomSettings(pydantic.BaseModel):
120120
"""
121121

122122
purl_type: PurlType = "pypi"
123-
"""Default purl type for all packages (e.g. ``pypi``, ``generic``)"""
123+
"""Default purl type for wheel package entries (e.g. ``pypi``, ``generic``)"""
124124

125125
repository_url: AnyUrl | None = None
126126
"""Default purl ``repository_url`` qualifier for all packages
@@ -343,9 +343,10 @@ class PurlConfig(pydantic.BaseModel):
343343
GENERATED_FROM relationship. Used for packages sourced from
344344
GitHub/GitLab rather than PyPI.
345345
346-
When absent, the upstream purl keeps the downstream name, type, and
347-
namespace but uses the resolved source version instead of a local
348-
downstream version override. The ``repository_url`` qualifier is omitted.
346+
When absent, the upstream purl is ``pkg:pypi/<package name>@<resolved
347+
version>``. Wheel-only name, type, namespace, and version overrides and
348+
the global ``sbom.purl_type`` do not change it. For non-PyPI sources,
349+
set ``purl.upstream`` explicitly.
349350
"""
350351

351352

‎src/fromager/sbom.py‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,26 +76,21 @@ def _build_upstream_purl(
7676
name: NormalizedName,
7777
version: Version,
7878
pbi: PackageBuildInfo,
79-
sbom_settings: SbomSettings,
8079
) -> PackageURL:
8180
"""Build the upstream source package URL.
8281
8382
If ``upstream`` is set in the per-package ``PurlConfig``, it is
84-
used as-is. Otherwise, the upstream purl uses the resolved source
85-
version rather than a downstream wheel version override, and excludes
86-
the ``repository_url`` qualifier.
83+
used as-is. Otherwise, the source is identified by its resolved
84+
PyPI name and version, regardless of downstream wheel purl overrides.
8785
"""
8886
pc = pbi.purl_config
8987
if pc and pc.upstream:
9088
return PackageURL.from_string(pc.upstream)
9189

92-
purl_type = pc.type if pc else None
93-
purl_namespace = pc.namespace if pc else None
94-
purl_name = pc.name if pc else None
9590
return PackageURL(
96-
type=purl_type or sbom_settings.purl_type,
97-
namespace=purl_namespace,
98-
name=purl_name or name,
91+
type="pypi",
92+
namespace=None,
93+
name=name,
9994
version=str(version),
10095
)
10196

@@ -150,7 +145,6 @@ def generate_sbom(
150145
name=name,
151146
version=version,
152147
pbi=pbi,
153-
sbom_settings=sbom_settings,
154148
)
155149

156150
# Derive the document identity from the downstream purl so the

‎tests/test_sbom.py‎

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import uuid
66
from unittest.mock import patch
77

8+
import pytest
89
from conftest import make_sbom_ctx
910
from packaging.requirements import Requirement
1011
from packaging.version import Version
@@ -197,14 +198,49 @@ def test_generate_sbom_wheel_version_used_without_purl_override(
197198
assert wheel["externalRefs"][0]["referenceLocator"] == (
198199
"pkg:pypi/test-pkg@0.5.5%2Blocal.1"
199200
)
200-
# Upstream still identifies the resolved source release
201201
assert upstream["versionInfo"] == "0.5.5"
202202
assert upstream["externalRefs"][0]["referenceLocator"] == (
203203
"pkg:pypi/test-pkg@0.5.5"
204204
)
205205
_validate_spdx(doc)
206206

207207

208+
@pytest.mark.parametrize(
209+
("package_purl", "sbom_type", "expected_wheel"),
210+
[
211+
({"name": "test-pkg-corp"}, "pypi", "pkg:pypi/test-pkg-corp@0.5.5"),
212+
({"type": "generic"}, "pypi", "pkg:generic/test-pkg@0.5.5"),
213+
({"namespace": "acme"}, "pypi", "pkg:pypi/acme/test-pkg@0.5.5"),
214+
({}, "generic", "pkg:generic/test-pkg@0.5.5"),
215+
],
216+
)
217+
def test_generate_sbom_upstream_ignores_wheel_purl_overrides(
218+
tmp_path: pathlib.Path,
219+
package_purl: dict[str, str],
220+
sbom_type: str,
221+
expected_wheel: str,
222+
) -> None:
223+
"""Wheel-only purl settings must not rewrite the source identity."""
224+
ctx = make_sbom_ctx(
225+
tmp_path,
226+
sbom_settings=SbomSettings(purl_type=sbom_type),
227+
package_overrides={"purl": package_purl},
228+
)
229+
doc = sbom.generate_sbom(
230+
ctx=ctx,
231+
req=Requirement("test-pkg==0.5.5"),
232+
version=Version("0.5.5"),
233+
)
234+
235+
wheel, upstream = doc["packages"]
236+
assert wheel["externalRefs"][0]["referenceLocator"] == expected_wheel
237+
assert upstream["name"] == "test-pkg"
238+
assert upstream["externalRefs"][0]["referenceLocator"] == (
239+
"pkg:pypi/test-pkg@0.5.5"
240+
)
241+
_validate_spdx(doc)
242+
243+
208244
def test_generate_sbom_purl_version_override_wins_over_wheel_version(
209245
tmp_path: pathlib.Path,
210246
) -> None:
@@ -298,9 +334,9 @@ def test_generate_sbom_purl_field_overrides(tmp_path: pathlib.Path) -> None:
298334
assert wheel["externalRefs"][0]["referenceLocator"] == (
299335
"pkg:generic/custom-name@1.0.0"
300336
)
301-
# Field overrides carry through to upstream (without qualifiers)
337+
# Wheel field overrides must not change the resolved source identity.
302338
assert upstream["externalRefs"][0]["referenceLocator"] == (
303-
"pkg:generic/custom-name@1.0.0"
339+
"pkg:pypi/test-pkg@1.0.0"
304340
)
305341
# Document identity follows the purl name override
306342
assert doc["name"] == "custom-name-1.0.0"

0 commit comments

Comments
 (0)