balls 0.5.7

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

//! Tests for `bl conf` reads (bl-c2de) — the §4 key namespace, per-layer
//! resolution with provenance, the §12 remote ladder's read, and the
//! dump/single-key dispatch.

use super::*;
use crate::layout::Xdg;
use crate::substrate;
use std::fs;
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,
    }
}

/// Found the substrate (a seeded landing — `balls.toml` carries the standard
/// values, the plugin-less box prunes every `[hooks]` entry) for `e`.
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
}

fn args(a: &[&str]) -> Vec<String> {
    a.iter().map(ToString::to_string).collect()
}

fn user_file(e: &Edge, name: &str, body: &str) {
    let path = e.xdg.user_config().with_file_name(name);
    fs::create_dir_all(path.parent().unwrap()).unwrap();
    fs::write(path, body).unwrap();
}

fn landing_file(clone: &CloneDir, name: &str, body: &str) {
    fs::write(clone.landing().join("config").join(name), body).unwrap();
}

/// Resolve one key to its `(value, layer)` pair.
fn res(e: &Edge, clone: &CloneDir, key: &str) -> (String, String) {
    let r = prov::resolve(e, clone, &Key::parse(key, &Hooks::default()).unwrap()).unwrap();
    (r.value, r.layer)
}

#[test]
fn the_key_namespace_accepts_each_home_and_rejects_the_rest() {
    let none = Hooks::default();
    for ok in ["task-remote", "task-branch", "log-level", "claim.pre", "close.post", "show", "list"] {
        assert!(Key::parse(ok, &none).is_ok(), "{ok} should parse");
    }
    // No such key; `conf` is chainless; reads dispatch BARE keys (§6), so a
    // phased read key and a bare phased-op key are both refused.
    for bad in ["frob", "conf.pre", "show.pre", "list.post", "claim.mid", "claim"] {
        let err = Key::parse(bad, &none).unwrap_err().to_string();
        assert!(err.contains("unknown key"), "{bad}: {err}");
    }
    // bl-03a1: a key the slot-grammar rejects but the schedule already WIRES is
    // valid — so what the dump surfaces stays reachable (a retired-verb hook
    // like `drop.post`), while the same token absent from the schedule is still
    // refused (a typo can't mint dead wiring).
    let wired = Hooks::parse("[hooks]\n\"drop.post\" = [\"bl-delivery\"]\n").unwrap();
    assert!(Key::parse("drop.post", &wired).is_ok(), "a wired retired-verb key parses");
    assert!(Key::parse("drop.post", &none).unwrap_err().to_string().contains("unknown key"));
}

#[test]
fn conf_requires_a_founded_checkout() {
    let tmp = TempDir::new().unwrap();
    let err = run(&edge(&tmp), &[]).unwrap_err().to_string();
    assert!(err.contains("run `bl prime` first"), "{err}");
}

#[test]
fn a_scalar_resolves_innermost_wins_and_names_the_layer() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    // The seed wrote the standard values onto the landing.
    assert_eq!(res(&e, &clone, "task-branch"), ("balls/tasks".into(), "landing".into()));
    // The per-machine XDG layer outranks the landing (§4 layer 2 over 3).
    user_file(&e, "config.toml", "tasks_branch = \"balls/x\"\n");
    assert_eq!(res(&e, &clone, "task-branch"), ("balls/x".into(), "xdg".into()));
    // No layer sets it → the serde default answers.
    user_file(&e, "config.toml", "");
    landing_file(&clone, "balls.toml", "");
    assert_eq!(res(&e, &clone, "task-branch"), ("balls/tasks".into(), "default".into()));
}

#[test]
fn the_log_level_cli_tier_outranks_every_file_layer() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    assert_eq!(res(&e, &clone, "log-level"), ("info".into(), "landing".into()));
    let cli = Edge { log_level: Some("debug".into()), ..e };
    assert_eq!(res(&cli, &clone, "log-level"), ("debug".into(), "cli".into()));
}

#[test]
fn task_remote_reads_the_durable_ladder_and_shows_stealth() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    // No XDG remote, no project origin → visible stealth (bl-d234).
    assert_eq!(res(&e, &clone, "task-remote"), ("(none)".into(), "stealth".into()));
    // A project repo with an `origin` is the bottom durable tier (§12).
    fs::create_dir_all(&e.invocation_path).unwrap();
    crate::git::run(&e.invocation_path, &["init", "-q"], None).unwrap();
    crate::git::run(&e.invocation_path, &["remote", "add", "origin", "git@hub:o"], None).unwrap();
    assert_eq!(res(&e, &clone, "task-remote"), ("git@hub:o".into(), "origin".into()));
    // The legacy global XDG remote outranks origin, labelled `xdg (global)` so a
    // per-machine value is told apart from a per-clone one (bl-d081).
    user_file(&e, "config.toml", "remote = \"git@hub:x\"\n");
    assert_eq!(res(&e, &clone, "task-remote"), ("git@hub:x".into(), "xdg (global)".into()));
    // The per-clone binding remote outranks the legacy global one — the durable
    // per-checkout home that can never shadow another repo (bl-d081).
    fs::write(clone.binding(), "remote = \"git@hub:b\"\n").unwrap();
    assert_eq!(res(&e, &clone, "task-remote"), ("git@hub:b".into(), "binding".into()));
    // A landing sentinel outranks all: DECLARED stealth, distinct from the
    // nothing-set readout above (bl-9df0 — three no-remote provenances).
    let balls_toml = clone.landing().join("config").join("balls.toml");
    let mut body = fs::read_to_string(&balls_toml).unwrap_or_default();
    body.push_str("task_remote = \"none\"\n");
    fs::write(&balls_toml, body).unwrap();
    assert_eq!(res(&e, &clone, "task-remote"), ("(none)".into(), "landing".into()));
}

#[test]
fn a_hooks_key_resolves_the_composed_list_and_names_its_layers() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    landing_file(&clone, "plugins.toml", "[hooks]\n\"close.pre\" = [\"x\", \"y\"]\n");
    assert_eq!(res(&e, &clone, "close.pre"), ("x, y".into(), "landing".into()));
    // An XDG directive composes with the landing list — both layers answer.
    user_file(&e, "plugins.toml", "[hooks]\n\"close.pre_append\" = [\"z\"]\n\"claim.post\" = [\"w\"]\n");
    assert_eq!(res(&e, &clone, "close.pre"), ("x, y, z".into(), "landing+xdg".into()));
    assert_eq!(res(&e, &clone, "claim.post"), ("w".into(), "xdg".into()));
    // An unwired key reads empty, from no layer.
    assert_eq!(res(&e, &clone, "update.pre"), ("(none)".into(), "default".into()));
}

#[test]
fn a_non_table_hooks_entry_mentions_nothing() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    landing_file(&clone, "plugins.toml", "hooks = \"nope\"\n");
    assert_eq!(res(&e, &clone, "close.pre"), ("(none)".into(), "default".into()));
}

#[test]
fn the_dump_renders_scalars_hook_rows_and_paths() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    // One filled list and one emptied one — the latter renders `(none)`.
    landing_file(&clone, "plugins.toml", "[hooks]\n\"close.pre\" = [\"x\"]\n\"claim.post\" = []\n");
    run(&e, &[]).unwrap();
}

#[test]
fn the_dump_grows_an_unbound_row_per_dangling_name_with_its_hint() {
    // bl-5b09's doctor surface on the existing verb: each referenced name that
    // resolves to no bin/<name> gets an `unbound` row — its [source] hint, or
    // `(no source given)` when none is authored. Bound-state is derived at
    // read; all bound ⇒ no rows (the general path with empty inputs, exercised
    // by the plain dump test above once nothing is referenced).
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    let clone = founded(&e);
    landing_file(
        &clone,
        "plugins.toml",
        "[hooks]\n\"close.pre\" = [\"hinted\", \"hintless\"]\n[source]\nhinted = \"cargo install hinted\"\n",
    );
    run(&e, &[]).unwrap();
}

#[test]
fn a_single_key_read_resolves_and_rejects_stray_values() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    founded(&e);
    run(&e, &args(&["task-branch"])).unwrap();
    let err = run(&e, &args(&["bogus"])).unwrap_err().to_string();
    assert!(err.contains("unknown key"), "{err}");
    let err = run(&e, &args(&["task-branch", "extra"])).unwrap_err().to_string();
    assert!(err.contains("takes no value on a read"), "{err}");
}

#[test]
fn the_conf_verb_dispatches_through_the_front_door() {
    let tmp = TempDir::new().unwrap();
    let e = edge(&tmp);
    assert_eq!(crate::run(&e, &args(&["conf"])), 1); // not founded → op error
    founded(&e);
    assert_eq!(crate::run(&e, &args(&["conf"])), 0);
}