-
Notifications
You must be signed in to change notification settings - Fork 603
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add cyclonedx schema version selection (#2123)
--------- Signed-off-by: Christopher Phillips <[email protected]>
- Loading branch information
Showing
11 changed files
with
274 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package cyclonedxjson | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/CycloneDX/cyclonedx-go" | ||
| ) | ||
|
|
||
| func TestFormatVersions(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| expectedVersion string | ||
| }{ | ||
| { | ||
|
|
||
| "cyclonedx-json should default to v1.4", | ||
| cyclonedx.SpecVersion1_4.String(), | ||
| }, | ||
| } | ||
|
|
||
| for _, c := range tests { | ||
| c := c | ||
| t.Run(c.name, func(t *testing.T) { | ||
| sbomFormat := Format() | ||
| if sbomFormat.ID() != ID { | ||
| t.Errorf("expected ID %q, got %q", ID, sbomFormat.ID()) | ||
| } | ||
|
|
||
| if sbomFormat.Version() != c.expectedVersion { | ||
| t.Errorf("expected version %q, got %q", c.expectedVersion, sbomFormat.Version()) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,17 +26,27 @@ import ( | |
| func Formats() []sbom.Format { | ||
| return []sbom.Format{ | ||
| syftjson.Format(), | ||
| cyclonedxxml.Format(), | ||
| cyclonedxjson.Format(), | ||
| github.Format(), | ||
| table.Format(), | ||
| text.Format(), | ||
| template.Format(), | ||
| cyclonedxxml.Format1_0(), | ||
| cyclonedxxml.Format1_1(), | ||
| cyclonedxxml.Format1_2(), | ||
| cyclonedxxml.Format1_3(), | ||
| cyclonedxxml.Format1_4(), | ||
| cyclonedxxml.Format1_5(), | ||
| cyclonedxjson.Format1_0(), | ||
| cyclonedxjson.Format1_1(), | ||
| cyclonedxjson.Format1_2(), | ||
| cyclonedxjson.Format1_3(), | ||
| cyclonedxjson.Format1_4(), | ||
| cyclonedxjson.Format1_5(), | ||
| spdxtagvalue.Format2_1(), | ||
| spdxtagvalue.Format2_2(), | ||
| spdxtagvalue.Format2_3(), | ||
| spdxjson.Format2_2(), | ||
| spdxjson.Format2_3(), | ||
| table.Format(), | ||
| text.Format(), | ||
| template.Format(), | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -55,7 +65,7 @@ func Identify(by []byte) sbom.Format { | |
|
|
||
| // ByName accepts a name@version string, such as: | ||
| // | ||
| // [email protected] or cyclonedx@2 | ||
| // [email protected] or cyclonedx@1.5 | ||
| func ByName(name string) sbom.Format { | ||
| parts := strings.SplitN(name, "@", 2) | ||
| version := sbom.AnyVersion | ||
|
|
@@ -71,6 +81,16 @@ func ByNameAndVersion(name string, version string) sbom.Format { | |
| for _, f := range Formats() { | ||
| for _, n := range f.IDs() { | ||
| if cleanFormatName(string(n)) == name && versionMatches(f.Version(), version) { | ||
| // if the version is not specified and the format is cyclonedx, then we want to return the most recent version up to 1.4 | ||
| // If more aliases like cdx are added this will not catch those - we want to eventually provide a way for | ||
| // formats to inform this function what their default version is | ||
| // TODO: remove this check when 1.5 is stable or default formats are designed. PR below should be merged. | ||
| // https://github.com/CycloneDX/cyclonedx-go/pull/90 | ||
| if version == sbom.AnyVersion && strings.Contains(string(n), "cyclone") { | ||
| if f.Version() == "1.5" { | ||
| continue | ||
| } | ||
| } | ||
| if mostRecentFormat == nil || f.Version() > mostRecentFormat.Version() { | ||
| mostRecentFormat = f | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package syftjson | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/anchore/syft/internal" | ||
| ) | ||
|
|
||
| func TestFormat(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| version string | ||
| }{ | ||
| { | ||
| name: "default version should use latest internal version", | ||
| version: "", | ||
| }, | ||
| } | ||
|
|
||
| for _, c := range tests { | ||
| c := c | ||
| t.Run(c.name, func(t *testing.T) { | ||
| sbomFormat := Format() | ||
| if sbomFormat.ID() != ID { | ||
| t.Errorf("expected ID %q, got %q", ID, sbomFormat.ID()) | ||
| } | ||
|
|
||
| if sbomFormat.Version() != internal.JSONSchemaVersion { | ||
| t.Errorf("expected version %q, got %q", c.version, sbomFormat.Version()) | ||
| } | ||
| }) | ||
| } | ||
| } |