balls 0.5.9

Git-native task tracker for parallel agent workflows
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

//! Tests for `bl conf` writes (bl-c2de) — each key's canonical home, the
//! landing seal with its no-change convergence, the per-clone binding edit
//! (bl-d081), and the §4 list compose applied at write time.

use crate::conf;
use crate::edge::Edge;
use crate::git;
use crate::layout::{CloneDir, Xdg};
use crate::substrate;
use std::fs;
use std::os::unix::fs::PermissionsExt;
use std::path::Path;
use tempfile::TempDir;

fn edge(tmp: &TempDir) -> Edge {
    Edge {
        xdg: Xdg::with(tmp.path(), None, Some(&tmp.path().join("state").to_string_lossy())),
        invocation_path: tmp.path().join("proj"),
        default_actor: "tester".into(),
        depth: 0,
        exe_dir: None,
        path_dirs: Vec::new(),
        color: false,
        log_level: None,
        balls_clock: None,
    }
}

fn founded(e: &Edge) -> CloneDir {
    let clone = e.xdg.clone_dir(&e.invocation_path);
    substrate::found(&clone.landing(), &clone.store(), &e.xdg, None).unwrap();
    clone
}

/// Run `bl conf <argv>` through the verb's own dispatch.
fn conf(e: &Edge, argv: &[&str]) -> std::io::Result<()> {
    conf::run(e, &argv.iter().map(ToString::to_string).collect::<Vec<_>>())
}

fn commits(landing: &Path) -> usize {
    git::run(landing, &["rev-list", "--count", "HEAD"], None).unwrap().trim().parse().unwrap()
}

fn subject(landing: &Path) -> String {
    git::run(landing, &["log", "-1", "--format=%s"], None).unwrap().trim().to_string()
}

/// Is any `binding.toml.<pid>.tmp` staging file left in the clone bundle? The
/// atomic replace's temp must never outlive the write, landed or failed.
fn temps_beside(clone: &CloneDir) -> bool {
    fs::read_dir(clone.root())
        .unwrap()
        .any(|entry| entry.unwrap().file_name().to_string_lossy().ends_with(".tmp"))
}

fn landing_text(clone: &CloneDir, name: &str) -> String {
    fs::read_to_string(clone.landing().join("config").join(name)).unwrap()
}

#[test]
fn set_task_branch_seals_one_commit_and_converges_on_a_repeat() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    let before = commits(&clone.landing());
    conf(&e, &["set", "task-branch", "balls/x"]).unwrap();
    assert!(landing_text(&clone, "balls.toml").contains("tasks_branch = \"balls/x\""));
    assert_eq!(commits(&clone.landing()), before + 1);
    assert_eq!(subject(&clone.landing()), "balls: conf set task-branch balls/x");
    // The same value again is the §13 no-op converge — nothing new seals.
    conf(&e, &["set", "task-branch", "balls/x"]).unwrap();
    assert_eq!(commits(&clone.landing()), before + 1);
}

#[test]
fn set_task_branch_to_the_landing_is_refused_and_writes_nothing() {
    // §2/§4 (bl-ac89): the coincident name is refused at the front door — same
    // write-time validation precedent as log-level's ladder check. Nothing is
    // written and nothing seals, so the checkout is never poisoned.
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    let before = commits(&clone.landing());
    let err = conf(&e, &["set", "task-branch", "balls/config"]).unwrap_err().to_string();
    assert!(err.contains("names the landing"), "{err}");
    assert_eq!(commits(&clone.landing()), before);
}

#[test]
fn a_conf_seal_carries_the_checkout_scoped_trailers() {
    // §5: checkout-scoped seals carry bl-protocol/bl-op/bl-actor — only bl-id
    // (which names a single ball) is absent (bl-1d9b).
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    conf(&e, &["set", "task-branch", "balls/x"]).unwrap();
    let msg = git::run(&clone.landing(), &["log", "-1", "--format=%B"], None).unwrap();
    let md = crate::message::parse(&msg).unwrap();
    assert_eq!(md["bl-protocol"], ["1"], "{msg}");
    assert_eq!(md["bl-op"], ["conf"], "{msg}");
    assert_eq!(md["bl-actor"], ["tester"], "{msg}");
    assert!(!md.contains_key("bl-id"), "{msg}");
}

#[test]
fn set_log_level_validates_against_the_ladder() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    assert!(conf(&e, &["set", "log-level", "noisy"]).is_err()); // not a level
    conf(&e, &["set", "log-level", "debug"]).unwrap();
    assert!(landing_text(&clone, "balls.toml").contains("log_level = \"debug\""));
}

#[test]
fn set_task_remote_writes_the_per_clone_binding_preserving_other_keys() {
    // bl-d081: a URL's durable home is THIS clone's binding.toml (per-checkout
    // local state), not the machine-wide XDG file that silently shadowed every
    // other repo's store.
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    // Works with no binding file yet (file created)…
    conf(&e, &["set", "task-remote", "git@hub:r"]).unwrap();
    let body = fs::read_to_string(clone.binding()).unwrap();
    assert!(body.contains("remote = \"git@hub:r\""), "{body}");
    // …and edits ONE key when one exists, the rest round-tripping.
    fs::write(clone.binding(), "tasks_branch = \"balls/x\"\nremote = \"old\"\n").unwrap();
    conf(&e, &["set", "task-remote", "git@hub:new"]).unwrap();
    let body = fs::read_to_string(clone.binding()).unwrap();
    assert!(body.contains("remote = \"git@hub:new\"") && body.contains("tasks_branch = \"balls/x\""), "{body}");
    // The machine-wide XDG file is NEVER touched — no cross-repo shadowing.
    assert!(!e.xdg.user_config().exists(), "the global XDG config must not be written");
}

#[test]
fn set_clock_provider_writes_the_per_clone_binding_not_the_landing() {
    // bl-cfe3: the op-clock provider is a DIRECTLY-SET local value in the
    // per-clone binding.toml — box-local, never a landing field, never travels on
    // `install`. So the write touches NO landing commit (unlike task-branch), and
    // it edits ONE key with every other binding key round-tripping.
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    let before = commits(&clone.landing());
    conf(&e, &["set", "clock-provider", "/opt/bl-workhours"]).unwrap();
    let body = fs::read_to_string(clone.binding()).unwrap();
    assert!(body.contains("clock_provider = \"/opt/bl-workhours\""), "{body}");
    assert_eq!(commits(&clone.landing()), before, "a binding write seals no landing commit");
    // Coexists with the store remote in the same binding, each key its own.
    conf(&e, &["set", "task-remote", "git@hub:r"]).unwrap();
    let body = fs::read_to_string(clone.binding()).unwrap();
    assert!(body.contains("clock_provider = \"/opt/bl-workhours\"") && body.contains("remote = \"git@hub:r\""), "{body}");
}

#[test]
fn a_binding_write_replaces_by_rename_so_a_failed_write_loses_nothing() {
    // bl-ffbf: binding.toml is the one balls-owned mutable fact outside git, so
    // it has no seal to CAS against — the replace is made atomic by hand (temp +
    // rename, git's index.lock discipline). A write that cannot land therefore
    // leaves the ESTABLISHED binding whole, where the in-place `fs::write` this
    // replaced would have truncated it to nothing. The clone directory is made
    // unwritable to stand in for the torn write: creating the temp beside the
    // target fails, while an in-place truncate of the (still writable) file
    // would have succeeded — which is exactly the distinction being asserted.
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    conf(&e, &["set", "clock-provider", "/opt/bl-workhours"]).unwrap();
    let established = fs::read_to_string(clone.binding()).unwrap();
    assert!(!temps_beside(&clone), "a landed write leaves no temp behind");

    let denied = fs::Permissions::from_mode(0o555);
    let restored = fs::metadata(clone.root()).unwrap().permissions();
    fs::set_permissions(clone.root(), denied).unwrap();
    let failed = conf(&e, &["set", "clock-provider", "/opt/other"]);
    fs::set_permissions(clone.root(), restored).unwrap();

    assert!(failed.is_err(), "an unwritable clone dir must fail the binding write");
    assert_eq!(fs::read_to_string(clone.binding()).unwrap(), established, "the established binding survived");
    assert!(!temps_beside(&clone), "a failed write leaves no temp behind either");
}

#[test]
fn the_write_grammar_is_enforced() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    founded(&e);
    for (argv, expect) in [
        (vec!["set"], "needs <key>"),
        (vec!["set", "bogus", "v"], "unknown key"),
        (vec!["set", "task-branch", "a", "b"], "exactly one value"),
        (vec!["set", "task-remote"], "exactly one value"),
        (vec!["append", "task-branch", "x"], "is a scalar"),
        (vec!["remove", "log-level", "x"], "is a scalar"),
        (vec!["append", "close.pre"], "exactly one value"),
        (vec!["append", "close.pre", "a", "b"], "exactly one value"),
    ] {
        let err = conf(&e, &argv).unwrap_err().to_string();
        assert!(err.contains(expect), "{argv:?}: {err}");
    }
}

#[test]
fn set_task_remote_sentinel_is_a_landing_policy_write_a_url_clears_it() {
    // bl-9df0: the key's home routes by VALUE. The stealth sentinel is
    // per-checkout policy → a sealed landing edit (what `prime --stealth`
    // sugars to); a URL is per-clone → this clone's binding.toml (bl-d081), AND
    // the sentinel is cleared so the set changes what the ladder actually
    // resolves (the landing rung outranks binding — leaving it would be the
    // bl-d234 trap).
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    conf(&e, &["set", "task-remote", "none"]).unwrap();
    assert!(landing_text(&clone, "balls.toml").contains("task_remote = \"none\""));
    assert_eq!(subject(&clone.landing()), "balls: conf set task-remote none");
    conf(&e, &["set", "task-remote", "git@hub:r"]).unwrap();
    assert!(!landing_text(&clone, "balls.toml").contains("task_remote"));
    assert_eq!(subject(&clone.landing()), "balls: conf set task-remote git@hub:r");
    let binding = fs::read_to_string(clone.binding()).unwrap();
    assert!(binding.contains("remote = \"git@hub:r\""), "{binding}");
}

// The `[hooks]` list-compose writes share this module's edge/founded/conf fixtures.
#[path = "conf_write_hooks_tests.rs"]
mod hooks;