csaf-rs 0.5.0

A parser for the CSAF standard written in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

use crate::csaf::types::csaf_document_category::CsafDocumentCategory;
use crate::csaf_traits::{CsafTrait, DocumentTrait};
use crate::validation::ValidationError;
use crate::validations::utils::document_category_test_config::DocumentCategoryTestConfig;

/// 6.1.27.4 Product Tree
///
/// This test only applies to documents with `/document/category` with value `csaf_security_advisory` and `csaf_vex` for
/// `/document/csaf_version` `2.0` and additionally to documents with `/document/category` with
/// value `csaf_deprecated_security_advisory` for `/document/csaf_version` `2.1`.
///
/// Documents with this category must have a `/product_tree` element.
pub fn test_6_1_27_04_product_tree(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let doc_category = doc.get_document().get_category();

    if !PROFILE_TEST_CONFIG.matches_category_with_csaf_version(doc.get_document().get_csaf_version(), &doc_category) {
        return Ok(()); // ToDo generate skipped https://github.com/csaf-rs/csaf/issues/409
    }

    // return error if there are there isn't a product tree
    if doc.get_product_tree().is_none() {
        return Err(vec![test_6_1_27_04_err_generator(doc_category)]);
    }

    Ok(())
}

const PROFILE_TEST_CONFIG: DocumentCategoryTestConfig = DocumentCategoryTestConfig::new()
    .shared(&[
        CsafDocumentCategory::CsafSecurityAdvisory,
        CsafDocumentCategory::CsafVex,
    ])
    .csaf21(&[CsafDocumentCategory::CsafDeprecatedSecurityAdvisory]);

fn test_6_1_27_04_err_generator(document_category: CsafDocumentCategory) -> ValidationError {
    ValidationError {
        message: format!("Document with category '{document_category}' must have a '/product_tree' element"),
        instance_path: "/product_tree".to_string(),
    }
}

crate::test_validation::impl_validator!(ValidatorForTest6_1_27_4, test_6_1_27_04_product_tree);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::csaf2_0::testcases::TESTS_2_0;
    use crate::csaf2_1::testcases::TESTS_2_1;

    #[test]
    fn test_test_6_1_27_04() {
        let case_security_advisory = Err(vec![test_6_1_27_04_err_generator(
            CsafDocumentCategory::CsafSecurityAdvisory,
        )]);
        let case_vex = Err(vec![test_6_1_27_04_err_generator(CsafDocumentCategory::CsafVex)]);
        let case_deprecated_security_advisory = Err(vec![test_6_1_27_04_err_generator(
            CsafDocumentCategory::CsafDeprecatedSecurityAdvisory,
        )]);

        TESTS_2_0.test_6_1_27_4.expect(case_security_advisory.clone());
        TESTS_2_1
            .test_6_1_27_4
            .expect(case_security_advisory, case_vex, case_deprecated_security_advisory);
    }
}