csaf-rs 0.5.1

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

use crate::csaf_traits::{BranchTrait, CategoryOfTheBranch, CsafTrait, ProductTreeTrait};
use crate::validation::ValidationError;
use regex::Regex;
use std::sync::LazyLock;

static V_AS_VERSION_INDICATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^[vV][0-9].*$").unwrap());

fn create_v_version_indicator_error(version: &str, path: &str) -> ValidationError {
    ValidationError {
        message: format!(
            "Product version name {version} starting with 'v' or 'V' as version indicator is not recommended"
        ),
        instance_path: format!("{path}/name"),
    }
}

/// 6.3.11 Usage of V as Version Indicator
///
/// Tests that products in the product tree with the `product_version` branch category do not start
/// with a `v` or `V` before their version.
pub fn test_6_3_11_usage_of_v_as_version_indicator(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let mut errors: Option<Vec<ValidationError>> = None;

    if let Some(product_tree) = doc.get_product_tree().as_ref() {
        product_tree.visit_all_branches(&mut |branch, path| {
            if branch.get_category() == CategoryOfTheBranch::ProductVersion
                && V_AS_VERSION_INDICATOR_REGEX.is_match(branch.get_name())
            {
                errors
                    .get_or_insert_default()
                    .push(create_v_version_indicator_error(branch.get_name(), path));
            }
        });
    }

    errors.map_or(Ok(()), Err)
}

crate::test_validation::impl_validator!(ValidatorForTest6_3_11, test_6_3_11_usage_of_v_as_version_indicator);

#[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_3_11() {
        let case_01 = Err(vec![create_v_version_indicator_error(
            "v4.2",
            "/product_tree/branches/0/branches/0/branches/0",
        )]);

        // Both CSAF 2.0 and 2.1 have 2 test cases
        TESTS_2_0.test_6_3_11.expect(case_01.clone(), Ok(()));
        TESTS_2_1.test_6_3_11.expect(case_01, Ok(()));
    }
}