Fix compile errors

justahero · justahero · commit a70ebeb69d2c · 2024-03-04T14:15:59.000+01:00
* ensure code compiles again, fixing all compile errors
* update tests

Signed-off-by: Sebastian Ziebell &lt;sebastian.ziebell@ferrous-systems.com&gt;
diff --git a/cargo-cyclonedx/src/generator.rs b/cargo-cyclonedx/src/generator.rs
@@ -714,8 +714,11 @@ impl GeneratedSbom {
         // If running in debug mode, validate that the SBOM is self-consistent and well-formed
         if cfg!(debug_assertions) {
             let result = bom.validate();
-            if let ValidationResult::Failed { reasons } = result {
-                panic!("The generated SBOM failed validation: {:?}", &reasons);
+            if result.has_errors() {
+                panic!(
+                    "The generated SBOM failed validation: {:?}",
+                    result.errors()
+                );
             }
         }
 
diff --git a/cargo-cyclonedx/src/purl.rs b/cargo-cyclonedx/src/purl.rs
@@ -1,7 +1,7 @@
 use std::str::FromStr;
 
 use cargo_metadata::{camino::Utf8Path, Package};
-use cyclonedx_bom::prelude::Purl as CdxPurl;
+use cyclonedx_bom::{external_models::uri::validate_purl, prelude::Purl as CdxPurl};
 use pathdiff::diff_utf8_paths;
 use purl::{PackageError, PackageType, PurlBuilder};
 
@@ -81,8 +81,7 @@ fn to_purl_subpath(path: &Utf8Path) -> String {
 }
 
 fn assert_validation_passes(purl: &CdxPurl) {
-    use cyclonedx_bom::validation::{Validate, ValidationResult};
-    assert_eq!(purl.validate(), ValidationResult::Passed);
+    assert!(validate_purl(purl).is_ok());
 }
 
 #[cfg(test)]
diff --git a/cyclonedx-bom/src/models/advisory.rs b/cyclonedx-bom/src/models/advisory.rs
@@ -101,7 +101,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "Advisory",
-                &[(
+                [(
                     0,
                     vec![
                         validation::field(
diff --git a/cyclonedx-bom/src/models/bom.rs b/cyclonedx-bom/src/models/bom.rs
@@ -574,7 +574,7 @@ mod test {
             actual.errors(),
             Some(validation::list(
                 "compositions",
-                &[(
+                [(
                     0,
                     vec![
                         validation::custom(
diff --git a/cyclonedx-bom/src/models/code.rs b/cyclonedx-bom/src/models/code.rs
@@ -318,7 +318,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     vec![
                         validation::field(
@@ -408,7 +408,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     vec![
                         validation::field("patch_type", "Unknown patch classification"),
@@ -429,7 +429,7 @@ mod test {
                         ),
                         validation::list(
                             "resolves",
-                            &[(
+                            [(
                                 0,
                                 vec![
                                     validation::field("issue_type", "Unknown issue classification"),
@@ -449,7 +449,7 @@ mod test {
                                             )
                                         ]
                                     ),
-                                    validation::list("references", &[(0, validation::field("inner", "Uri does not conform to RFC 3986"))])
+                                    validation::list("references", [(0, validation::field("inner", "Uri does not conform to RFC 3986"))])
                                 ]
                             )]
                         )
diff --git a/cyclonedx-bom/src/models/composition.rs b/cyclonedx-bom/src/models/composition.rs
@@ -135,7 +135,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "composition",
-                &[(
+                [(
                     0,
                     validation::r#field("aggregate", "Unknown aggregate type")
                 )]
diff --git a/cyclonedx-bom/src/models/external_reference.rs b/cyclonedx-bom/src/models/external_reference.rs
@@ -202,7 +202,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     validation::r#struct(
                         "ExternalReference",
@@ -214,7 +214,7 @@ mod test {
                             validation::field("url", "Uri does not conform to RFC 3986"),
                             validation::list(
                                 "hashes",
-                                &[(
+                                [(
                                     0,
                                     validation::field(
                                         "content",
diff --git a/cyclonedx-bom/src/models/hash.rs b/cyclonedx-bom/src/models/hash.rs
@@ -172,7 +172,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     vec![
                         validation::field("alg", "Unknown HashAlgorithm"),
diff --git a/cyclonedx-bom/src/models/license.rs b/cyclonedx-bom/src/models/license.rs
@@ -54,10 +54,10 @@ impl Validate for LicenseChoice {
 
         match self {
             LicenseChoice::License(license) => {
-                context.add_struct("license", license, version);
+                context = context.add_struct("license", license, version);
             }
             LicenseChoice::Expression(expression) => {
-                context.add_enum("expression", expression, validate_spdx_expression);
+                context = context.add_enum("expression", expression, validate_spdx_expression);
             }
         }
 
@@ -148,17 +148,15 @@ pub enum LicenseIdentifier {
 }
 
 impl Validate for LicenseIdentifier {
-    fn validate(&self, version: SpecVersion) -> ValidationResult {
-        let mut context = ValidationContext::new();
+    fn validate(&self, _version: SpecVersion) -> ValidationResult {
         match self {
-            LicenseIdentifier::Name(name) => {
-                context.add_enum("Name", name, validate_normalized_string);
-            }
-            LicenseIdentifier::SpdxId(id) => {
-                context.add_field("SpdxId", id, validate_spdx_identifier);
-            }
+            LicenseIdentifier::Name(name) => ValidationContext::new()
+                .add_enum("Name", name, validate_normalized_string)
+                .into(),
+            LicenseIdentifier::SpdxId(id) => ValidationContext::new()
+                .add_field("SpdxId", id, validate_spdx_identifier)
+                .into(),
         }
-        context.into()
     }
 }
 
diff --git a/cyclonedx-bom/src/models/property.rs b/cyclonedx-bom/src/models/property.rs
@@ -104,7 +104,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "Property",
-                &[(
+                [(
                     0,
                     validation::field(
                         "value",
diff --git a/cyclonedx-bom/src/models/tool.rs b/cyclonedx-bom/src/models/tool.rs
@@ -109,7 +109,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     validation::field(
                         "vendor",
@@ -148,22 +148,20 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[
-                    (
-                        1,
-                        validation::field(
-                            "vendor",
-                            "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"
-                        )
-                    ),
-                    (
-                        2,
-                        validation::field(
-                            "name",
-                            "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"
-                        )
+                [(
+                    1,
+                    validation::field(
+                        "vendor",
+                        "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"
                     )
-                ]
+                ),
+                (
+                    2,
+                    validation::field(
+                        "name",
+                        "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"
+                    )
+                )]
             ))
         );
     }
diff --git a/cyclonedx-bom/src/models/vulnerability_credits.rs b/cyclonedx-bom/src/models/vulnerability_credits.rs
@@ -89,7 +89,7 @@ mod test {
                 vec![
                     validation::list(
                         "organizations",
-                        &[(
+                        [(
                             0,
                             validation::field(
                                 "name",
@@ -98,7 +98,7 @@ mod test {
                         )]
                     ),validation::list(
                         "individuals",
-                        &[(0, validation::field("name", "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"))]
+                        [(0, validation::field("name", "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"))]
                     )
                 ]
                 .into()
diff --git a/cyclonedx-bom/src/models/vulnerability_rating.rs b/cyclonedx-bom/src/models/vulnerability_rating.rs
@@ -276,7 +276,7 @@ mod test {
             validation_result.errors(),
             Some(validation::list(
                 "inner",
-                &[(
+                [(
                     0,
                     validation::r#struct(
                         "vulnerability_source",

Original file line number	Diff line number	Diff line change
`@@ -714,8 +714,11 @@ impl GeneratedSbom {`
`714`	`714`	`// If running in debug mode, validate that the SBOM is self-consistent and well-formed`
`715`	`715`	`if cfg!(debug_assertions) {`
`716`	`716`	`let result = bom.validate();`
`717`		`- if let ValidationResult::Failed { reasons } = result {`
`718`		`- panic!("The generated SBOM failed validation: {:?}", &reasons);`
	`717`	`+ if result.has_errors() {`
	`718`	`+ panic!(`
	`719`	`+ "The generated SBOM failed validation: {:?}",`
	`720`	`+ result.errors()`
	`721`	`+ );`
`719`	`722`	`}`
`720`	`723`	`}`
`721`	`724`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`use std::str::FromStr;`
`2`	`2`
`3`	`3`	`use cargo_metadata::{camino::Utf8Path, Package};`
`4`		`-use cyclonedx_bom::prelude::Purl as CdxPurl;`
	`4`	`+use cyclonedx_bom::{external_models::uri::validate_purl, prelude::Purl as CdxPurl};`
`5`	`5`	`use pathdiff::diff_utf8_paths;`
`6`	`6`	`use purl::{PackageError, PackageType, PurlBuilder};`
`7`	`7`
`@@ -81,8 +81,7 @@ fn to_purl_subpath(path: &Utf8Path) -> String {`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`fn assert_validation_passes(purl: &CdxPurl) {`
`84`		`- use cyclonedx_bom::validation::{Validate, ValidationResult};`
`85`		`- assert_eq!(purl.validate(), ValidationResult::Passed);`
	`84`	`+ assert!(validate_purl(purl).is_ok());`
`86`	`85`	`}`
`87`	`86`
`88`	`87`	`#[cfg(test)]`
Original file line number	Diff line number	Diff line change
`@@ -54,10 +54,10 @@ impl Validate for LicenseChoice {`
`54`	`54`
`55`	`55`	`match self {`
`56`	`56`	`LicenseChoice::License(license) => {`
`57`		`- context.add_struct("license", license, version);`
	`57`	`+ context = context.add_struct("license", license, version);`
`58`	`58`	`}`
`59`	`59`	`LicenseChoice::Expression(expression) => {`
`60`		`- context.add_enum("expression", expression, validate_spdx_expression);`
	`60`	`+ context = context.add_enum("expression", expression, validate_spdx_expression);`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`@@ -148,17 +148,15 @@ pub enum LicenseIdentifier {`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`impl Validate for LicenseIdentifier {`
`151`		`- fn validate(&self, version: SpecVersion) -> ValidationResult {`
`152`		`- let mut context = ValidationContext::new();`
	`151`	`+ fn validate(&self, _version: SpecVersion) -> ValidationResult {`
`153`	`152`	`match self {`
`154`		`- LicenseIdentifier::Name(name) => {`
`155`		`- context.add_enum("Name", name, validate_normalized_string);`
`156`		`- }`
`157`		`- LicenseIdentifier::SpdxId(id) => {`
`158`		`- context.add_field("SpdxId", id, validate_spdx_identifier);`
`159`		`- }`
	`153`	`+ LicenseIdentifier::Name(name) => ValidationContext::new()`
	`154`	`+ .add_enum("Name", name, validate_normalized_string)`
	`155`	`+ .into(),`
	`156`	`+ LicenseIdentifier::SpdxId(id) => ValidationContext::new()`
	`157`	`+ .add_field("SpdxId", id, validate_spdx_identifier)`
	`158`	`+ .into(),`
`160`	`159`	`}`
`161`		`- context.into()`
`162`	`160`	`}`
`163`	`161`	`}`
`164`	`162`