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

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

fn create_revision_history_only_one_entry_error(document_category: &CsafDocumentCategory) -> ValidationError {
    ValidationError {
        message: format!(
            "The revision history contains only one entry which is prohibited for documents with category {document_category}"
        ),
        instance_path: "/document/tracking/revision_history".to_string(),
    }
}

/// 6.1.27.16 Revision history
///
/// This test only applies to documents with `/document/category` with value `csaf_withdrawn` or `csaf_superseded`.
///
/// The revision history shall not contain only one entry.
pub fn test_6_1_27_16_revision_history(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 This will be a wasSkipped later ([#409](https://github.com/csaf-rs/csaf/issues/409))
    }
    if doc.get_document().get_tracking().get_revision_history().len() == 1 {
        return Err(vec![create_revision_history_only_one_entry_error(&doc_category)]);
    }

    Ok(())
}

const PROFILE_TEST_CONFIG: DocumentCategoryTestConfig = DocumentCategoryTestConfig::new().csaf21(&[
    CsafDocumentCategory::CsafWithdrawn,
    CsafDocumentCategory::CsafSuperseded,
]);

crate::test_validation::impl_validator!(csaf2_1, ValidatorForTest6_1_27_16, test_6_1_27_16_revision_history);

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

    #[test]
    fn test_test_6_1_27_16() {
        let fail_withdrawn = Err(vec![create_revision_history_only_one_entry_error(
            &CsafDocumentCategory::CsafWithdrawn,
        )]);
        let fail_superseded = Err(vec![create_revision_history_only_one_entry_error(
            &CsafDocumentCategory::CsafSuperseded,
        )]);
        // Case 11: document status is draft, category is csaf_withdrawn, two revision history elements, one of which is a draft
        // Case 12: document status is final, category is csaf_withdrawn, two revision history elements
        // Case 13: document status is final, category is csaf_superseded, two revision history elements
        // Case 14: document status is draft, category is csaf_superseded, two revision history elements, one of which is a draft
        TESTS_2_1
            .test_6_1_27_16
            .expect(fail_withdrawn, fail_superseded, Ok(()), Ok(()), Ok(()), Ok(()));
    }
}