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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use crate::csaf_traits::{CsafTrait, DocumentTrait, TrackingTrait};
use crate::validation::ValidationError;

fn create_revision_history_error(revision_number: impl std::fmt::Display, path_index: usize) -> ValidationError {
    ValidationError {
        message: format!(
            "Revision history is not sorted by date, revision with number {revision_number} is out of place"
        ),
        instance_path: format!("/document/tracking/revision_history/{path_index}"),
    }
}

/// 6.1.14 Sorted Revision History
///
/// The revision history items, when sorted by their `/document/tracking/revision_history[]/date` field,
/// must be in the same order as when sorted by their `/document/tracking/revision_history[]/number` field.
pub fn test_6_1_14_sorted_revision_history(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    // Generate tuples of (revision history path index, date, number)
    let mut rev_history_tuples_sort_by_date = doc.get_document().get_tracking().aggregate_revision_history();
    let mut rev_history_tuples_sort_by_number = rev_history_tuples_sort_by_date.clone();

    // Sort by date and by number
    rev_history_tuples_sort_by_date.inplace_sort_by_date_then_number();
    rev_history_tuples_sort_by_number.inplace_sort_by_number();

    // Generate errors if revision history items are sorted differently between sort by date and sort by number
    let mut errors = Vec::new();
    for i in 0..rev_history_tuples_sort_by_date.len() {
        if let Some(by_date) = rev_history_tuples_sort_by_date.get(i)
            && let Some(by_number) = rev_history_tuples_sort_by_number.get(i)
        {
            if by_date.date != by_number.date {
                errors.push(create_revision_history_error(&by_date.number, by_date.path_index));
            }
        } else {
            unreachable!("Both arrays should have same length, this looks like a dev error.")
        }
    }

    if !errors.is_empty() {
        return Err(errors);
    }

    Ok(())
}

crate::test_validation::impl_validator!(ValidatorForTest6_1_14, test_6_1_14_sorted_revision_history);

#[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_14() {
        // Error cases
        let case_01 = Err(vec![
            create_revision_history_error("2", 0),
            create_revision_history_error("1", 1),
        ]);
        let case_02 = Err(vec![
            create_revision_history_error("2", 0),
            create_revision_history_error("1", 1),
        ]);
        let case_03 = Err(vec![
            create_revision_history_error("2", 1),
            create_revision_history_error("1", 0),
        ]);
        let case_04 = Err(vec![
            create_revision_history_error("2.0.0", 0),
            create_revision_history_error("1.0.0", 1),
        ]);
        let case_05 = Err(vec![
            create_revision_history_error("2.0.0", 0),
            create_revision_history_error("1.0.0", 1),
        ]);
        let case_06 = Err(vec![
            create_revision_history_error("10", 9),
            create_revision_history_error("9", 8),
        ]);
        let case_07 = Err(vec![
            create_revision_history_error("1.10.0", 10),
            create_revision_history_error("1.9.0", 9),
        ]);
        let case_08 = Err(vec![
            create_revision_history_error("2", 1),
            create_revision_history_error("1", 0),
        ]);

        // CSAF 2.0 has 17 test cases (01-08, 11-19)
        TESTS_2_0.test_6_1_14.expect(
            case_01.clone(),
            case_02.clone(),
            case_03.clone(),
            case_04.clone(),
            case_05.clone(),
            case_06.clone(),
            case_07.clone(),
            case_08.clone(),
            Ok(()), // case_11
            Ok(()), // case_12
            Ok(()), // case_13
            Ok(()), // case_14
            Ok(()), // case_15
            Ok(()), // case_16
            Ok(()), // case_17
            Ok(()), // case_18
            Ok(()), // case_19
        );

        // CSAF 2.1 has 19 test cases (01-09, 11-19, 31)
        TESTS_2_1.test_6_1_14.expect(
            case_01,
            case_02,
            case_03,
            case_04,
            case_05,
            case_06,
            case_07,
            case_08,
            Err(vec![
                create_revision_history_error("2", 0),
                create_revision_history_error("1", 1),
            ]),
            Ok(()), // case_11
            Ok(()), // case_12
            Ok(()), // case_13
            Ok(()), // case_14
            Ok(()), // case_15
            Ok(()), // case_16
            Ok(()), // case_17
            Ok(()), // case_18
            Ok(()), // case_19
            Ok(()), // case_31
        );
    }
}