yog 0.0.65

yog: the standalone server for litany loops — the world, the balls and the conversations, behind one wire
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

//! Tests for the `--editor-apply` shim (§9.3): the pure copy fn (nested
//! dirs, only-staged files, symlink hygiene, empty staging) and the
//! [`run_shim`] exit-code mapping (both missing inputs, a copy error, and
//! the happy path).

use super::*;
use std::fs;
#[cfg(unix)]
use std::os::unix::fs::symlink;
use tempfile::tempdir;

/// Read a file under `root` as UTF-8, panicking with the path on absence.
fn read(root: &Path, rel: &str) -> String {
    fs::read_to_string(root.join(rel)).unwrap_or_else(|_| panic!("missing {rel}"))
}

#[test]
fn copies_nested_files_preserving_structure() {
    let dir = tempdir().unwrap();
    let staging = dir.path().join("stage");
    let checkout = dir.path().join("checkout");
    fs::create_dir_all(staging.join("souls")).unwrap();
    fs::write(staging.join("workflow.yaml"), b"wf").unwrap();
    fs::write(staging.join("souls/coder.md"), b"soul").unwrap();

    let written = copy_staged(&staging, &checkout).unwrap();

    assert_eq!(
        written,
        vec![
            PathBuf::from("souls/coder.md"),
            PathBuf::from("workflow.yaml")
        ]
    );
    assert_eq!(read(&checkout, "workflow.yaml"), "wf");
    assert_eq!(read(&checkout, "souls/coder.md"), "soul");
}

#[test]
fn never_deletes_unstaged_checkout_files() {
    // The invariant that protects litany's freshly-refreshed descriptions/**:
    // a file present in the checkout but absent from staging survives, and a
    // staged file overwrites its checkout counterpart.
    let dir = tempdir().unwrap();
    let staging = dir.path().join("stage");
    let checkout = dir.path().join("checkout");
    fs::create_dir_all(checkout.join("descriptions")).unwrap();
    fs::write(checkout.join("descriptions/pool.md"), b"litany-refreshed").unwrap();
    fs::write(checkout.join("workflow.yaml"), b"old").unwrap();
    fs::create_dir_all(&staging).unwrap();
    fs::write(staging.join("workflow.yaml"), b"new").unwrap();

    let written = copy_staged(&staging, &checkout).unwrap();

    assert_eq!(written, vec![PathBuf::from("workflow.yaml")]);
    assert_eq!(read(&checkout, "descriptions/pool.md"), "litany-refreshed");
    assert_eq!(read(&checkout, "workflow.yaml"), "new");
}

#[cfg(unix)]
#[test]
fn skips_symlinks_in_staging() {
    let dir = tempdir().unwrap();
    let staging = dir.path().join("stage");
    let checkout = dir.path().join("checkout");
    fs::create_dir_all(&staging).unwrap();
    fs::write(dir.path().join("outside-secret"), b"secret").unwrap();
    fs::write(staging.join("providers.yaml"), b"pv").unwrap();
    // A symlink pointing outside staging must not be followed or reproduced.
    symlink(dir.path().join("outside-secret"), staging.join("link")).unwrap();

    let written = copy_staged(&staging, &checkout).unwrap();

    assert_eq!(written, vec![PathBuf::from("providers.yaml")]);
    assert!(!checkout.join("link").exists());
}

#[test]
fn empty_staging_copies_nothing() {
    let dir = tempdir().unwrap();
    let staging = dir.path().join("stage");
    let checkout = dir.path().join("checkout");
    fs::create_dir_all(&staging).unwrap();

    let written = copy_staged(&staging, &checkout).unwrap();

    assert!(written.is_empty());
    assert!(!checkout.exists());
}

#[test]
fn run_shim_ok_copies_and_returns_zero() {
    let dir = tempdir().unwrap();
    let staging = dir.path().join("stage");
    let checkout = dir.path().join("checkout");
    fs::create_dir_all(&staging).unwrap();
    fs::write(staging.join("version"), b"2").unwrap();

    let code = run_shim(
        Some(staging.display().to_string()),
        Some(checkout.display().to_string()),
    );

    assert_eq!(code, 0);
    assert_eq!(read(&checkout, "version"), "2");
}

#[test]
fn run_shim_missing_edit_src_is_nonzero() {
    assert_eq!(run_shim(None, Some("/some/checkout".into())), 1);
    // Empty reads as absent, too.
    assert_eq!(
        run_shim(Some(String::new()), Some("/some/checkout".into())),
        1
    );
}

#[test]
fn run_shim_missing_checkout_is_nonzero() {
    assert_eq!(run_shim(Some("/some/stage".into()), None), 1);
    assert_eq!(run_shim(Some("/some/stage".into()), Some(String::new())), 1);
}

#[test]
fn run_shim_copy_error_is_nonzero() {
    // A staging dir that does not exist makes the first read_dir fail.
    let dir = tempdir().unwrap();
    let code = run_shim(
        Some(dir.path().join("nonexistent").display().to_string()),
        Some(dir.path().join("checkout").display().to_string()),
    );
    assert_eq!(code, 1);
}