scv-server 0.4.4

Authoritative session and tool server for SCV
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

//! Unit tests for `src/session/persist.rs`.

use super::*;

fn queue(session: &str, owner: ProcessIdentity) -> SavedQueue {
    SavedQueue {
        v: 1,
        session: session.into(),
        label: "TUI".into(),
        workspace: PathBuf::from("/w"),
        owner,
        saved_unix: unix_now(),
        paused: false,
        entries: vec![QueueEntry {
            queue_id: "q1".into(),
            revision: 1,
            prompt: "run the tests".into(),
            submitter: "r1".into(),
            attachments: Vec::new(),
        }],
        active: Some("the long build".into()),
    }
}

fn dead() -> ProcessIdentity {
    // The PID of a process that has exited (this one's child).
    let mut child = std::process::Command::new("true").spawn().unwrap();
    let identity = ProcessIdentity::of(child.id()).unwrap();
    child.wait().unwrap();
    identity
}

#[test]
fn a_saved_queue_reads_back_and_an_empty_one_is_removed() {
    let home = tempfile::tempdir().unwrap();
    let layout = Layout::new(home.path());
    let me = ProcessIdentity::current().unwrap();
    let saved = queue("3f2a-session", me);
    save(&layout, &saved);
    assert_eq!(load(&layout, "3f2a-session"), Some(saved.clone()));
    use std::os::unix::fs::PermissionsExt as _;
    let mode = std::fs::metadata(layout.session_queues().join("3f2a-session.json"))
        .unwrap()
        .permissions()
        .mode();
    assert_eq!(mode & 0o777, 0o600);
    // A session still running here is not restorable.
    assert!(!stopped(&saved));
    assert_eq!(restorable(&layout), []);
    let empty = SavedQueue {
        entries: Vec::new(),
        active: None,
        ..saved
    };
    save(&layout, &empty);
    assert_eq!(load(&layout, "3f2a-session"), None);
}

#[test]
fn only_stopped_sessions_are_restorable_and_old_ones_go() {
    let home = tempfile::tempdir().unwrap();
    let layout = Layout::new(home.path());
    let gone = dead();
    save(&layout, &queue("stopped-1", gone));
    let mut old = queue("stopped-2", gone);
    old.saved_unix = 1;
    save(&layout, &old);
    save(
        &layout,
        &queue("running", ProcessIdentity::current().unwrap()),
    );
    let found = restorable(&layout);
    assert_eq!(found.len(), 1);
    assert_eq!(found[0].id, "stopped-1");
    assert_eq!(found[0].queued, 1);
    assert_eq!(found[0].interrupted.as_deref(), Some("the long build"));
    assert!(load(&layout, "stopped-2").is_none());
    remove(&layout, "stopped-1");
    assert_eq!(restorable(&layout), []);
}

#[test]
fn session_ids_cannot_name_other_files() {
    let home = tempfile::tempdir().unwrap();
    let layout = Layout::new(home.path());
    for bad in ["", "../x", "a/b", "a.json"] {
        assert!(!valid_session(bad), "{bad}");
        assert!(load(&layout, bad).is_none());
    }
    save(
        &layout,
        &queue("../escape", ProcessIdentity::current().unwrap()),
    );
    assert!(!home.path().join("state/escape.json").exists());
    assert!(valid_session("3f2a9c1e-0b7d-4e5f-8a6b-1234567890ab"));
    assert_eq!(active_line(&"x".repeat(400)).chars().count(), 201);
    assert_eq!(
        active_line("Run the checklist.\nThen land it."),
        "Run the checklist.…"
    );
    assert_eq!(active_line("  Fix it.  "), "Fix it.");
}

#[test]
fn a_saved_queue_is_claimed_by_one_restore_at_a_time() {
    let home = tempfile::tempdir().unwrap();
    let layout = Layout::new(home.path());
    save(&layout, &queue("stopped-1", dead()));
    let first = claim(&layout, "stopped-1").unwrap();
    // Another restore gets nothing, and failing does not release the first.
    assert!(claim(&layout, "stopped-1").is_none());
    assert!(claim(&layout, "stopped-1").is_none());
    // The same session in another instance is another queue.
    let other = tempfile::tempdir().unwrap();
    assert!(claim(&Layout::new(other.path()), "stopped-1").is_some());
    assert!(claim(&layout, "../x").is_none());
    // A restore that gave up releases it, the record kept.
    drop(first);
    let second = claim(&layout, "stopped-1").unwrap();
    assert!(load(&layout, "stopped-1").is_some());
    // One that kept the prompts removes the record as it releases it.
    second.remove();
    assert!(load(&layout, "stopped-1").is_none());
    assert!(claim(&layout, "stopped-1").is_some());
}