svccat 1.0.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

use anyhow::{bail, Context, Result};
use std::path::Path;

// ── Public API ────────────────────────────────────────────────────────────────

/// Add a tag to a service in the manifest file.
///
/// Reads and re-writes the manifest YAML in-place.
/// No-ops if the tag already exists.
pub fn add(manifest_path: &Path, service_name: &str, tag: &str) -> Result<()> {
    let text = std::fs::read_to_string(manifest_path)
        .with_context(|| format!("cannot read {}", manifest_path.display()))?;

    let mut doc: serde_yaml::Value =
        serde_yaml::from_str(&text).with_context(|| "cannot parse manifest YAML")?;

    let services = doc
        .get_mut("services")
        .and_then(|v| v.as_sequence_mut())
        .context("manifest has no 'services' list")?;

    let svc = services
        .iter_mut()
        .find(|s| s.get("name").and_then(|n| n.as_str()) == Some(service_name))
        .with_context(|| format!("service '{}' not found in manifest", service_name))?;

    let tags = svc
        .as_mapping_mut()
        .context("service entry is not a mapping")?
        .entry(serde_yaml::Value::String("tags".to_string()))
        .or_insert(serde_yaml::Value::Sequence(vec![]));

    let seq = tags
        .as_sequence_mut()
        .context("'tags' field is not a list")?;
    let tag_val = serde_yaml::Value::String(tag.to_string());
    if seq.contains(&tag_val) {
        eprintln!("tag '{}' already present on '{}'", tag, service_name);
        return Ok(());
    }
    seq.push(tag_val);

    write_yaml(manifest_path, &doc)?;
    eprintln!("added tag '{}' to '{}'", tag, service_name);
    Ok(())
}

/// Remove a tag from a service in the manifest file.
///
/// Errors if the tag is not present.
pub fn remove(manifest_path: &Path, service_name: &str, tag: &str) -> Result<()> {
    let text = std::fs::read_to_string(manifest_path)
        .with_context(|| format!("cannot read {}", manifest_path.display()))?;

    let mut doc: serde_yaml::Value =
        serde_yaml::from_str(&text).with_context(|| "cannot parse manifest YAML")?;

    let services = doc
        .get_mut("services")
        .and_then(|v| v.as_sequence_mut())
        .context("manifest has no 'services' list")?;

    let svc = services
        .iter_mut()
        .find(|s| s.get("name").and_then(|n| n.as_str()) == Some(service_name))
        .with_context(|| format!("service '{}' not found in manifest", service_name))?;

    let mapping = svc
        .as_mapping_mut()
        .context("service entry is not a mapping")?;

    let tags_key = serde_yaml::Value::String("tags".to_string());
    let tags = mapping
        .get_mut(&tags_key)
        .and_then(|v| v.as_sequence_mut())
        .with_context(|| format!("service '{}' has no tags", service_name))?;

    let tag_val = serde_yaml::Value::String(tag.to_string());
    let before = tags.len();
    tags.retain(|t| t != &tag_val);

    if tags.len() == before {
        bail!("tag '{}' not found on '{}'", tag, service_name);
    }

    // Remove the empty tags list to keep the YAML tidy.
    if tags.is_empty() {
        mapping.remove(&tags_key);
    }

    write_yaml(manifest_path, &doc)?;
    eprintln!("removed tag '{}' from '{}'", tag, service_name);
    Ok(())
}

// ── Helpers ───────────────────────────────────────────────────────────────────

fn write_yaml(path: &Path, doc: &serde_yaml::Value) -> Result<()> {
    let out = serde_yaml::to_string(doc).context("serialising YAML")?;
    std::fs::write(path, out).with_context(|| format!("writing {}", path.display()))
}