More common 2.0/2.1 validation code

Author: oxisto

Cargo.lock

@@ -8,7 +8,6 @@ regress = "0.10.1"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 chrono = { version = "0.4.38", features = ["serde"] }
-lazy_static = "1.5.0"
 
 [build-dependencies]
 schemars = "0.8.21"

csaf

@@ -1,6 +1,6 @@
-use std::{fs::File, io::BufReader};
-
 use super::schema::CommonSecurityAdvisoryFramework;
+use crate::csaf::validation::Validatable;
+use std::{fs::File, io::BufReader};
 
 pub fn load_document(path: &str) -> std::io::Result<CommonSecurityAdvisoryFramework> {
     println!("Trying to load document {}", path);

csaf-lib/Cargo.toml

@@ -1,29 +1,28 @@
 use super::product_helper::*;
 use super::schema::CommonSecurityAdvisoryFramework;
-use crate::csaf::validation::{Validate, ValidationProfile};
+use crate::csaf::validation::{Test, Validatable, Validate, ValidationProfile};
 use std::collections::{HashMap, HashSet};
+use crate::csaf::helpers::find_duplicates;
+
+impl Validatable<CommonSecurityAdvisoryFramework> for CommonSecurityAdvisoryFramework {
+    fn profiles(&self) -> HashMap<ValidationProfile, Vec<&str>> {
+        HashMap::from([
+            (ValidationProfile::Basic, Vec::from(["6.1.1", "6.1.2"])),
+            (ValidationProfile::Extended, Vec::from(["6.1.1", "6.1.2"])),
+            (ValidationProfile::Full, Vec::from(["6.1.1", "6.1.2"])),
+        ])
+    }
 
-impl Validate for CommonSecurityAdvisoryFramework {
-    fn validate_profile(&self, profile: ValidationProfile) {
-        println!("Validating document... \n");
-
-        println!("Executing Test 6.1.1... ");
-
-        let _ = match test_6_01_01_missing_definition_of_product_id(self) {
-            Ok(()) => println!("> Test Success"),
-            Err(e) => println!("> Error: {}", e),
-        };
-
-        println!("Executing Test 6.1.2... ");
-
-        let _ = match test_6_01_02_multiple_definition_of_product_id(self) {
-            Ok(()) => println!("> Test Success"),
-            Err(e) => println!("> Error: {}", e),
-        };
+    fn tests(&self) -> HashMap<&str, Test<CommonSecurityAdvisoryFramework>> {
+        HashMap::<&str, Test<CommonSecurityAdvisoryFramework>>::from([
+            ("6.1.1", test_6_01_01_missing_definition_of_product_id),
+            ("6.1.2", test_6_01_02_multiple_definition_of_product_id),
+        ]
+            as [(&str, Test<CommonSecurityAdvisoryFramework>); 2])
     }
 
-    fn validate_by_test(&self, version: &str) {
-        todo!()
+    fn doc(&self) -> &CommonSecurityAdvisoryFramework {
+        self
     }
 }
 
@@ -56,24 +55,6 @@ pub fn test_6_01_02_multiple_definition_of_product_id(
     }
 }
 
-fn find_duplicates<T: std::hash::Hash + Eq + Clone>(vec: Vec<T>) -> Vec<T> {
-    let mut occurrences = HashMap::new();
-    let mut duplicates = Vec::new();
-
-    for item in vec.iter() {
-        let count = occurrences.entry(item.clone()).or_insert(0);
-        *count += 1;
-    }
-
-    for (item, count) in occurrences {
-        if count > 1 {
-            duplicates.push(item);
-        }
-    }
-
-    duplicates
-}
-
 #[cfg(test)]
 mod tests {
     use crate::csaf::csaf2_0::validation::test_6_01_02_multiple_definition_of_product_id;

csaf-lib/src/csaf/csaf2_0/loader.rs

@@ -1,5 +1,5 @@
 use std::{fs::File, io::BufReader};
-
+use crate::csaf::validation::Validatable;
 use super::schema::CommonSecurityAdvisoryFramework;
 
 pub fn load_document(path: &str) -> std::io::Result<CommonSecurityAdvisoryFramework> {

csaf-lib/src/csaf/csaf2_0/validation.rs

@@ -1,4 +1,4 @@
-use super::schema::{Branch, BranchesT, CommonSecurityAdvisoryFramework, ProductIdT, ProductTree};
+use super::schema::{Branch, CommonSecurityAdvisoryFramework, ProductIdT, ProductTree};
 use std::collections::HashSet;
 
 pub fn gather_product_references(doc: &CommonSecurityAdvisoryFramework) -> HashSet<&ProductIdT> {
@@ -93,7 +93,7 @@ pub fn gather_product_definitions_from_branch(branch: &Branch) -> Vec<&ProductId
 }
 
 pub fn count_branch_depth(branch: &Branch) -> u32 {
-    let mut i = 0;
+    let mut i = 1;
 
     // Go into the branch, calculate the depth and take the maximum value
     if let Some(x) = branch.branches.as_ref() {

csaf-lib/src/csaf/csaf2_1/loader.rs

@@ -1,48 +1,32 @@
 use super::product_helper::*;
 use super::schema::CommonSecurityAdvisoryFramework;
-use crate::csaf::validation::{Validate, ValidationProfile};
-use lazy_static::lazy_static;
+use crate::csaf::helpers::find_duplicates;
+use crate::csaf::validation::{Test, Validatable, Validate, ValidationProfile};
 use std::collections::{HashMap, HashSet};
 
-type Test = fn(&CommonSecurityAdvisoryFramework) -> Result<(), String>;
-
-// TODO: convert this to code using std::sync::OnceLock
-lazy_static! {
-    static ref PROFILES: HashMap<ValidationProfile, Vec<&'static str>> = HashMap::from([
-        (
-            ValidationProfile::Basic,
-            Vec::from(["6.1.1", "6.1.2", "6.1.34"])
-        ),
-        (ValidationProfile::Extended, Vec::from(["6.1.1", "6.1.2"])),
-        (ValidationProfile::Full, Vec::from(["6.1.1", "6.1.2"])),
-    ]);
-    static ref TESTS: HashMap<&'static str, Test> = HashMap::<&str, Test>::from([
-        ("6.1.1", test_6_01_01_missing_definition_of_product_id),
-        ("6.1.2", test_6_01_02_multiple_definition_of_product_id),
-    ] as [(&str, Test); 2]);
-}
-
-impl Validate for CommonSecurityAdvisoryFramework {
-    fn validate_profile(&self, profile: ValidationProfile) {
-        println!("Validating document... \n");
-
-        println!("Executing Test 6.1.1... ");
-
-        let _ = match test_6_01_01_missing_definition_of_product_id(self) {
-            Ok(()) => println!("> Test Success"),
-            Err(e) => println!("> Error: {}", e),
-        };
-
-        println!("Executing Test 6.1.2... ");
+impl Validatable<CommonSecurityAdvisoryFramework> for CommonSecurityAdvisoryFramework {
+    fn profiles(&self) -> HashMap<ValidationProfile, Vec<&str>> {
+        HashMap::from([
+            (
+                ValidationProfile::Basic,
+                Vec::from(["6.1.1", "6.1.2", "6.1.34"]),
+            ),
+            (ValidationProfile::Extended, Vec::from(["6.1.1", "6.1.2"])),
+            (ValidationProfile::Full, Vec::from(["6.1.1", "6.1.2"])),
+        ])
+    }
 
-        let _ = match test_6_01_02_multiple_definition_of_product_id(self) {
-            Ok(()) => println!("> Test Success"),
-            Err(e) => println!("> Error: {}", e),
-        };
+    fn tests(&self) -> HashMap<&str, Test<CommonSecurityAdvisoryFramework>> {
+        HashMap::<&str, Test<CommonSecurityAdvisoryFramework>>::from([
+            ("6.1.1", test_6_01_01_missing_definition_of_product_id),
+            ("6.1.2", test_6_01_02_multiple_definition_of_product_id),
+            ("6.1.34", test_6_01_34_branches_recursion_depth),
+        ]
+            as [(&str, Test<CommonSecurityAdvisoryFramework>); 3])
     }
 
-    fn validate_by_test(&self, version: &str) {
-        todo!()
+    fn doc(&self) -> &CommonSecurityAdvisoryFramework {
+        self
     }
 }
 
@@ -62,10 +46,6 @@ pub fn test_6_01_01_missing_definition_of_product_id(
     }
 }
 
-pub fn testbla(doc: &CommonSecurityAdvisoryFramework) -> Result<(), String> {
-    Ok(())
-}
-
 pub fn test_6_01_02_multiple_definition_of_product_id(
     doc: &CommonSecurityAdvisoryFramework,
 ) -> Result<(), String> {
@@ -95,34 +75,17 @@ pub fn test_6_01_34_branches_recursion_depth(
     }
 }
 
-fn find_duplicates<T: std::hash::Hash + Eq + Clone>(vec: Vec<T>) -> Vec<T> {
-    let mut occurrences = HashMap::new();
-    let mut duplicates = Vec::new();
-
-    for item in vec.iter() {
-        let count = occurrences.entry(item.clone()).or_insert(0);
-        *count += 1;
-    }
-
-    for (item, count) in occurrences {
-        if count > 1 {
-            duplicates.push(item);
-        }
-    }
-
-    duplicates
-}
-
 #[cfg(test)]
 mod tests {
-    use crate::csaf::csaf2_0::validation::test_6_01_02_multiple_definition_of_product_id;
-    use crate::csaf::csaf2_0::{
+    use crate::csaf::csaf2_1::{
         loader::load_document, validation::test_6_01_01_missing_definition_of_product_id,
+        validation::test_6_01_02_multiple_definition_of_product_id,
+        validation::test_6_01_34_branches_recursion_depth,
     };
 
     #[test]
     fn test_test_6_01_01() {
-        let doc = load_document("../csaf/csaf_2.0/test/validator/data/mandatory/oasis_csaf_tc-csaf_2_0-2021-6-1-01-01.json").unwrap();
+        let doc = load_document("../csaf/csaf_2.1/test/validator/data/mandatory/oasis_csaf_tc-csaf_2_1-2024-6-1-01-01.json").unwrap();
         assert_eq!(
             test_6_01_01_missing_definition_of_product_id(&doc),
             Err(String::from("Missing definitions: [ProductIdT(\"CSAFPID-9080700\"), ProductIdT(\"CSAFPID-9080701\")]"))
@@ -131,12 +94,21 @@ mod tests {
 
     #[test]
     fn test_test_6_01_02() {
-        let doc = load_document("../csaf/csaf_2.0/test/validator/data/mandatory/oasis_csaf_tc-csaf_2_0-2021-6-1-02-01.json").unwrap();
+        let doc = load_document("../csaf/csaf_2.1/test/validator/data/mandatory/oasis_csaf_tc-csaf_2_1-2024-6-1-02-01.json").unwrap();
         assert_eq!(
             test_6_01_02_multiple_definition_of_product_id(&doc),
             Err(String::from(
                 "Duplicate definitions: [ProductIdT(\"CSAFPID-9080700\")]"
             ))
         )
     }
+
+    #[test]
+    fn test_test_6_01_34() {
+        let doc = load_document("../csaf/csaf_2.1/test/validator/data/mandatory/oasis_csaf_tc-csaf_2_1-2024-6-1-34-01.json").unwrap();
+        assert_eq!(
+            test_6_01_34_branches_recursion_depth(&doc),
+            Err(String::from("Recursion depth too big: 31"))
+        )
+    }
 }

csaf-lib/src/csaf/csaf2_1/product_helper.rs

@@ -0,0 +1,19 @@
+use std::collections::HashMap;
+
+pub fn find_duplicates<T: std::hash::Hash + Eq + Clone>(vec: Vec<T>) -> Vec<T> {
+    let mut occurrences = HashMap::new();
+    let mut duplicates = Vec::new();
+
+    for item in vec.iter() {
+        let count = occurrences.entry(item.clone()).or_insert(0);
+        *count += 1;
+    }
+
+    for (item, count) in occurrences {
+        if count > 1 {
+            duplicates.push(item);
+        }
+    }
+
+    duplicates
+}

csaf-lib/src/csaf/csaf2_1/validation.rs

@@ -1,3 +1,4 @@
 pub mod csaf2_0;
 pub mod csaf2_1;
+mod helpers;
 pub mod validation;