fallow-output 3.0.0

Output contract types for fallow reports
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

use serde::{Deserialize, Serialize};

use crate::{PrDecisionConclusion, PrDecisionSurface};

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct PrStatusContext {
    pub name: String,
    pub conclusion: PrDecisionConclusion,
    pub summary: String,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PrStatusMode {
    Aggregate,
    Split,
    AggregateAndSplit,
}

pub fn pr_status_contexts(surface: &PrDecisionSurface) -> Vec<PrStatusContext> {
    pr_status_contexts_with_mode(surface, PrStatusMode::Split)
}

pub fn pr_status_contexts_with_mode(
    surface: &PrDecisionSurface,
    mode: PrStatusMode,
) -> Vec<PrStatusContext> {
    match mode {
        PrStatusMode::Aggregate => vec![aggregate_status_context(surface)],
        PrStatusMode::Split => split_status_contexts(surface),
        PrStatusMode::AggregateAndSplit => {
            let mut contexts = vec![aggregate_status_context(surface)];
            contexts.extend(split_status_contexts(surface));
            contexts
        }
    }
}

fn split_status_contexts(surface: &PrDecisionSurface) -> Vec<PrStatusContext> {
    surface
        .gates
        .iter()
        .map(|gate| PrStatusContext {
            name: format!("Fallow / {}", gate.id),
            conclusion: gate.status,
            summary: match &gate.threshold {
                Some(threshold) => {
                    format!("{}: {} (threshold {threshold})", gate.label, gate.observed)
                }
                None => format!("{}: {}", gate.label, gate.observed),
            },
        })
        .collect()
}

fn aggregate_status_context(surface: &PrDecisionSurface) -> PrStatusContext {
    let total = surface.gates.len();
    let failing = surface
        .gates
        .iter()
        .filter(|gate| gate.status == PrDecisionConclusion::Failure)
        .count();
    let neutral = surface
        .gates
        .iter()
        .filter(|gate| gate.status == PrDecisionConclusion::Neutral)
        .count();
    let summary = if total == 0 {
        "No PR gates reported.".to_owned()
    } else if failing > 0 {
        format!("{failing} of {total} PR gates failed.")
    } else if neutral > 0 {
        format!("{neutral} of {total} PR gates need review.")
    } else {
        format!("All {total} PR gates passed.")
    };
    PrStatusContext {
        name: "Fallow".to_owned(),
        conclusion: surface.conclusion,
        summary,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{PR_DECISION_SCHEMA, PrDecisionDetails, PrDecisionGate, PrDecisionSurface};

    #[test]
    fn builds_status_contexts_from_decision_gates() {
        let surface = PrDecisionSurface {
            schema: PR_DECISION_SCHEMA.to_owned(),
            title: "Fallow".to_owned(),
            conclusion: PrDecisionConclusion::Neutral,
            gates: vec![PrDecisionGate {
                id: "duplication".to_owned(),
                label: "Duplication".to_owned(),
                status: PrDecisionConclusion::Neutral,
                observed: "2 clone groups".to_owned(),
                threshold: Some("configured rules".to_owned()),
                scope: "new code".to_owned(),
            }],
            annotations: vec![],
            details: PrDecisionDetails {
                summary_markdown: "Review recommended.".to_owned(),
                full_report_path: None,
                details_url: None,
            },
        };

        let contexts = pr_status_contexts(&surface);

        assert_eq!(contexts.len(), 1);
        assert_eq!(contexts[0].name, "Fallow / duplication");
        assert_eq!(contexts[0].conclusion, PrDecisionConclusion::Neutral);
        assert_eq!(
            contexts[0].summary,
            "Duplication: 2 clone groups (threshold configured rules)"
        );
    }

    #[test]
    fn aggregate_and_split_status_contexts_keep_one_consolidated_context() {
        let surface = PrDecisionSurface {
            schema: PR_DECISION_SCHEMA.to_owned(),
            title: "Fallow".to_owned(),
            conclusion: PrDecisionConclusion::Neutral,
            gates: vec![PrDecisionGate {
                id: "health".to_owned(),
                label: "Health".to_owned(),
                status: PrDecisionConclusion::Neutral,
                observed: "1 finding".to_owned(),
                threshold: None,
                scope: "new code".to_owned(),
            }],
            annotations: vec![],
            details: PrDecisionDetails {
                summary_markdown: "Review recommended.".to_owned(),
                full_report_path: None,
                details_url: None,
            },
        };

        let contexts = pr_status_contexts_with_mode(&surface, PrStatusMode::AggregateAndSplit);

        assert_eq!(contexts.len(), 2);
        assert_eq!(contexts[0].name, "Fallow");
        assert_eq!(contexts[0].summary, "1 of 1 PR gates need review.");
        assert_eq!(contexts[1].name, "Fallow / health");
    }
}