allow-report 0.1.6

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

use allow_core::{MatchStatus, json_escape};

use crate::{ReportContext, ReviewSignals, Summary};

pub(crate) const BROKEN_EVIDENCE_LINK_COMMAND: &str =
    "cargo-allow worklist --item-kind broken_evidence_link --format json";
pub(crate) const MISSING_EVIDENCE_COMMAND: &str =
    "cargo-allow worklist --missing-evidence --format json";
pub(crate) const WEAK_EVIDENCE_REFERENCE_COMMAND: &str =
    "cargo-allow worklist --item-kind weak_evidence_reference --format json";

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct EvidenceRepairQueue {
    pub(crate) signal: &'static str,
    pub(crate) label: &'static str,
    pub(crate) route_kind: &'static str,
    pub(crate) item_kind: Option<&'static str>,
    pub(crate) worklist_filter: Option<&'static str>,
    pub(crate) count: usize,
    pub(crate) command: &'static str,
}

pub(crate) fn evidence_repair_queues_from_context(
    summary: &Summary,
    context: ReportContext<'_>,
) -> Vec<EvidenceRepairQueue> {
    evidence_repair_queues(summary, ReviewSignals::from_summary(summary, context))
}

pub(crate) fn evidence_repair_queues(
    summary: &Summary,
    signals: ReviewSignals,
) -> Vec<EvidenceRepairQueue> {
    evidence_repair_queues_from_counts(
        signals.broken_evidence_links,
        signals
            .policy_missing_evidence
            .max(summary.count(MatchStatus::EvidenceMissing)),
        signals.weak_evidence_references,
    )
}

pub(crate) fn evidence_repair_queues_from_counts(
    broken_evidence_links: usize,
    missing_evidence: usize,
    weak_evidence_references: usize,
) -> Vec<EvidenceRepairQueue> {
    let mut queues = Vec::new();
    push_evidence_repair_queue_if(
        &mut queues,
        EvidenceRepairQueue {
            signal: "broken_evidence_links",
            label: "broken evidence links",
            route_kind: "worklist_item_kind",
            item_kind: Some("broken_evidence_link"),
            worklist_filter: None,
            count: broken_evidence_links,
            command: BROKEN_EVIDENCE_LINK_COMMAND,
        },
    );
    push_evidence_repair_queue_if(
        &mut queues,
        EvidenceRepairQueue {
            signal: "missing_evidence",
            label: "missing evidence",
            route_kind: "worklist_filter",
            item_kind: Some("missing_evidence"),
            worklist_filter: Some("missing_evidence"),
            count: missing_evidence,
            command: MISSING_EVIDENCE_COMMAND,
        },
    );
    push_evidence_repair_queue_if(
        &mut queues,
        EvidenceRepairQueue {
            signal: "weak_evidence_references",
            label: "weak evidence references",
            route_kind: "worklist_item_kind",
            item_kind: Some("weak_evidence_reference"),
            worklist_filter: None,
            count: weak_evidence_references,
            command: WEAK_EVIDENCE_REFERENCE_COMMAND,
        },
    );
    queues
}

pub(crate) fn push_evidence_repair_queue_json_fields(
    out: &mut String,
    queue: &EvidenceRepairQueue,
    indent: &str,
) {
    out.push_str(&format!(
        "{indent}\"signal\": \"{}\",\n",
        json_escape(queue.signal)
    ));
    out.push_str(&format!(
        "{indent}\"label\": \"{}\",\n",
        json_escape(queue.label)
    ));
    out.push_str(&format!(
        "{indent}\"route_kind\": \"{}\",\n",
        json_escape(queue.route_kind)
    ));
    if let Some(item_kind) = queue.item_kind {
        out.push_str(&format!(
            "{indent}\"item_kind\": \"{}\",\n",
            json_escape(item_kind)
        ));
    }
    if let Some(worklist_filter) = queue.worklist_filter {
        out.push_str(&format!(
            "{indent}\"worklist_filter\": \"{}\",\n",
            json_escape(worklist_filter)
        ));
    }
    out.push_str(&format!("{indent}\"count\": {},\n", queue.count));
    out.push_str(&format!(
        "{indent}\"command\": \"{}\"\n",
        json_escape(queue.command)
    ));
}

fn push_evidence_repair_queue_if(
    queues: &mut Vec<EvidenceRepairQueue>,
    queue: EvidenceRepairQueue,
) {
    if queue.count > 0 {
        queues.push(queue);
    }
}