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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use crate::csaf::types::version_number::CsafVersionNumber;
use crate::csaf_traits::{CsafTrait, DocumentTrait, TrackingTrait};
use crate::schema::csaf2_1::schema::DocumentStatus;
use crate::validation::ValidationError;

/// 6.1.16 Latest Document Version
///
/// `/document/tracking/version` must be equal to the last `/document/tracking/revision_history[]/number` when
/// sorting the revision history ascending by `date`. Build metadata is ignored. Pre-release parts are ignored
/// if `/document/status` is "draft".
pub fn test_6_1_16_latest_document_version(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let tracking = doc.get_document().get_tracking();

    let mut revision_history = tracking.aggregate_revision_history();
    revision_history.inplace_sort_by_date_then_number();

    // TODO: Technically, this should never be None, as Revision History has minItems: 1 (#409)
    if let Some(latest_revision_history_item) = revision_history.last() {
        let latest_number = latest_revision_history_item.number.clone();
        let doc_status = tracking.get_status();
        let doc_version = tracking.get_version();
        // As there are additional criteria to the equality check, we cant just use the Eq impl
        match (&latest_number, &doc_version) {
            (CsafVersionNumber::IntVer(last_number), CsafVersionNumber::IntVer(doc_version))
                if doc_version == last_number =>
            {
                // For integer version numbers, the eq compares the u64 ints
                return Ok(());
            },
            (CsafVersionNumber::SemVer(last_number), CsafVersionNumber::SemVer(doc_version)) => {
                // Manually compare the semver instances according to test requirements
                let mut equal = true;
                equal &= equal && doc_version.get_major() == last_number.get_major();
                equal &= equal && doc_version.get_minor() == last_number.get_minor();
                equal &= equal && doc_version.get_patch() == last_number.get_patch();
                if doc_status != DocumentStatus::Draft {
                    equal &= equal && doc_version.get_prerelease() == last_number.get_prerelease();
                }
                if equal {
                    return Ok(());
                }
            },
            // Mixed version number types cannot be equal
            _ => {},
        };
        // versions are unequal, return error
        return Err(vec![test_6_1_16_err_generator(
            &doc_version,
            &latest_number,
            &doc_status,
        )]);
    }

    Ok(())
}

fn test_6_1_16_err_generator(
    doc_version: &CsafVersionNumber,
    latest_number: &CsafVersionNumber,
    doc_status: &DocumentStatus,
) -> ValidationError {
    ValidationError {
        message: format!(
            "The document version '{doc_version}' is not equal to the latest revision history number '{latest_number}' in document with status '{doc_status}'"
        ),
        instance_path: "/document/tracking/version".to_string(),
    }
}

crate::test_validation::impl_validator!(ValidatorForTest6_1_16, test_6_1_16_latest_document_version);

#[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_16() {
        // Error cases
        let case_intver_history_greater_document_version = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("1"),
            &CsafVersionNumber::from("2"),
            &DocumentStatus::Final,
        )]);
        let case_intver_history_greater_document_version_same_date = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("1"),
            &CsafVersionNumber::from("2"),
            &DocumentStatus::Final,
        )]);
        let case_intver_history_greater_document_version_same_date_wrong_order = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("1"),
            &CsafVersionNumber::from("2"),
            &DocumentStatus::Final,
        )]);
        let case_semver_history_greater_document_version = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("1.0.0"),
            &CsafVersionNumber::from("2.0.0"),
            &DocumentStatus::Final,
        )]);
        let case_semver_history_greater_document_version_same_date = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("1.0.0"),
            &CsafVersionNumber::from("2.0.0"),
            &DocumentStatus::Final,
        )]);
        let case_intver_history_greater_document_version_same_date_multiple_versions =
            Err(vec![test_6_1_16_err_generator(
                &CsafVersionNumber::from("9"),
                &CsafVersionNumber::from("10"),
                &DocumentStatus::Final,
            )]);
        let case_semver_history_greater_document_version_same_date_multiple_versions =
            Err(vec![test_6_1_16_err_generator(
                &CsafVersionNumber::from("1.9.0"),
                &CsafVersionNumber::from("1.10.0"),
                &DocumentStatus::Final,
            )]);
        let case_intver_history_greater_document_version_same_date_higher_precision =
            Err(vec![test_6_1_16_err_generator(
                &CsafVersionNumber::from("1"),
                &CsafVersionNumber::from("2"),
                &DocumentStatus::Final,
            )]);

        // CSAF 2.0 has 18 test cases (01-08, 11-19, 31)
        TESTS_2_0.test_6_1_16.expect(
            case_intver_history_greater_document_version.clone(),
            case_intver_history_greater_document_version_same_date.clone(),
            case_intver_history_greater_document_version_same_date_wrong_order.clone(),
            case_semver_history_greater_document_version.clone(),
            case_semver_history_greater_document_version_same_date.clone(),
            case_intver_history_greater_document_version_same_date_multiple_versions.clone(),
            case_semver_history_greater_document_version_same_date_multiple_versions.clone(),
            case_intver_history_greater_document_version_same_date_higher_precision.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
            Ok(()), // case_31
        );

        let case_intver_history_greater_document_version_wrong_order = Err(vec![test_6_1_16_err_generator(
            &CsafVersionNumber::from("2"),
            &CsafVersionNumber::from("1"),
            &DocumentStatus::Final,
        )]);

        // CSAF 2.1 has 20 test cases (01-09, 11-19, 31-32)
        TESTS_2_1.test_6_1_16.expect(
            case_intver_history_greater_document_version,
            case_intver_history_greater_document_version_same_date,
            case_intver_history_greater_document_version_same_date_wrong_order,
            case_semver_history_greater_document_version,
            case_semver_history_greater_document_version_same_date,
            case_intver_history_greater_document_version_same_date_multiple_versions,
            case_semver_history_greater_document_version_same_date_multiple_versions,
            case_intver_history_greater_document_version_same_date_higher_precision,
            case_intver_history_greater_document_version_wrong_order,
            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
            Ok(()), // case_32
        );
    }
}