shep 0.17.0

The shep binary: a process manager that keeps a flock of long-running processes alive on macOS, Linux and Windows, with logs, watch and cron restarts, and webhook alerts
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

//! The one record `shep get` answers with.

use std::fmt;

use serde::Serialize;

use crate::output::Render;

/// One settings read: what the address named, and the TOML it names.
///
/// `Debug` is redacted (IR-41): `toml` is a sheep's or a dog's own settings
/// text, which routinely carries a token inside an `args` value or a home
/// directory inside a `cwd`, and this is what a `{:?}` on a `--format json`
/// run prints.
#[derive(Clone, PartialEq, Eq, Serialize)]
pub struct SettingsAnswer {
    /// `sheep` or `dog`: which half of the flock the address named.
    pub kind: &'static str,
    /// The name the address named, spelled as the flock spells it.
    pub name: String,
    /// The path inside those settings, spelled as the address spelled it.
    /// Empty for a read of everything the name holds.
    pub path: String,
    /// The answer, as TOML text.
    pub toml: String,
}

impl fmt::Debug for SettingsAnswer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "SettingsAnswer {{ kind: {:?}, name: {:?}, path: {:?}, toml: <{} bytes> }}",
            self.kind,
            self.name,
            self.path,
            self.toml.len()
        )
    }
}

/// `shep get`'s answer is a TOML document, so `Format::Table` writes it
/// straight to stdout and this impl is reached only by `Format::Json`. It
/// exists for [`SecretValueRow`](super::SecretValueRow)'s reason: `--format
/// json` is one envelope per invocation for every verb but `bleats`, and the
/// envelope is built by [`Render`]. The columns are what those three fields
/// would be at a terminal, not a rendering any operator sees.
impl Render for SettingsAnswer {
    fn headers() -> &'static [&'static str] {
        &["NAME", "KIND", "PATH"]
    }

    fn rows(&self) -> Vec<Vec<String>> {
        vec![vec![
            self.name.clone(),
            self.kind.to_string(),
            self.path.clone(),
        ]]
    }

    // The answer itself: a TOML document has no columns, and a cell would
    // flatten the newlines that make it one.
    const JSON_ONLY: &'static [&'static str] = &["toml"];

    // NAME is the identity the address named; the two describing it drop
    // first.
    const PRIORITIES: &'static [u8] = &[0, 6, 6];
}

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

    #[test]
    fn settings_answer_matches_its_json_keys() {
        let answer = SettingsAnswer {
            kind: "sheep",
            name: "api".to_string(),
            path: "max_memory".to_string(),
            toml: "max_memory = 1073741824\n".to_string(),
        };
        assert_no_drift(&answer, |json| json, &[]);
    }

    /// The redaction this type's own doc claims, pinned as an exact string so
    /// a `derive(Debug)` refactor fails CI rather than shipping the settings
    /// text into a log (IR-41).
    #[test]
    fn settings_answer_debug_prints_a_byte_count_and_never_the_toml() {
        let answer = SettingsAnswer {
            kind: "dog",
            name: "kelpie".to_string(),
            path: "worker".to_string(),
            toml: "[worker]\ntoken = \"hunter2\"\n".to_string(),
        };
        assert_eq!(
            format!("{answer:?}"),
            "SettingsAnswer { kind: \"dog\", name: \"kelpie\", path: \"worker\", toml: <27 bytes> }"
        );
    }
}