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
102
103
104
105
106
107

//! The record `[daemon.dog_grants.<name>]` keeps of a dog's upgrade path:
//! what waits for approval, what was revoked, and whether the operator has
//! looked.

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

fn record() -> GrantRecord {
    GrantRecord {
        granted: Grants::new([Permission::FlockRead]),
        waiting: Grants::new([Permission::Events("process.".to_string())]),
        revoked: Grants::new([Permission::LogsRead]),
        reviewed: false,
    }
}

#[test]
fn a_record_reads_back_what_was_written() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");

    ShepToml::try_edit(&path, |cfg| cfg.set_grant_record("otel", &record())).unwrap();

    assert_eq!(
        ShepToml::read_only(&path)
            .unwrap()
            .grant_record("otel")
            .unwrap(),
        Some(record())
    );
}

#[test]
fn a_clear_record_writes_only_granted() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");
    let granted = Grants::new([Permission::FlockRead]);

    ShepToml::try_edit(&path, |cfg| cfg.set_granted("otel", &granted)).unwrap();

    assert_eq!(
        std::fs::read_to_string(&path).unwrap(),
        "[daemon]\n\n[daemon.dog_grants.otel]\ngranted = [\"flock.read\"]\n"
    );
    assert_eq!(
        ShepToml::read_only(&path)
            .unwrap()
            .grant_record("otel")
            .unwrap(),
        Some(GrantRecord::reviewed(granted))
    );
}

#[test]
fn the_marks_are_written_only_when_they_say_something() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");

    ShepToml::try_edit(&path, |cfg| cfg.set_grant_record("otel", &record())).unwrap();

    assert_eq!(
        std::fs::read_to_string(&path).unwrap(),
        "[daemon]\n\n\
         [daemon.dog_grants.otel]\n\
         granted = [\"flock.read\"]\n\
         waiting = [\"events:process.\"]\n\
         revoked = [\"logs.read\"]\n\
         reviewed = false\n"
    );
}

#[test]
fn a_reviewed_that_is_not_a_bool_is_refused_as_the_boot_refuses_it() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");
    std::fs::write(
        &path,
        "[daemon.dog_grants.otel]\ngranted = []\nreviewed = \"no\"\n",
    )
    .unwrap();

    let err = ShepToml::read_only(&path)
        .unwrap()
        .grant_record("otel")
        .unwrap_err();

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

#[test]
fn a_misspelt_waiting_permission_is_refused_naming_it() {
    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("shep.toml");
    std::fs::write(
        &path,
        "[daemon.dog_grants.otel]\ngranted = []\nwaiting = [\"flock.reed\"]\n",
    )
    .unwrap();

    let err = ShepToml::read_only(&path)
        .unwrap()
        .grant_record("otel")
        .unwrap_err();

    assert!(err.to_string().contains("flock.reed"), "{err}");
}