oratos-report 0.2.0

Report formatters for Oratos audit results
Documentation 
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

use oratos_core::AuditReport;

/// Stable JSON report schema for CI and tooling integration.
pub fn format_json(report: &AuditReport) -> String {
    serde_json::to_string_pretty(report).expect("audit report serializes to JSON")
}

#[cfg(test)]
mod tests {
    use super::*;
    use insta::assert_snapshot;
    use oratos_core::{AuditReport, AuditTarget, TargetKind};

    #[test]
    fn json_has_expected_top_level_keys() {
        let report = AuditReport::new(
            AuditTarget {
                path_or_url: "./test".into(),
                kind: TargetKind::Directory,
            },
            vec![],
        );
        let json: serde_json::Value = serde_json::from_str(&format_json(&report)).unwrap();
        assert!(json.get("core_version").is_some());
        assert!(json.get("target").is_some());
        assert!(json.get("pages").is_some());
        assert!(json.get("findings").is_some());
        assert!(json.get("scores").is_some());
        assert!(json.get("page_count").is_some());
    }

    #[test]
    fn json_output_is_stable_snapshot() {
        let report = AuditReport::new(
            AuditTarget {
                path_or_url: "./test".into(),
                kind: TargetKind::Directory,
            },
            vec![],
        );
        assert_snapshot!("empty_report_json", format_json(&report));
    }
}