Merge pull request #709 from justahero/add-external-references-tool-type

Add 'external_references' to Tool
CycloneDX · May 16, 2024 · 3d50ddd · 3d50ddd
2 parents 7487eb7 + acb5dc2
commit 3d50ddd
Show file tree

Hide file tree

Showing 16 changed files with 315 additions and 3 deletions.
diff --git a/cyclonedx-bom/src/models/metadata.rs b/cyclonedx-bom/src/models/metadata.rs
@@ -125,6 +125,7 @@ mod test {
                 name: None,
                 version: None,
                 hashes: None,
+                external_references: None,
             }])),
             authors: Some(vec![OrganizationalContact {
                 bom_ref: None,
@@ -195,6 +196,7 @@ mod test {
                 name: None,
                 version: None,
                 hashes: None,
+                external_references: None,
             }])),
             authors: Some(vec![OrganizationalContact {
                 bom_ref: None,

diff --git a/cyclonedx-bom/src/models/tool.rs b/cyclonedx-bom/src/models/tool.rs
@@ -22,6 +22,7 @@ use crate::validation::{Validate, ValidationContext, ValidationResult};
 
 use super::bom::SpecVersion;
 use super::component::Components;
+use super::external_reference::ExternalReferences;
 use super::service::Services;
 
 /// Defines the creation tool(s)
@@ -80,6 +81,8 @@ pub struct Tool {
     pub name: Option<NormalizedString>,
     pub version: Option<NormalizedString>,
     pub hashes: Option<Hashes>,
+    /// Added in spec version 1.4
+    pub external_references: Option<ExternalReferences>,
 }
 
 impl Tool {
@@ -95,6 +98,7 @@ impl Tool {
             name: Some(NormalizedString::new(name)),
             version: Some(NormalizedString::new(version)),
             hashes: None,
+            external_references: None,
         }
     }
 }
@@ -108,6 +112,11 @@ impl Validate for Tool {
             .add_list("hashes", &self.hashes, |hashes| {
                 hashes.validate_version(version)
             })
+            .add_struct_option(
+                "external_references",
+                self.external_references.as_ref(),
+                version,
+            )
             .into()
     }
 }
@@ -134,6 +143,7 @@ mod test {
             name: None,
             version: None,
             hashes: None,
+            external_references: None,
         }])
         .validate();
 
@@ -147,6 +157,7 @@ mod test {
             name: None,
             version: None,
             hashes: None,
+            external_references: None,
         }])
         .validate();
 
@@ -173,18 +184,21 @@ mod test {
                 name: None,
                 version: None,
                 hashes: None,
+                external_references: None,
             },
             Tool {
                 vendor: Some(NormalizedString("spaces and\ttabs".to_string())),
                 name: None,
                 version: None,
                 hashes: None,
+                external_references: None,
             },
             Tool {
                 vendor: None,
                 name: Some(NormalizedString("spaces and\ttabs".to_string())),
                 version: None,
                 hashes: None,
+                external_references: None,
             },
         ])
         .validate();

diff --git a/cyclonedx-bom/src/specs/common/bom.rs b/cyclonedx-bom/src/specs/common/bom.rs
@@ -1023,6 +1023,15 @@ pub(crate) mod base {
         <hashes>
           <hash alg="algorithm">hash value</hash>
         </hashes>
+        <externalReferences>
+          <reference type="external reference type">
+            <url>url</url>
+            <comment>comment</comment>
+            <hashes>
+              <hash alg="algorithm">hash value</hash>
+            </hashes>
+          </reference>
+        </externalReferences>
       </tool>
     </tools>
     <authors>
@@ -1414,6 +1423,15 @@ pub(crate) mod base {
           <hashes>
             <hash alg="algorithm">hash value</hash>
           </hashes>
+          <externalReferences>
+            <reference type="external reference type">
+              <url>url</url>
+              <comment>comment</comment>
+              <hashes>
+                <hash alg="algorithm">hash value</hash>
+              </hashes>
+            </reference>
+          </externalReferences>
         </tool>
       </tools>
       <analysis>
@@ -1467,6 +1485,15 @@ pub(crate) mod base {
         <hashes>
           <hash alg="algorithm">hash value</hash>
         </hashes>
+        <externalReferences>
+          <reference type="external reference type">
+            <url>url</url>
+            <comment>comment</comment>
+            <hashes>
+              <hash alg="algorithm">hash value</hash>
+            </hashes>
+          </reference>
+        </externalReferences>
       </tool>
     </tools>
     <authors>
@@ -2091,6 +2118,15 @@ pub(crate) mod base {
           <hashes>
             <hash alg="algorithm">hash value</hash>
           </hashes>
+          <externalReferences>
+            <reference type="external reference type">
+              <url>url</url>
+              <comment>comment</comment>
+              <hashes>
+                <hash alg="algorithm">hash value</hash>
+              </hashes>
+            </reference>
+          </externalReferences>
         </tool>
       </tools>
       <analysis>

diff --git a/cyclonedx-bom/src/specs/common/metadata.rs b/cyclonedx-bom/src/specs/common/metadata.rs
@@ -546,6 +546,15 @@ pub(crate) mod base {
       <hashes>
         <hash alg="algorithm">hash value</hash>
       </hashes>
+      <externalReferences>
+        <reference type="external reference type">
+          <url>url</url>
+          <comment>comment</comment>
+          <hashes>
+            <hash alg="algorithm">hash value</hash>
+          </hashes>
+        </reference>
+      </externalReferences>
     </tool>
   </tools>
   <authors>
@@ -695,6 +704,15 @@ pub(crate) mod base {
       <hashes>
         <hash alg="algorithm">hash value</hash>
       </hashes>
+      <externalReferences>
+        <reference type="external reference type">
+          <url>url</url>
+          <comment>comment</comment>
+          <hashes>
+            <hash alg="algorithm">hash value</hash>
+          </hashes>
+        </reference>
+      </externalReferences>
     </tool>
   </tools>
   <authors>

diff --git a/...x_bom__specs__common__bom__v1_4__test__it_should_serialize_a_complex_example_to_json.snap b/...x_bom__specs__common__bom__v1_4__test__it_should_serialize_a_complex_example_to_json.snap
@@ -1,6 +1,6 @@
 ---
 source: cyclonedx-bom/src/specs/common/bom.rs
-assertion_line: 606
+assertion_line: 654
 expression: actual
 ---
 {
@@ -20,6 +20,19 @@ expression: actual
             "alg": "algorithm",
             "content": "hash value"
           }
+        ],
+        "externalReferences": [
+          {
+            "type": "external reference type",
+            "url": "url",
+            "comment": "comment",
+            "hashes": [
+              {
+                "alg": "algorithm",
+                "content": "hash value"
+              }
+            ]
+          }
         ]
       }
     ],
@@ -529,6 +542,19 @@ expression: actual
               "alg": "algorithm",
               "content": "hash value"
             }
+          ],
+          "externalReferences": [
+            {
+              "type": "external reference type",
+              "url": "url",
+              "comment": "comment",
+              "hashes": [
+                {
+                  "alg": "algorithm",
+                  "content": "hash value"
+                }
+              ]
+            }
           ]
         }
       ],

diff --git a/...dx_bom__specs__common__bom__v1_4__test__it_should_serialize_a_complex_example_to_xml.snap b/...dx_bom__specs__common__bom__v1_4__test__it_should_serialize_a_complex_example_to_xml.snap
@@ -1,6 +1,6 @@
 ---
 source: cyclonedx-bom/src/specs/common/bom.rs
-assertion_line: 598
+assertion_line: 660
 expression: xml_output
 ---
 <?xml version="1.0" encoding="utf-8"?>
@@ -15,6 +15,15 @@ expression: xml_output
         <hashes>
           <hash alg="algorithm">hash value</hash>
         </hashes>
+        <externalReferences>
+          <reference type="external reference type">
+            <url>url</url>
+            <comment>comment</comment>
+            <hashes>
+              <hash alg="algorithm">hash value</hash>
+            </hashes>
+          </reference>
+        </externalReferences>
       </tool>
     </tools>
     <authors>
@@ -403,6 +412,15 @@ expression: xml_output
           <hashes>
             <hash alg="algorithm">hash value</hash>
           </hashes>
+          <externalReferences>
+            <reference type="external reference type">
+              <url>url</url>
+              <comment>comment</comment>
+              <hashes>
+                <hash alg="algorithm">hash value</hash>
+              </hashes>
+            </reference>
+          </externalReferences>
         </tool>
       </tools>
       <analysis>

diff --git a/...x_bom__specs__common__bom__v1_5__test__it_should_serialize_a_complex_example_to_json.snap b/...x_bom__specs__common__bom__v1_5__test__it_should_serialize_a_complex_example_to_json.snap
@@ -1,5 +1,6 @@
 ---
 source: cyclonedx-bom/src/specs/common/bom.rs
+assertion_line: 654
 expression: actual
 ---
 {
@@ -19,6 +20,19 @@ expression: actual
             "alg": "algorithm",
             "content": "hash value"
           }
+        ],
+        "externalReferences": [
+          {
+            "type": "external reference type",
+            "url": "url",
+            "comment": "comment",
+            "hashes": [
+              {
+                "alg": "algorithm",
+                "content": "hash value"
+              }
+            ]
+          }
         ]
       }
     ],
@@ -782,6 +796,19 @@ expression: actual
               "alg": "algorithm",
               "content": "hash value"
             }
+          ],
+          "externalReferences": [
+            {
+              "type": "external reference type",
+              "url": "url",
+              "comment": "comment",
+              "hashes": [
+                {
+                  "alg": "algorithm",
+                  "content": "hash value"
+                }
+              ]
+            }
           ]
         }
       ],

diff --git a/...dx_bom__specs__common__bom__v1_5__test__it_should_serialize_a_complex_example_to_xml.snap b/...dx_bom__specs__common__bom__v1_5__test__it_should_serialize_a_complex_example_to_xml.snap
@@ -1,5 +1,6 @@
 ---
 source: cyclonedx-bom/src/specs/common/bom.rs
+assertion_line: 660
 expression: xml_output
 ---
 <?xml version="1.0" encoding="utf-8"?>
@@ -14,6 +15,15 @@ expression: xml_output
         <hashes>
           <hash alg="algorithm">hash value</hash>
         </hashes>
+        <externalReferences>
+          <reference type="external reference type">
+            <url>url</url>
+            <comment>comment</comment>
+            <hashes>
+              <hash alg="algorithm">hash value</hash>
+            </hashes>
+          </reference>
+        </externalReferences>
       </tool>
     </tools>
     <authors>
@@ -568,6 +578,15 @@ expression: xml_output
           <hashes>
             <hash alg="algorithm">hash value</hash>
           </hashes>
+          <externalReferences>
+            <reference type="external reference type">
+              <url>url</url>
+              <comment>comment</comment>
+              <hashes>
+                <hash alg="algorithm">hash value</hash>
+              </hashes>
+            </reference>
+          </externalReferences>
         </tool>
       </tools>
       <analysis>

diff --git a/...apshots/cyclonedx_bom__specs__common__metadata__v1_4__test__it_should_write_xml_full.snap b/...apshots/cyclonedx_bom__specs__common__metadata__v1_4__test__it_should_write_xml_full.snap
@@ -1,5 +1,6 @@
 ---
 source: cyclonedx-bom/src/specs/common/metadata.rs
+assertion_line: 387
 expression: xml_output
 ---
 <?xml version="1.0" encoding="utf-8"?>
@@ -13,6 +14,15 @@ expression: xml_output
       <hashes>
         <hash alg="algorithm">hash value</hash>
       </hashes>
+      <externalReferences>
+        <reference type="external reference type">
+          <url>url</url>
+          <comment>comment</comment>
+          <hashes>
+            <hash alg="algorithm">hash value</hash>
+          </hashes>
+        </reference>
+      </externalReferences>
     </tool>
   </tools>
   <authors>