shep 0.23.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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Reading the grants an operator wrote under `[daemon.dog_grants.<name>]`.

use super::*;
use shep_core::permissions::{Grants, Permission};

fn doc_of(src: &str) -> (tempfile::TempDir, ShepToml) {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");
    std::fs::write(&path, src).unwrap();
    let doc = ShepToml::read_only(&path).unwrap();
    (dir, doc)
}

#[test]
fn a_dog_with_a_grants_entry_reads_what_was_written() {
    let (_dir, doc) =
        doc_of("[daemon.dog_grants.otel]\ngranted = [\"flock.read\", \"events:process.\"]\n");

    assert_eq!(
        doc.granted("otel").unwrap(),
        Some(Grants::new([
            Permission::FlockRead,
            Permission::Events("process.".to_string()),
        ]))
    );
}

#[test]
fn a_dog_with_no_entry_is_undeclared_rather_than_granted_nothing() {
    let (_dir, doc) = doc_of("[daemon.dog_grants.otel]\ngranted = []\n");

    assert_eq!(doc.granted("otel").unwrap(), Some(Grants::default()));
    assert_eq!(doc.granted("bark").unwrap(), None);
}

#[test]
fn a_file_with_no_daemon_table_grants_nothing_to_anyone() {
    let (_dir, doc) = doc_of("");

    assert_eq!(doc.granted("otel").unwrap(), None);
}

#[test]
fn a_misspelt_permission_is_refused_naming_the_dog_and_the_name() {
    let (_dir, doc) =
        doc_of("[daemon.dog_grants.otel]\ngranted = [\"flock.read\", \"flock.reed\"]\n");

    let err = doc.granted("otel").unwrap_err();

    assert!(matches!(err, ShepTomlError::BadGrants { .. }), "{err:?}");
    let shown = err.to_string();
    assert!(
        shown.contains("[daemon.dog_grants.otel] granted"),
        "{shown}"
    );
    assert!(
        shown.contains("`flock.reed` is not a permission shep knows"),
        "{shown}"
    );
}

#[test]
fn an_entry_that_is_not_a_list_of_names_is_refused_rather_than_read_as_undeclared() {
    for src in [
        "[daemon.dog_grants.otel]\ngranted = \"flock.read\"\n",
        "[daemon.dog_grants.otel]\ngranted = [1]\n",
        "[daemon.dog_grants.otel]\ngrant = [\"flock.read\"]\n",
        "[daemon.dog_grants]\notel = \"flock.read\"\n",
    ] {
        let (_dir, doc) = doc_of(src);

        assert!(
            matches!(doc.granted("otel"), Err(ShepTomlError::BadGrants { .. })),
            "{src}"
        );
    }
}

#[test]
fn another_dogs_bad_entry_does_not_refuse_this_dog() {
    let (_dir, doc) = doc_of("[daemon.dog_grants.bark]\ngranted = [\"flock.reed\"]\n");

    assert_eq!(doc.granted("otel").unwrap(), None);
}

#[test]
fn inline_tables_read_the_same_as_headed_ones() {
    for src in [
        "[daemon]\ndog_grants = { otel = { granted = [] } }\n",
        "[daemon.dog_grants]\notel = { granted = [] }\n",
        "daemon = { dog_grants = { otel = { granted = [] } } }\n",
        "[daemon.dog_grants.otel]\ngranted = []\n",
    ] {
        let (_dir, doc) = doc_of(src);

        assert_eq!(
            doc.granted("otel").unwrap(),
            Some(Grants::default()),
            "{src}"
        );
    }
}

#[test]
fn a_misspelt_name_in_an_inline_table_is_refused_too() {
    let (_dir, doc) = doc_of("[daemon]\ndog_grants = { otel = { granted = [\"flock.reed\"] } }\n");

    assert!(matches!(
        doc.granted("otel"),
        Err(ShepTomlError::BadGrants { .. })
    ));
}

#[test]
fn a_key_other_than_granted_is_refused_as_the_boot_refuses_it() {
    let (_dir, doc) =
        doc_of("[daemon.dog_grants.otel]\ngranted = [\"flock.read\"]\nnote = \"x\"\n");

    let err = doc.granted("otel").unwrap_err();

    assert!(matches!(err, ShepTomlError::BadGrants { .. }), "{err:?}");
    assert!(err.to_string().contains("`note`"), "{err}");
}