svccat 1.1.2

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

use crate::drift::DriftReport;
use crate::manifest::Manifest;

/// Render drift items from a check as CSV.
///
/// Columns: service, severity, kind, message, detail
pub fn render_check(report: &DriftReport) {
    println!("service,severity,kind,message,detail");
    for item in &report.drifts {
        let kind = serde_json::to_value(&item.kind)
            .ok()
            .and_then(|v| v.as_str().map(str::to_owned))
            .unwrap_or_default();
        let severity = serde_json::to_value(&item.severity)
            .ok()
            .and_then(|v| v.as_str().map(str::to_owned))
            .unwrap_or_default();
        println!(
            "{},{},{},{},{}",
            csv_field(&item.service),
            severity,
            kind,
            csv_field(&item.message),
            csv_field(item.detail.as_deref().unwrap_or(""))
        );
    }
}

/// Render the service catalog as CSV.
///
/// Columns: name, language, platform, role, url, team, oncall
pub fn render_export(manifest: &Manifest) {
    println!("name,language,platform,role,url,team,oncall");
    for svc in &manifest.services {
        println!(
            "{},{},{},{},{},{},{}",
            csv_field(&svc.name),
            csv_field(svc.language.as_deref().unwrap_or("")),
            csv_field(svc.platform.as_deref().unwrap_or("")),
            csv_field(svc.role.as_deref().unwrap_or("")),
            csv_field(svc.url.as_deref().unwrap_or("")),
            csv_field(svc.team.as_deref().unwrap_or("")),
            csv_field(svc.oncall.as_deref().unwrap_or(""))
        );
    }
}

/// Wrap a field value in double-quotes if it contains a comma, double-quote,
/// or newline, escaping internal double-quotes by doubling them (RFC 4180).
fn csv_field(s: &str) -> String {
    if s.contains(',') || s.contains('"') || s.contains('\n') {
        format!("\"{}\"", s.replace('"', "\"\""))
    } else {
        s.to_owned()
    }
}

#[cfg(test)]
mod tests {
    use super::csv_field;

    #[test]
    fn leaves_plain_values_unquoted() {
        assert_eq!(csv_field("service-a"), "service-a");
    }

    #[test]
    fn quotes_and_escapes_special_values() {
        assert_eq!(csv_field("a,b"), "\"a,b\"");
        assert_eq!(csv_field("a\"b"), "\"a\"\"b\"");
        assert_eq!(csv_field("a\nb"), "\"a\nb\"");
    }
}