feat(spec1-5): add initial support for spec v1.5

This adds the new schemas, `SpecVersion` variables, and updates existing tests to use v1.5. The default `specVersion` set by `NewBOM` is now `SpecVersion1_5`. Signed-off-by: nscuro <nscuro@protonmail.com>
CycloneDX · Jun 24, 2023 · a069906 · a069906
1 parent 8c95b53
commit a069906
Show file tree

Hide file tree

Showing 12 changed files with 9,615 additions and 15 deletions.
diff --git a/cyclonedx.go b/cyclonedx.go
@@ -78,10 +78,10 @@ type BOM struct {
 
 func NewBOM() *BOM {
 	return &BOM{
-		JSONSchema:  jsonSchemas[SpecVersion1_4],
-		XMLNS:       xmlNamespaces[SpecVersion1_4],
+		JSONSchema:  jsonSchemas[SpecVersion1_5],
+		XMLNS:       xmlNamespaces[SpecVersion1_5],
 		BOMFormat:   BOMFormat,
-		SpecVersion: SpecVersion1_4,
+		SpecVersion: SpecVersion1_5,
 		Version:     1,
 	}
 }
@@ -477,6 +477,7 @@ const (
 	SpecVersion1_2                        // 1.2
 	SpecVersion1_3                        // 1.3
 	SpecVersion1_4                        // 1.4
+	SpecVersion1_5                        // 1.5
 )
 
 type SWID struct {

diff --git a/cyclonedx_json.go b/cyclonedx_json.go
@@ -56,4 +56,5 @@ var jsonSchemas = map[SpecVersion]string{
 	SpecVersion1_2: "http://cyclonedx.org/schema/bom-1.2.schema.json",
 	SpecVersion1_3: "http://cyclonedx.org/schema/bom-1.3.schema.json",
 	SpecVersion1_4: "http://cyclonedx.org/schema/bom-1.4.schema.json",
+	SpecVersion1_5: "http://cyclonedx.org/schema/bom-1.5.schema.json",
 }
diff --git a/cyclonedx_string.go b/cyclonedx_string.go
diff --git a/cyclonedx_xml.go b/cyclonedx_xml.go
@@ -196,4 +196,5 @@ var xmlNamespaces = map[SpecVersion]string{
 	SpecVersion1_2: "http://cyclonedx.org/schema/bom/1.2",
 	SpecVersion1_3: "http://cyclonedx.org/schema/bom/1.3",
 	SpecVersion1_4: "http://cyclonedx.org/schema/bom/1.4",
+	SpecVersion1_5: "http://cyclonedx.org/schema/bom/1.5",
 }
diff --git a/encode_test.go b/encode_test.go
@@ -50,9 +50,9 @@ func TestJsonBOMEncoder_SetPretty(t *testing.T) {
 	require.NoError(t, encoder.Encode(bom))
 
 	assert.Equal(t, `{
-  "$schema": "http://cyclonedx.org/schema/bom-1.4.schema.json",
+  "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
   "bomFormat": "CycloneDX",
-  "specVersion": "1.4",
+  "specVersion": "1.5",
   "version": 1,
   "metadata": {
     "authors": [
@@ -83,9 +83,9 @@ func TestJsonBOMEncoder_SetEscapeHTML_true(t *testing.T) {
 	require.NoError(t, encoder.Encode(bom))
 
 	assert.Equal(t, `{
-  "$schema": "http://cyclonedx.org/schema/bom-1.4.schema.json",
+  "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
   "bomFormat": "CycloneDX",
-  "specVersion": "1.4",
+  "specVersion": "1.5",
   "version": 1,
   "metadata": {
     "authors": [
@@ -116,9 +116,9 @@ func TestJsonBOMEncoder_SetEscapeHTML_false(t *testing.T) {
 	require.NoError(t, encoder.Encode(bom))
 
 	assert.Equal(t, `{
-  "$schema": "http://cyclonedx.org/schema/bom-1.4.schema.json",
+  "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
   "bomFormat": "CycloneDX",
-  "specVersion": "1.4",
+  "specVersion": "1.5",
   "version": 1,
   "metadata": {
     "authors": [
@@ -158,7 +158,7 @@ func TestXmlBOMEncoder_SetPretty(t *testing.T) {
 	require.NoError(t, encoder.Encode(bom))
 
 	assert.Equal(t, `<?xml version="1.0" encoding="UTF-8"?>
-<bom xmlns="http://cyclonedx.org/schema/bom/1.4" version="1">
+<bom xmlns="http://cyclonedx.org/schema/bom/1.5" version="1">
   <metadata>
     <authors>
       <author>
@@ -186,7 +186,7 @@ func TestJsonBOMEncoder_EncodeVersion(t *testing.T) {
 		require.ErrorContains(t, err, "not supported")
 	})
 
-	for _, version := range []SpecVersion{SpecVersion1_2, SpecVersion1_3, SpecVersion1_4} {
+	for _, version := range []SpecVersion{SpecVersion1_2, SpecVersion1_3, SpecVersion1_4, SpecVersion1_5} {
 		t.Run(version.String(), func(t *testing.T) {
 			// Read original BOM JSON
 			inputFile, err := os.Open("./testdata/valid-bom.json")
@@ -216,7 +216,7 @@ func TestJsonBOMEncoder_EncodeVersion(t *testing.T) {
 }
 
 func TestXmlBOMEncoder_EncodeVersion(t *testing.T) {
-	for _, version := range []SpecVersion{SpecVersion1_0, SpecVersion1_1, SpecVersion1_2, SpecVersion1_3, SpecVersion1_4} {
+	for _, version := range []SpecVersion{SpecVersion1_0, SpecVersion1_1, SpecVersion1_2, SpecVersion1_3, SpecVersion1_4, SpecVersion1_5} {
 		t.Run(version.String(), func(t *testing.T) {
 			// Read original BOM JSON
 			inputFile, err := os.Open("./testdata/valid-bom.xml")

diff --git a/example_test.go b/example_test.go
@@ -89,7 +89,7 @@ func Example_encode() {
 
 	// Output:
 	// <?xml version="1.0" encoding="UTF-8"?>
-	// <bom xmlns="http://cyclonedx.org/schema/bom/1.4" version="1">
+	// <bom xmlns="http://cyclonedx.org/schema/bom/1.5" version="1">
 	//   <metadata>
 	//     <component bom-ref="pkg:golang/acme-inc/acme-app@v1.0.0" type="application">
 	//       <name>ACME Application</name>