mirror of
https://github.com/anchore/syft.git
synced 2026-10-30 14:02:26 +01:00
Antoni (Tony) JagodkaandAlex Goodman
e4ff7f5973
* fix(spdx): write a name for the root package when the source has none
A source read from another SBOM (a purl list, a CycloneDX document
without metadata.component, an SPDX document without a DESCRIBES
relationship) can have no name. The SPDX encoder then wrote the document
root package with an empty PackageName, which SPDX requires. In
tag-value output the PackageName line is omitted, so the root package's
fields land in the previous section and syft cannot read its own output
back ("received unknown tag SPDXID in CreationInfo section").
Fall back to the document name for the root package, and make the
document name fall back to "unknown" for every source type rather than
only for unrecognized ones.
Signed-off-by: Tony <tjagodka@gmail.com>
* fix(spdx): drop syft's root package on decode for every SPDX version
- the root package name now comes from one fallback chain (source name, image repo name, source ID, document name), so the root purl no longer gets an empty name for a source decoded from CycloneDX
- decoding strips the root syft writes for an unknown source, so `syft convert` round trips stop adding an `unknown` package each pass
- for SPDX 2.1 and 2.2, which have no `primaryPackagePurpose`, the purpose is taken from the source type in syft's `DocumentRoot-<type>-` ID
**behavior change:** decoding a syft-written SPDX 2.1/2.2 document no longer returns the root as a package or its `CONTAINS` relationships, matching 2.3.
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
---------
Signed-off-by: Tony <tjagodka@gmail.com>
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
Co-authored-by: Alex Goodman <wagoodman@users.noreply.github.com>
97 lines
2.1 KiB
Go
97 lines
2.1 KiB
Go
package helpers
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/anchore/syft/internal/sourcemetadata"
|
|
"github.com/anchore/syft/syft/source"
|
|
)
|
|
|
|
func Test_DocumentName(t *testing.T) {
|
|
|
|
tracker := sourcemetadata.NewCompletionTester(t)
|
|
|
|
tests := []struct {
|
|
name string
|
|
srcMetadata source.Description
|
|
expected string
|
|
}{
|
|
{
|
|
name: "image",
|
|
srcMetadata: source.Description{
|
|
Metadata: source.ImageMetadata{
|
|
UserInput: "image-repo/name:tag",
|
|
ID: "id",
|
|
ManifestDigest: "digest",
|
|
},
|
|
},
|
|
expected: "image-repo/name:tag",
|
|
},
|
|
{
|
|
name: "directory",
|
|
srcMetadata: source.Description{
|
|
Metadata: source.DirectoryMetadata{Path: "some/path/to/place"},
|
|
},
|
|
expected: "some/path/to/place",
|
|
},
|
|
{
|
|
name: "file",
|
|
srcMetadata: source.Description{
|
|
Metadata: source.FileMetadata{Path: "some/path/to/place"},
|
|
},
|
|
expected: "some/path/to/place",
|
|
},
|
|
{
|
|
name: "snap",
|
|
srcMetadata: source.Description{
|
|
Name: "some/name",
|
|
// there is nothing in the snap metadata that indicates a name
|
|
Metadata: source.SnapMetadata{},
|
|
},
|
|
expected: "some/name",
|
|
},
|
|
{
|
|
name: "oci-model",
|
|
srcMetadata: source.Description{
|
|
Metadata: source.OCIModelMetadata{
|
|
UserInput: "model-repo/name:tag",
|
|
ID: "id",
|
|
ManifestDigest: "digest",
|
|
},
|
|
},
|
|
expected: "model-repo/name:tag",
|
|
},
|
|
{
|
|
name: "named",
|
|
srcMetadata: source.Description{
|
|
Name: "some/name",
|
|
Metadata: source.FileMetadata{Path: "some/path/to/place"},
|
|
},
|
|
expected: "some/name",
|
|
},
|
|
{
|
|
name: "no name or metadata",
|
|
srcMetadata: source.Description{},
|
|
expected: "unknown",
|
|
},
|
|
{
|
|
name: "metadata without a name",
|
|
srcMetadata: source.Description{
|
|
Metadata: source.ImageMetadata{},
|
|
},
|
|
expected: "unknown",
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
actual := DocumentName(test.srcMetadata)
|
|
assert.Equal(t, test.expected, actual)
|
|
|
|
// track each scheme tested (passed or not)
|
|
tracker.Tested(t, test.srcMetadata.Metadata)
|
|
})
|
|
}
|
|
}
|