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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

//! The marks a local listing puts on each dog row, read from `shep.toml`.

use super::access_marks::mark_access;
use crate::commands::shep_toml::{GrantRecord, ShepToml};
use shep_core::paths::ShepPaths;
use shep_core::permissions::{Grants, Permission};
use shep_core::protocol::{DogAccess, DogSource, ProcessInfo};
use shep_core::status::ProcStatus;

fn paths() -> (tempfile::TempDir, ShepPaths) {
    let dir = tempfile::tempdir().unwrap();
    let paths = ShepPaths::resolve(&|_| None, dir.path());
    (dir, paths)
}

fn dog(name: &str, grants: Option<Grants>) -> ProcessInfo {
    ProcessInfo::builder(1, name, ProcStatus::Online)
        .dog(Some(DogSource::BuiltIn { grants }))
        .build()
}

fn record(paths: &ShepPaths, name: &str, record: &GrantRecord) {
    ShepToml::try_edit(&paths.daemon_config, |cfg| {
        cfg.set_grant_record(name, record)
    })
    .unwrap();
}

fn read_only() -> Grants {
    Grants::new([Permission::FlockRead])
}

#[test]
fn a_dog_with_no_grants_is_marked_undeclared() {
    let (_dir, paths) = paths();
    let mut rows = vec![dog("otel", None)];

    mark_access(&mut rows, &paths);

    assert_eq!(
        rows[0].access,
        Some(DogAccess {
            undeclared: true,
            ..DogAccess::default()
        })
    );
}

#[test]
fn a_disabled_dog_with_no_grants_is_not_running_with_full_access() {
    let (_dir, paths) = paths();
    let mut rows = vec![
        ProcessInfo::builder(1, "bark", ProcStatus::Stopped)
            .dog(Some(DogSource::BuiltIn { grants: None }))
            .disabled(Some(true))
            .build(),
    ];

    mark_access(&mut rows, &paths);

    assert_eq!(rows[0].access, Some(DogAccess::default()));
}

#[test]
fn a_list_written_at_upgrade_is_marked_not_reviewed() {
    let (_dir, paths) = paths();
    record(&paths, "otel", &GrantRecord::at_upgrade(read_only()));
    let mut rows = vec![dog("otel", Some(read_only()))];

    mark_access(&mut rows, &paths);

    assert_eq!(
        rows[0].access,
        Some(DogAccess {
            not_reviewed: true,
            ..DogAccess::default()
        })
    );
}

#[test]
fn permissions_waiting_for_approval_are_named() {
    let (_dir, paths) = paths();
    record(
        &paths,
        "otel",
        &GrantRecord {
            waiting: Grants::new([Permission::LogsRead]),
            ..GrantRecord::reviewed(read_only())
        },
    );
    let mut rows = vec![dog("otel", Some(read_only()))];

    mark_access(&mut rows, &paths);

    assert_eq!(
        rows[0].access,
        Some(DogAccess {
            waiting: vec!["logs.read".to_owned()],
            ..DogAccess::default()
        })
    );
}

#[test]
fn a_reviewed_dog_carries_clear_marks() {
    let (_dir, paths) = paths();
    record(&paths, "otel", &GrantRecord::reviewed(read_only()));
    let mut rows = vec![dog("otel", Some(read_only()))];

    mark_access(&mut rows, &paths);

    assert_eq!(rows[0].access, Some(DogAccess::default()));
}

#[test]
fn a_sheep_is_left_unmarked() {
    let (_dir, paths) = paths();
    let mut rows = vec![ProcessInfo::builder(2, "web", ProcStatus::Online).build()];

    mark_access(&mut rows, &paths);

    assert_eq!(rows[0].access, None);
}

#[test]
fn an_unreadable_shep_toml_leaves_the_listing_as_it_came() {
    let (_dir, paths) = paths();
    std::fs::create_dir_all(&paths.home).unwrap();
    std::fs::write(&paths.daemon_config, "[daemon\n").unwrap();
    let mut rows = vec![dog("otel", Some(read_only()))];

    mark_access(&mut rows, &paths);

    assert_eq!(rows[0].access, None);
}