allow-report 0.1.8

Report and receipt rendering for cargo-allow source exception scans.
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
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

use crate::{DiffFindingChange, DiffPolicyChange, DiffPostureSummary};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiffNetPosture {
    Worse,
    ReviewRequired,
    Improved,
    Unchanged,
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub(crate) struct DiffEvidenceDeltaSummary {
    pub(crate) evidence_added: usize,
    pub(crate) weak_evidence_added: usize,
    pub(crate) broken_evidence_added: usize,
    pub(crate) evidence_removed: usize,
    pub(crate) evidence_removal_failures: usize,
    pub(crate) evidence_removal_review_items: usize,
    pub(crate) evidence_removal_improvements: usize,
    pub(crate) link_added: usize,
    pub(crate) weak_link_added: usize,
    pub(crate) broken_link_added: usize,
    pub(crate) link_removed: usize,
    pub(crate) link_removal_failures: usize,
    pub(crate) link_removal_review_items: usize,
    pub(crate) link_removal_improvements: usize,
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub(crate) struct DiffStructuralDeltaSummary {
    pub(crate) scope_broadened: usize,
    pub(crate) scope_changed: usize,
    pub(crate) scope_narrowed: usize,
    pub(crate) selector_changed: usize,
    pub(crate) selector_precision_decreased: usize,
    pub(crate) selector_precision_increased: usize,
}

impl DiffNetPosture {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Worse => "worse",
            Self::ReviewRequired => "review-required",
            Self::Improved => "improved",
            Self::Unchanged => "unchanged",
        }
    }

    pub fn reviewer_action(self) -> &'static str {
        match self {
            Self::Worse => {
                "block until failing source exception changes are fixed, narrowed, or receipted."
            }
            Self::ReviewRequired => "review the source exception posture change before merging.",
            Self::Improved => "verify the cleanup was intentional and keep the narrower posture.",
            Self::Unchanged => "no source exception posture change detected.",
        }
    }
}

pub(crate) fn diff_structural_delta_summary(
    policy_changes: &[DiffPolicyChange<'_>],
) -> DiffStructuralDeltaSummary {
    let mut summary = DiffStructuralDeltaSummary::default();
    for change in policy_changes {
        match change.kind {
            "scope_broadened" => summary.scope_broadened += 1,
            "scope_changed" => summary.scope_changed += 1,
            "scope_narrowed" => summary.scope_narrowed += 1,
            "selector_changed" => summary.selector_changed += 1,
            "selector_precision_decreased" => summary.selector_precision_decreased += 1,
            "selector_precision_increased" => summary.selector_precision_increased += 1,
            _ => {}
        }
    }
    summary
}

pub(crate) fn diff_evidence_delta_summary(
    policy_changes: &[DiffPolicyChange<'_>],
) -> DiffEvidenceDeltaSummary {
    let mut summary = DiffEvidenceDeltaSummary::default();
    for change in policy_changes {
        match change.kind {
            "evidence_added" => {
                summary.evidence_added += 1;
                match change.severity {
                    "review" => summary.weak_evidence_added += 1,
                    "fail" => summary.broken_evidence_added += 1,
                    _ => {}
                }
            }
            "evidence_removed" => {
                summary.evidence_removed += 1;
                match change.severity {
                    "fail" => summary.evidence_removal_failures += 1,
                    "review" => summary.evidence_removal_review_items += 1,
                    "improvement" => summary.evidence_removal_improvements += 1,
                    _ => {}
                }
            }
            "link_added" => {
                summary.link_added += 1;
                match change.severity {
                    "review" => summary.weak_link_added += 1,
                    "fail" => summary.broken_link_added += 1,
                    _ => {}
                }
            }
            "link_removed" => {
                summary.link_removed += 1;
                match change.severity {
                    "fail" => summary.link_removal_failures += 1,
                    "review" => summary.link_removal_review_items += 1,
                    "improvement" => summary.link_removal_improvements += 1,
                    _ => {}
                }
            }
            _ => {}
        }
    }
    summary
}

pub fn diff_posture_summary(
    current_failures: usize,
    finding_changes: &[DiffFindingChange<'_>],
    policy_changes: &[DiffPolicyChange<'_>],
) -> DiffPostureSummary {
    DiffPostureSummary {
        current_failures,
        new_findings: finding_changes
            .iter()
            .filter(|change| change.change == "new")
            .count(),
        removed_findings: finding_changes
            .iter()
            .filter(|change| change.change == "removed")
            .count(),
        policy_failures: policy_changes
            .iter()
            .filter(|change| change.severity == "fail")
            .count(),
        policy_review_items: policy_changes
            .iter()
            .filter(|change| change.severity == "review")
            .count(),
        policy_improvements: policy_changes
            .iter()
            .filter(|change| change.severity == "improvement")
            .count(),
    }
}

pub fn diff_net_posture(summary: DiffPostureSummary) -> DiffNetPosture {
    if summary.current_failures > 0 || summary.policy_failures > 0 {
        return DiffNetPosture::Worse;
    }
    if summary.new_findings > 0 || summary.policy_review_items > 0 {
        return DiffNetPosture::ReviewRequired;
    }
    if summary.removed_findings > 0 || summary.policy_improvements > 0 {
        return DiffNetPosture::Improved;
    }
    DiffNetPosture::Unchanged
}