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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::validation::ValidationError;
use serde_json::Value;

/// 6.2.13 Sorting
///
/// All keys in a CSAF document must be sorted alphabetically.
pub fn test_6_2_13_sorting(json: &Value) -> Result<(), Vec<ValidationError>> {
    let mut errors = Vec::new();
    match check_sorted_recursive(json, "", &mut errors) {
        true => Ok(()),
        false => Err(errors),
    }
}

fn check_sorted_recursive(value: &Value, path: &str, errors: &mut Vec<ValidationError>) -> bool {
    match value {
        Value::Object(map) => {
            // object -> check if keys are sorted
            let keys_ok = map.keys().zip(map.keys().skip(1)).all(|(a, b)| {
                if a > b {
                    errors.push(create_unsorted_keys_error(format!("{path}/{a}").as_str()));
                    false
                } else {
                    true
                }
            });

            // check all children recursively
            let children_ok = map
                .iter()
                .filter(|(key, value)| !check_sorted_recursive(value, format!("{path}/{key}").as_str(), errors))
                .count()
                == 0;

            keys_ok && children_ok
        },
        Value::Array(arr) => {
            // array -> check for each item
            arr.iter()
                .enumerate()
                .filter(|(key, value)| !check_sorted_recursive(value, format!("{path}/{key}").as_str(), errors))
                .count()
                == 0
        },
        // primitive types are always sorted
        _ => true,
    }
}

fn create_unsorted_keys_error(path: &str) -> ValidationError {
    ValidationError {
        message: "The keys in the CSAF document are not sorted alphabetically".to_string(),
        instance_path: path.to_string(),
    }
}

crate::test_validation::impl_raw_json_validator!(ValidatorForTest6_2_13, test_6_2_13_sorting);

#[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_2_13() {
        let err = Err(vec![create_unsorted_keys_error("/document/csaf_version")]);

        // Both CSAF 2.0 and 2.1 have 1 test cases
        TESTS_2_0.test_6_2_13.expect(err.clone());
        TESTS_2_1.test_6_2_13.expect(err);
    }
}