svccat 1.5.0

Detect drift between your declared service catalog and what actually lives in the repo.
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 crate::drift::{DriftReport, Severity};
use anyhow::Result;
use serde_json::{json, Value};

/// Render a `svccat check` result as a Microsoft Teams Incoming Webhook payload.
///
/// The output is an Adaptive Card (version 1.4) wrapped in the `attachments`
/// envelope expected by Teams incoming webhooks and the `chat.postMessage` API.
pub fn render_check(report: &DriftReport) -> Result<()> {
    println!("{}", render_check_to_string(report)?);
    Ok(())
}

/// Build the Teams payload and serialize it to pretty-printed JSON.
pub fn render_check_to_string(report: &DriftReport) -> Result<String> {
    let payload = build_check_payload(report);
    Ok(serde_json::to_string_pretty(&payload)?)
}

pub(crate) fn build_check_payload(report: &DriftReport) -> Value {
    build_check_payload_inner(report)
}

fn build_check_payload_inner(report: &DriftReport) -> Value {
    let errors = report.error_count();
    let warnings = report.warning_count();

    let (title, title_color) = if report.drifts.is_empty() {
        ("svccat: No drift detected".to_string(), "Good")
    } else {
        (
            format!(
                "svccat: {errors} error{}, {warnings} warning{}",
                plural(errors),
                plural(warnings)
            ),
            if errors > 0 { "Attention" } else { "Warning" },
        )
    };

    let mut body: Vec<Value> = vec![
        json!({
            "type": "TextBlock",
            "size": "Large",
            "weight": "Bolder",
            "color": title_color,
            "text": title,
            "wrap": true
        }),
        json!({
            "type": "FactSet",
            "facts": [
                {"title": "Manifest", "value": report.manifest},
                {"title": "Declared", "value": report.declared.to_string()},
                {"title": "Discovered", "value": report.discovered.to_string()},
            ]
        }),
    ];

    if report.drifts.is_empty() {
        body.push(json!({
            "type": "TextBlock",
            "text": "All services are in sync.",
            "color": "Good",
            "wrap": true
        }));
    } else {
        body.push(json!({"type": "Container", "separator": true, "items": []}));
        for item in &report.drifts {
            let icon = match item.severity {
                Severity::Error => "🔴",
                Severity::Warning => "🟡",
            };
            let kind_str = format!("{:?}", item.kind);
            body.push(json!({
                "type": "TextBlock",
                "text": format!("{icon} **{}** - {}\n{}", item.service, kind_str, item.message),
                "wrap": true
            }));
        }
    }

    let card = json!({
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
        "type": "AdaptiveCard",
        "version": "1.4",
        "msteams": {"width": "Full"},
        "body": body
    });

    json!({
        "type": "message",
        "attachments": [{
            "contentType": "application/vnd.microsoft.card.adaptive",
            "contentUrl": null,
            "content": card
        }]
    })
}

fn plural(n: usize) -> &'static str {
    if n == 1 {
        ""
    } else {
        "s"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::drift::{DriftItem, DriftKind};

    #[test]
    fn clean_payload_uses_good_color() {
        let report = DriftReport {
            manifest: "services.yaml".to_string(),
            declared: 1,
            discovered: 1,
            drifts: vec![],
        };

        let payload = build_check_payload(&report);
        let card = &payload["attachments"][0]["content"];
        let body = card["body"].as_array().unwrap();
        assert!(body.iter().any(|b| b.to_string().contains("Good")));
    }

    #[test]
    fn drift_payload_includes_service_messages() {
        let report = DriftReport {
            manifest: "services.yaml".to_string(),
            declared: 2,
            discovered: 2,
            drifts: vec![DriftItem {
                kind: DriftKind::DeclaredMissingFromRepo,
                severity: Severity::Error,
                service: "api".to_string(),
                message: "missing".to_string(),
                detail: None,
            }],
        };

        let payload = build_check_payload(&report);
        let text = payload.to_string();
        assert!(text.contains("api"));
        assert!(text.contains("missing"));
        assert!(text.contains("Attention"));
    }
}