magi/config.rs
1//! Run configuration: the agent roster, the shape of the graph, and the
2//! blindness / verification policy.
3//!
4//! Layers, lowest precedence first: `<config_dir>/magi/config.toml` (machine),
5//! `.magi/config.toml`, `magi.toml`. With none, built-in defaults apply, the
6//! agent roster derived from the agent CLIs actually installed on this
7//! machine. `--config <path>` replaces the whole stack with that one file.
8//!
9//! **The repository layers are read from `<remote>/<base>`, never from the
10//! working tree.** A primary checkout is often stale or on a detached HEAD, so
11//! a gate read from it can be older than the one the branch under review is
12//! cut from (run ce6e failed on a gate step `origin/main` had already
13//! dropped). `git show <sha>:magi.toml` of the remote-tracking ref's commit is
14//! written to a content-addressed directory under the git common dir
15//! (`<common>/magi/config/<sha>-<hash of repo>/`, temp dir when that is not
16//! writable) and loaded from there.
17//!
18//! `remote` and `base` are themselves in the file, so they are resolved in a
19//! fixed order, first hit wins:
20//!
21//! 1. `[merge] base` / `remote` of the machine layer, rendered as a real load
22//! would (env templates, includes);
23//! 2. the same keys, read minimally (only `[merge]`, nothing deserialized into
24//! `Config`) from the checkout's `magi.toml`, then `.magi/config.toml` -
25//! only to *locate* the ref; an unreadable file is ignored;
26//! 3. `remote` defaults to `origin`, `base` to what
27//! `refs/remotes/<remote>/HEAD` points at.
28//!
29//! [`Config::discover`] is synchronous and reads the remote-tracking ref as it
30//! is (`daemon::fetch_loop` keeps it fresh); [`Config::discover_fetched`] runs
31//! `git fetch` first and is what every path that starts work uses. A failed
32//! fetch, a missing ref or an unresolvable base is an **error**, never a
33//! silent fall back to the working tree or a local branch. Two cases are not
34//! that: an explicit `--config`, and a `repo` that is not a git working tree
35//! at all (no branch exists, so nothing can be stale).
36//!
37//! A repository layer that declares `include = [...]` gets the whole tree of
38//! that commit extracted, so relative includes resolve against the same
39//! commit. The directory is built beside its name and renamed in, so a
40//! concurrent `discover` never reads a half-written layer.
41use std::collections::BTreeMap;
42use std::path::{Path, PathBuf};
43
44use anyhow::{Context as _, Result, bail};
45use serde::{Deserialize, Serialize};
46
47/// Which CLI drives an agent.
48#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
49#[serde(rename_all = "lowercase")]
50pub enum AgentKind {
51 /// Anthropic Claude Code (`claude -p`).
52 Claude,
53 /// opencode (`opencode run`).
54 Opencode,
55 /// Antigravity CLI (`agy -p`). Gemini CLI is deliberately absent: Google
56 /// retired the standalone client for individual accounts in favour of this
57 /// one, so an adapter for it would be dead code on a live machine.
58 Antigravity,
59 /// OpenAI Codex CLI (`codex exec`). The one roster member with a real
60 /// read-only mode: `--sandbox read-only` is enforced by the CLI, not by
61 /// the prompt.
62 Codex,
63 /// oh-my-pi (`omp -p --mode=json`). Another CLI with no read-only mode of
64 /// its own - `--auto-approve` gates reads and writes together - so a
65 /// read-only seat rests on the prompt and on the worktree discipline the
66 /// other non-codex seats already rely on. It is also the roster member that
67 /// reaches DeepSeek, whose models ship in `omp`'s own catalog.
68 Omp,
69 /// Arbitrary command. The escape hatch, and what the test suite drives.
70 Command,
71}
72
73impl AgentKind {
74 /// Executable that must be on `PATH` for this kind, if any.
75 pub fn program(self) -> Option<&'static str> {
76 match self {
77 Self::Claude => Some("claude"),
78 Self::Opencode => Some("opencode"),
79 Self::Antigravity => Some("agy"),
80 Self::Codex => Some("codex"),
81 Self::Omp => Some("omp"),
82 Self::Command => None,
83 }
84 }
85
86 /// Lowercase name as written in the config file.
87 pub fn as_str(self) -> &'static str {
88 match self {
89 Self::Claude => "claude",
90 Self::Opencode => "opencode",
91 Self::Antigravity => "antigravity",
92 Self::Codex => "codex",
93 Self::Omp => "omp",
94 Self::Command => "command",
95 }
96 }
97
98 /// Every kind the roster can name, in display order.
99 ///
100 /// This is what `magi doctor` lists, and it has to be one list rather than
101 /// the same set typed out again wherever a kind is enumerated. The last
102 /// time it was typed out twice, `omp` was added as a roster member and the
103 /// doctor output went on saying the machine had four CLIs - which reads as
104 /// "that agent is not installed" to the person the command exists for.
105 pub const ALL: [Self; 6] = [
106 Self::Claude,
107 Self::Opencode,
108 Self::Antigravity,
109 Self::Codex,
110 Self::Omp,
111 Self::Command,
112 ];
113}
114
115/// How the prompt reaches the agent process.
116#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
117#[serde(rename_all = "lowercase")]
118pub enum Delivery {
119 /// Piped on stdin.
120 Stdin,
121 /// Passed as a positional argument. Beware OS command-line limits.
122 Argv,
123 /// Written to a file; the agent is told to read it. No length limit.
124 File,
125}
126
127/// One addressable agent in the roster.
128#[derive(Debug, Clone, Deserialize, Serialize)]
129#[serde(deny_unknown_fields)]
130pub struct AgentSpec {
131 /// Stable identifier used by `[roles]` and by the stats tables.
132 pub id: String,
133 /// Which CLI to drive.
134 pub kind: AgentKind,
135 /// Model passed through to the CLI (`--model` / `-m`). CLI default if unset.
136 #[serde(default)]
137 pub model: Option<String>,
138 /// `kind = "command"` only: argv. Supports `{prompt_file}`, `{cwd}`,
139 /// `{label}`, `{session}` placeholders.
140 #[serde(default)]
141 pub command: Vec<String>,
142 /// Extra arguments appended to the built command line.
143 #[serde(default)]
144 pub extra_args: Vec<String>,
145 /// Extra environment variables for the child process.
146 #[serde(default)]
147 pub env: BTreeMap<String, String>,
148 /// Override the per-kind prompt delivery default.
149 #[serde(default)]
150 pub prompt_delivery: Option<Delivery>,
151}
152
153impl AgentSpec {
154 /// Default prompt delivery for this agent.
155 ///
156 /// `opencode` and `agy` take the prompt as an argument, which on Windows
157 /// caps out around 32 KiB — well under a judging prompt carrying three
158 /// patches — so both get a file instead.
159 pub fn delivery(&self) -> Delivery {
160 self.prompt_delivery.unwrap_or(match self.kind {
161 AgentKind::Claude | AgentKind::Command => Delivery::Stdin,
162 // `codex exec -` reads the prompt from stdin, so the whole
163 // instruction arrives without an argv length limit and without a
164 // tool round-trip to open a file.
165 AgentKind::Codex => Delivery::Stdin,
166 // `omp -p` reads the prompt from stdin too, and a judging prompt
167 // carrying three patches is well past the Windows argv cap, so this
168 // is the only delivery that works for every node.
169 AgentKind::Omp => Delivery::Stdin,
170 AgentKind::Opencode | AgentKind::Antigravity => Delivery::File,
171 })
172 }
173
174 /// Human-facing label, e.g. `opus (claude:opus)`.
175 pub fn display(&self) -> String {
176 match &self.model {
177 Some(m) => format!("{} ({}:{m})", self.id, self.kind.as_str()),
178 None => format!("{} ({})", self.id, self.kind.as_str()),
179 }
180 }
181}
182
183/// A standalone seat's agent: one roster id, or an ordered fallback chain.
184///
185/// The string form is what every existing config uses and serializes back as
186/// a string; the array form tries each id at most once, in order, moving on
187/// when a call ends in quota or fails (see [`crate::agent::pick_chain`]).
188/// An empty string or array is the same as unset.
189#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
190#[serde(untagged)]
191pub enum AgentChoice {
192 /// One agent id.
193 One(String),
194 /// Ordered fallback chain of agent ids.
195 Chain(Vec<String>),
196}
197
198impl AgentChoice {
199 /// The ids named, in order, with blanks dropped. Empty means unset.
200 pub fn ids(&self) -> Vec<&str> {
201 let all: Vec<&str> = match self {
202 Self::One(id) => vec![id.as_str()],
203 Self::Chain(ids) => ids.iter().map(String::as_str).collect(),
204 };
205 all.into_iter()
206 .map(str::trim)
207 .filter(|id| !id.is_empty())
208 .collect()
209 }
210
211 /// The first id named, if any.
212 pub fn primary(&self) -> Option<&str> {
213 self.ids().into_iter().next()
214 }
215}
216
217impl From<&str> for AgentChoice {
218 fn from(id: &str) -> Self {
219 Self::One(id.to_owned())
220 }
221}
222
223/// The first id of an optional choice: what a single-seat caller resolves.
224pub fn primary(choice: Option<&AgentChoice>) -> Option<&str> {
225 choice.and_then(AgentChoice::primary)
226}
227
228/// Explicit role assignment. Empty lists are filled in by
229/// [`Config::resolve_roles`] by rotating the roster.
230#[derive(Debug, Clone, Default, Deserialize, Serialize)]
231#[serde(deny_unknown_fields, default)]
232pub struct Roles {
233 /// Agents that implement the task, one worktree each.
234 pub implementers: Vec<String>,
235 /// Agents that rank the candidates blind.
236 pub judges: Vec<String>,
237 /// Agents that review the winning patch.
238 pub reviewers: Vec<String>,
239 /// Agent that applies review findings. Defaults to the winner's author.
240 ///
241 /// Accepts one id or an ordered array of ids: a fallback chain, see
242 /// [`AgentChoice`]. The review loop, the gate-fix round, `land`'s fix
243 /// rounds and the rebase conflict round move to the next id when one
244 /// errors, hits its quota or answers nothing usable; each id is tried at
245 /// most once per call, and once a fallback answered, the rest of the run
246 /// starts from it (see `crate::fixer`). Unset keeps the winner's author.
247 pub fixer: Option<AgentChoice>,
248 /// Agent that answers the standing chat's turns (`src/talk.rs`).
249 ///
250 /// Unset picks a `claude` seat, else the first runnable agent in roster
251 /// order (see [`crate::agent::pick`]) - which is roster *order*, not a
252 /// judgement about who converses well. Naming one here matters once an
253 /// agent is also sitting as a judge: the chat is opened far more often
254 /// than any single competition, and every open competes with that judge
255 /// seat for the same account's concurrency. A timeout on an ordinary chat
256 /// turn traced to exactly this - `opus` triple-booked as chatter and judge
257 /// - is what this field exists to let an operator break apart.
258 ///
259 /// Accepts one id or an ordered array of ids: a fallback chain, see
260 /// [`AgentChoice`].
261 pub chatter: Option<AgentChoice>,
262 /// Agent that arranges the queue between polls: `crate::conduct`'s single
263 /// seat, called once per cycle to decide a runnable task's `blocked_by`
264 /// and how a stalled or finished task recovers.
265 ///
266 /// The same precedent as [`Self::chatter`] for a seat that stands alone
267 /// rather than rotating through the roster - resolved through
268 /// [`crate::agent::pick`], so unset falls back to its own default order
269 /// (a claude seat, else the first runnable agent) rather than reusing a
270 /// judge or reviewer seat that the conductor's own poll-cycle cadence
271 /// would otherwise compete with for the same account's concurrency.
272 ///
273 /// Accepts a string or a fallback chain, like [`Self::chatter`].
274 pub conductor: Option<AgentChoice>,
275 /// Seats for the design-deliberation stage `graph::Runner::advise` runs
276 /// before `implement`: independent, read-only design proposals gathered
277 /// once a run has a settled task instruction and before any implementer
278 /// touches the repository.
279 ///
280 /// Empty falls back to `judges` rather than to the whole roster: a panel
281 /// trusted to rank patches independently is exactly the panel worth
282 /// asking to sketch a design independently, and an operator who has
283 /// already thought about judge diversity gets advisor diversity for free
284 /// instead of a fourth roster to maintain.
285 pub advisors: Vec<String>,
286 /// Agent that blends [`Self::advisors`]' proposals into the one design
287 /// brief `graph::Runner::synthesize_brief` carries into every
288 /// implementer's prompt.
289 ///
290 /// The same precedent as [`Self::chatter`] and [`Self::conductor`] for a
291 /// seat that stands alone rather than rotating through the roster -
292 /// resolved through [`crate::agent::pick`], so unset falls back to its
293 /// own default order (a claude seat, else the first runnable agent in
294 /// roster order) - exactly today's behavior, unchanged by leaving this
295 /// field out.
296 ///
297 /// Accepts a string or a fallback chain, like [`Self::chatter`].
298 pub synthesizer: Option<AgentChoice>,
299 /// Agent (normally a `kind = "command"` wrapper around Jev) that decides
300 /// whether a pull request title and prose are English, for
301 /// [`crate::github_text`]'s posting gate.
302 ///
303 /// Unset spawns nothing: the gate keeps its built-in heuristics. Set, a
304 /// failed, timed-out or unparsable call also falls back to them, so the
305 /// gate never depends on this seat being reachable. Accepts a string or a
306 /// fallback chain, like [`Self::chatter`].
307 pub language_judge: Option<AgentChoice>,
308}
309
310/// Graph shape and limits.
311#[derive(Debug, Clone, Deserialize, Serialize)]
312#[serde(deny_unknown_fields, default)]
313pub struct Graph {
314 /// Gate GitHub prose before posting. Secret redaction remains mandatory when disabled.
315 pub github_text_guard: bool,
316 /// Parallel implementations of the same task (the number of implementer
317 /// seats; pairs with [`Roles::implementers`]). **One by default.**
318 ///
319 /// Formerly `candidates`, still read as a deprecated alias.
320 ///
321 /// Competition is the thing magi is for, and it is still here - it is just
322 /// no longer what every task buys without being asked. Three days and 13
323 /// runs on this repository, which is the workload these numbers are drawn
324 /// from:
325 ///
326 /// - **0 of 13** competed runs reached a merge. Everything that landed in
327 /// that window went through `magi review` - the cheap half, no
328 /// competition - and passed on the first try.
329 /// - The judges' first choices **split 73% of the time** (8 of 11
330 /// tallies). Candidates that close together make the ranking a weak
331 /// signal for what it costs to produce.
332 /// - One run's own breakdown: implement 60min, judge 40min, fix 40min,
333 /// review 28min, **verify 5min** - and verify is the node that caught a
334 /// defect every reviewer had passed as clean. The cheapest step is the
335 /// one that earns its place every time.
336 ///
337 /// It is not worthless: `oc` won 3 of those tallies against `sonnet`, so a
338 /// single-seat default would have shipped the worse implementation in
339 /// roughly a quarter of them. That is exactly why this is a *default* and
340 /// not a removal - `magi run --candidates N` and a per-task seat count are
341 /// how a task that deserves a competition gets one.
342 ///
343 /// A single-candidate run needs no special case: `Runner::review`'s doc
344 /// records that `execute` already degrades to implement -> review -> gate
345 /// -> merge, because `judge` skips a one-candidate field, `deliberate` has
346 /// no two first choices to reconcile and `vote` returns early.
347 #[serde(alias = "candidates")]
348 pub implementers: usize,
349 /// Independent judges.
350 pub judges: usize,
351 /// Deliberation rounds when the judges' first choices disagree.
352 pub deliberate_rounds: usize,
353 /// Reviewers per review round. **Three by default** - the smallest panel
354 /// a lens cycle (see [`crate::prompt::Lens`]) covers exactly once, so the
355 /// default panel reads the patch for spec compliance, regressions, and
356 /// simplicity without repeating an angle. Review is also the one stage
357 /// [`Self::implementers`]'s doc describes as running on every task
358 /// regardless of competition, which is what makes a panel worth its cost
359 /// here even though `implementers` itself defaults to one.
360 pub reviewers: usize,
361 /// Maximum review+fix rounds before the run is declared blocked.
362 pub review_rounds: usize,
363 /// Fix rounds a failing `verify.gate` gets before the run is blocked. The
364 /// fixer is handed the gate's own output; `0` keeps the old behaviour of
365 /// blocking on the first red gate. Independent of [`Self::review_rounds`]
366 /// so a run that spent its review budget can still repair a one-line gate
367 /// failure.
368 pub gate_fix_rounds: usize,
369 /// Maximum agent processes running at once.
370 pub max_parallel: usize,
371 /// Language for the prose the agents write (`en` / `ja` / any language name).
372 pub language: String,
373 /// Keep one CLI conversation per seat, so a judge remembers its own
374 /// argument across deliberation rounds and the fixer remembers its own
375 /// implementation across review rounds.
376 ///
377 /// Sessions are scoped to a *seat*, never to an agent id: the same model
378 /// sitting as implementer and as judge gets two unrelated conversations,
379 /// which is what keeps blind judging blind.
380 pub sessions: bool,
381 /// Per-node timeouts, seconds.
382 pub timeout_implement: u64,
383 /// Per-node timeouts, seconds.
384 pub timeout_judge: u64,
385 /// Per-node timeouts, seconds.
386 pub timeout_review: u64,
387 /// Timeout for `verify.e2e` and `verify.gate`, seconds. Separate from
388 /// [`Self::timeout_review`] so shrinking a reviewer's budget cannot
389 /// silently shrink a real-machine command's budget too — the two used to
390 /// share `timeout_review`, and turning a slow reviewer down cut the
391 /// timeout `cargo test --all-targets` runs under along with it. When
392 /// omitted, preserves legacy configurations by using
393 /// [`Self::timeout_review`]. Set an explicit value to make verification
394 /// independent of later review-seat budget changes.
395 pub timeout_verify: Option<u64>,
396 /// Per-node timeouts, seconds.
397 pub timeout_fix: u64,
398 /// Wall-clock limit for one turn of [`crate::talk`]'s standing
399 /// conversation, seconds.
400 ///
401 /// An hour: the operator is not watching this turn resolve in real time,
402 /// so the budget can match what the work - reading files, running
403 /// commands, checking their output - actually needs rather than what a
404 /// person waiting on a phone can tolerate.
405 pub timeout_talk: u64,
406 /// Retries for an agent invocation that fails or returns nothing usable.
407 pub retries: usize,
408 /// Root for candidate / judge worktrees. Defaults to `~/wt/magi`.
409 pub worktree_root: Option<PathBuf>,
410 /// After the pull request is open, keep going: watch its checks and
411 /// reviews, run a fix round when they are unhappy, and ask to merge.
412 ///
413 /// On, because stopping at an open pull request left the operator doing
414 /// the watching by hand - six times in the session this was built in - and
415 /// that is the work the loop exists to take. It only engages for
416 /// `merge = "pr"`; every other merge mode ends the run as before.
417 ///
418 /// Turning this on does **not** hand magi the merge button:
419 /// [`Graph::land_approval`] is on too, and nothing merges without an
420 /// explicit answer. Setting both to their non-defaults is the only way to
421 /// get an unattended merge, and it has to be chosen twice.
422 pub land: bool,
423 /// Land rounds - watch, fix, push - before the run is left for a human.
424 pub land_rounds: usize,
425 /// Ask the owner before merging, showing what is about to land.
426 ///
427 /// On, and it is what makes `land` safe to have on: the question carries a
428 /// rendered panel - the diffstat, the patch, the checks, the review
429 /// comments that were addressed, and the subject the squash will use - so
430 /// the decision is made on evidence rather than on trust, from wherever
431 /// the operator happens to be.
432 ///
433 /// Silence is a hold. An unanswered approval never merges, and neither
434 /// does any answer other than the word `merge`.
435 pub land_approval: bool,
436 /// Ask the owner before merging a run whose review loop handed off over a
437 /// contested finding: the last round ended with a Major-or-above finding
438 /// still open *and* at least one reviewer's final vote (after
439 /// reconsideration) was reject. Findings raised in the last round are
440 /// never fixed or re-reviewed, so this is the one case an unattended
441 /// merge would land over a reviewer's explicit objection.
442 ///
443 /// On. Interaction with [`Self::land_approval`]: when that is on, every
444 /// merge is asked about and this key changes nothing. When it is off,
445 /// this key alone decides whether a contested hand-off is asked about
446 /// (the question says why); every other run still merges unattended.
447 /// Read at land time, so turning it off restores the unattended merge at
448 /// once. The pull request is opened either way; only the merge waits.
449 pub hold_contested_merge: bool,
450 /// After a run's pull request merges, file the findings its last review
451 /// round left open as follow-up tasks (`crate::followup`) instead of
452 /// letting them vanish with the merge: every Major-or-above finding, and
453 /// every finding of a seat whose final vote was reject. Other Minor/Nit
454 /// findings are only listed in the pull-request comment. Does not affect
455 /// whether the merge happens. On; best-effort, a failure is a run event.
456 pub file_followups: bool,
457 /// How long to wait for an owner to answer a question before the run is
458 /// abandoned, seconds. A parked run costs nothing, so this is generous;
459 /// it exists so a forgotten question cannot pin a worktree forever.
460 pub answer_timeout: u64,
461 /// What a round does when one or more reviewer seats never answered
462 /// (timeout, crash, unparsable output).
463 pub incomplete_review: IncompleteReviewPolicy,
464 /// Run `verify.e2e` on every round, even one that already has blocking
465 /// findings and another round left to try.
466 ///
467 /// Off by default: a round with a blocking finding and rounds still left
468 /// is going back to the fixer regardless of what `verify.e2e` says, so
469 /// running it first only spends the round's slowest step (minutes, on a
470 /// Rust repo's `cargo test --all-targets`) on a head about to be
471 /// rewritten anyway. `verify.e2e` still runs once a round has no
472 /// blocking findings left (a round cannot go `clean` without it) and the
473 /// final `verify.gate` always runs on the actual tree that would land —
474 /// deferring is about *when* e2e runs mid-loop, never about skipping it.
475 ///
476 /// Set this to restore the old every-round diagnostic behaviour: e2e
477 /// output from a round that still has blocking findings is occasionally
478 /// useful on its own (a runtime failure a reviewer's panel would not
479 /// have caught by reading), and this is the way back to seeing it every
480 /// round instead of only once the panel has nothing left to flag.
481 pub e2e_every_round: bool,
482 /// Run the design-deliberation stage before `implement`: independent
483 /// advisor seats each sketch a design, and (when at least one produced a
484 /// usable proposal) a synthesis blends them into a brief carried in the
485 /// implementer's prompt. See `graph::Runner::advise`.
486 ///
487 /// On by default. A design sketch is a few paragraphs an agent can write
488 /// without touching the repository, where a full implementation is a
489 /// tool loop that re-reads the codebase on every turn - so three
490 /// sketches, gathered once before `implement` starts, cost a fraction of
491 /// a fourth candidate and buy back a form of the same disagreement
492 /// [`Self::implementers`]'s doc describes moving away from being the
493 /// default, on every run rather than only the ones an operator remembers
494 /// to ask for with `--implementers`.
495 pub advise: bool,
496 /// How many independent design proposals the deliberation stage gathers.
497 /// **Three by default** - the same number [`Self::implementers`]'s doc
498 /// names as the point where a fourth judge's first choice stopped
499 /// changing the tally.
500 pub advisors: usize,
501}
502
503impl Default for Graph {
504 fn default() -> Self {
505 Self {
506 github_text_guard: true,
507 implementers: 1,
508 judges: 3,
509 deliberate_rounds: 1,
510 reviewers: 3,
511 review_rounds: 6,
512 gate_fix_rounds: 1,
513 max_parallel: 4,
514 language: "en".to_owned(),
515 sessions: true,
516 timeout_implement: 3600,
517 timeout_judge: 1200,
518 timeout_review: 1200,
519 timeout_verify: None,
520 timeout_fix: 1800,
521 timeout_talk: 3600,
522 retries: 1,
523 worktree_root: None,
524 land: true,
525 land_rounds: 4,
526 land_approval: true,
527 hold_contested_merge: true,
528 file_followups: true,
529 answer_timeout: 86_400,
530 incomplete_review: IncompleteReviewPolicy::Block,
531 e2e_every_round: false,
532 advise: true,
533 advisors: 3,
534 }
535 }
536}
537
538impl Graph {
539 /// Effective machine-command budget. Older configuration files had only
540 /// `timeout_review`, which also governed verification, so absence is a
541 /// compatibility fallback rather than a new 1200-second default.
542 pub fn verify_timeout(&self) -> u64 {
543 self.timeout_verify.unwrap_or(self.timeout_review)
544 }
545}
546
547/// What a review round does when a reviewer seat never answered.
548///
549/// A round where half the panel timed out is not evidence of a clean patch —
550/// it is evidence of nothing. The default refuses to call that clean; `warn`
551/// exists for an operator who would rather keep a flaky seat from stalling
552/// every run, and accepts that the gap is on them to read in the report.
553#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
554#[serde(rename_all = "lowercase")]
555pub enum IncompleteReviewPolicy {
556 /// A round with a missing seat is never `clean`: with nothing raised to
557 /// fix, the round is re-reviewed instead of gating; with the max rounds
558 /// exhausted, the run is left `Blocked` rather than declared ready.
559 Block,
560 /// A round with a missing seat can still gate as clean, once every seat
561 /// that *did* answer raised nothing blocking and verification is green.
562 /// The record keeps the gap visible (`magi show`, `magi stats`) even
563 /// though the run does not wait on it.
564 Warn,
565}
566
567/// What to do when vendor-identifying text is found in material shown to judges.
568#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
569#[serde(rename_all = "lowercase")]
570pub enum LeakPolicy {
571 /// Record the leak, show the patch unmodified.
572 Warn,
573 /// Replace the token with `[REDACTED]` in the presented patch.
574 Redact,
575 /// Abort the run.
576 Fail,
577}
578
579/// Blindness policy.
580///
581/// Commit messages and candidate summaries are *always* stripped of
582/// attribution trailers and redacted — that is where signatures actually
583/// appear. [`Blind::on_leak`] governs the patch body only, where blanket
584/// redaction would corrupt the artifact under judgement.
585#[derive(Debug, Clone, Deserialize, Serialize)]
586#[serde(deny_unknown_fields, default)]
587pub struct Blind {
588 /// Install a per-worktree `commit-msg` hook that deletes attribution
589 /// trailers before they can land in a candidate's history.
590 pub commit_msg_hook: bool,
591 /// Literal, case-insensitive substrings. A line containing any of them is
592 /// dropped from commit messages and summaries; the `commit-msg` hook is
593 /// generated from the same list.
594 pub strip_lines: Vec<String>,
595 /// Case-insensitive substrings that identify a vendor or model.
596 pub vendor_tokens: Vec<String>,
597 /// Policy for vendor tokens found in the patch body.
598 pub on_leak: LeakPolicy,
599 /// Seed for label assignment and per-judge presentation order. Derived from
600 /// the run id when unset; set it to make a run reproducible.
601 pub seed: Option<u64>,
602}
603
604impl Default for Blind {
605 fn default() -> Self {
606 Self {
607 commit_msg_hook: true,
608 strip_lines: [
609 "Co-Authored-By:",
610 "Signed-off-by:",
611 "Assisted-by:",
612 "Generated-by:",
613 "Generated with",
614 "\u{1f916}",
615 ]
616 .iter()
617 .map(|s| (*s).to_owned())
618 .collect(),
619 vendor_tokens: [
620 "claude",
621 "anthropic",
622 "codex",
623 "openai",
624 "chatgpt",
625 "gemini",
626 "grok",
627 "xai",
628 "copilot",
629 "opencode",
630 "qoder",
631 "cursor",
632 "\u{1f916}",
633 ]
634 .iter()
635 .map(|s| (*s).to_owned())
636 .collect(),
637 on_leak: LeakPolicy::Warn,
638 seed: None,
639 }
640 }
641}
642
643/// Shell commands that gate the winner.
644#[derive(Debug, Clone, Default, Deserialize, Serialize)]
645#[serde(deny_unknown_fields, default)]
646pub struct Verify {
647 /// Run in the winner's worktree once per review round. Its output is fed
648 /// back to the fixer. This is the "real machine" leg of the review.
649 pub e2e: Vec<String>,
650 /// Final gate. Must all exit 0 before a merge is attempted.
651 pub gate: Vec<String>,
652 /// Mechanical fixers (formatters) run in the winner's worktree just before
653 /// `gate`, after review is clean. Anything they change is committed as one
654 /// neutral-identity commit so the gate and the PR see it. A command that
655 /// fails or times out is a warning, never a failed run: the gate stays the
656 /// single arbiter. Empty (the default) turns the feature off. Runs under
657 /// `graph.verify_timeout()` per command, like the gate. Meant for light
658 /// tools: it is not scanned for `CARGO_TARGET_DIR`, and it should be
659 /// idempotent since a resumed run may repeat it.
660 #[serde(default)]
661 pub pre_gate: Vec<String>,
662 /// Shell used to run the commands above. Defaults to `sh -c`, or
663 /// `cmd /C` when `sh` is not on `PATH`.
664 pub shell: Option<Vec<String>>,
665}
666
667impl Verify {
668 /// The `CARGO_TARGET_DIR=` value of the first rendered command that sets
669 /// one, if any. See [`crate::disk::extract_cargo_target_dir`] for the shape
670 /// this reads back. One rendering is enough - they all set the same
671 /// rendered `{{ vars.cache }}` path via the same shell - and the first e2e
672 /// command is checked before the gate because the e2e rebuilds the crate.
673 pub fn cache_dir(&self) -> Option<PathBuf> {
674 self.e2e
675 .iter()
676 .chain(self.gate.iter())
677 .find_map(|cmd| crate::disk::extract_cargo_target_dir(cmd))
678 }
679}
680
681/// Disk hygiene: how hard magi is allowed to press on the machine's free space.
682///
683/// The numbers below come from one incident, not from theory: a machine with
684/// 951.8 GB free ran a few competitions and plans and best read 6.7 GB free.
685/// Three multi-gigabyte classes of junk accumulated side by side - per-run
686/// worktrees that end as `Merged`/`Ready`/`Failed`, a shared build cache whose
687/// each verify round and each implementation wave recompiles the derived
688/// section of the project into, and the outputs of runs that were removed but
689/// whose folders nobody deleted.
690#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
691#[serde(deny_unknown_fields, default)]
692pub struct Disk {
693 /// Free space, in bytes, below which no new run may start: the daemon and
694 /// the `magi run` gate answer with "the disk is full" instead of letting
695 /// the graph fill it the rest of the way. `0` turns the gate off.
696 ///
697 /// Default 8 GiB. The incident ran down to 6.7 GB free of 951.8 GB total
698 /// before anybody noticed; 8 GiB is enough headroom for the compile a fresh
699 /// competition triggers and small enough that a 1 TB disk with 100 GB free
700 /// is nowhere near the threshold.
701 pub min_free_bytes: u64,
702 /// Fold finished runs without being asked. `Merged`, `Ready` and `Failed`
703 /// runs older than [`fold_grace_secs`](Self::fold_grace_secs) have their
704 /// worktrees removed. `0` turns the janitor off.
705 ///
706 /// Default true.
707 pub auto_fold: bool,
708 /// How old a finished run must be before the janitor folds it, seconds.
709 ///
710 /// Default 6 hours. A run that `Ready` at 8am is the operator's answer; a
711 /// run that `Ready` a week ago is worktrees holding a compile each. Six
712 /// hours is long enough that nobody loses an answer in the gap between
713 /// reading the report and starting from it, and short enough that a backlog
714 /// cannot pile up across two nights.
715 pub fold_grace_secs: u64,
716 /// Ceiling for the shared build cache (`CARGO_TARGET_DIR` in the rendered
717 /// verify commands), in bytes. When the janitor runs and the cache is over
718 /// it, files are dropped oldest-first until it is not. `0` turns pruning
719 /// off - the cache then only ever grows, which is the operator's call.
720 ///
721 /// Default 10 GiB. This is what the incident measured: 30.61 GB sat in the
722 /// shared cache on top of ~16 GB in the primary target directory and 6.7-
723 /// 11.15 GB in each of four per-worktree targets. 10 GiB holds a healthy
724 /// stack of prebuilt dependencies (cargo's per-file fingerprinting means
725 /// pruning only costs the rebuild of the dropped files, not of the world)
726 /// without letting one addled cache swallow the machine.
727 pub cache_limit_bytes: u64,
728}
729
730impl Default for Disk {
731 fn default() -> Self {
732 Self {
733 min_free_bytes: 8 * 1024 * 1024 * 1024,
734 auto_fold: true,
735 fold_grace_secs: 6 * 60 * 60,
736 cache_limit_bytes: 10 * 1024 * 1024 * 1024,
737 }
738 }
739}
740
741/// What to do with the winning branch.
742#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
743#[serde(rename_all = "lowercase")]
744pub enum MergeMode {
745 /// Leave the branch alone and print the merge command matching
746 /// [`Merge::style`].
747 None,
748 /// Merge into the base branch in the primary worktree, using
749 /// [`Merge::style`].
750 Local,
751 /// Push the branch and open a PR with `gh pr create`. Landing this PR
752 /// (`[graph] land`) always squashes — see `land`'s module doc — so
753 /// [`Merge::style`] does not apply here.
754 Pr,
755}
756
757/// How the winning branch is attached to the base branch: what
758/// `mode = "local"` runs, and what `mode = "none"`'s printed guidance tells
759/// the operator to run by hand.
760///
761/// Read from configuration rather than asked of the repository at run time
762/// (e.g. `gh api repos/{owner}/{repo}/rulesets`) for two reasons: it keeps
763/// `mode = "none"`'s guidance a pure function of `RunState`, assertable in a
764/// unit test the same way `land::decide` is kept pure (see that module's
765/// doc), and it works for a base branch that is not hosted on GitHub, or not
766/// reachable at all, at the moment the report is rendered. An operator whose
767/// base branch enforces a ruleset already knows what it allows; declaring it
768/// once here is cheaper than magi re-discovering it, with a network call, on
769/// every render.
770#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize, Serialize)]
771#[serde(rename_all = "lowercase")]
772pub enum MergeStyle {
773 /// `git merge --no-ff`: every candidate commit lands, plus a merge
774 /// commit that records the merge as its own event in history. Rejected
775 /// by a base branch whose ruleset requires linear history or forbids
776 /// merge commits outright.
777 #[default]
778 Merge,
779 /// `git merge --squash` followed by a commit under an explicit message:
780 /// every candidate commit folds into one, and none of the candidate's
781 /// own placeholder subjects (`magi: candidate A (uncommitted work)`)
782 /// reach the base branch. No merge commit, so this satisfies a linear-
783 /// history ruleset.
784 Squash,
785 /// A fast-forward-only merge: every candidate commit lands verbatim, in
786 /// order, with no merge commit. Only succeeds because the winner was
787 /// already rebased onto the tracked base tip before this runs (see
788 /// `Runner::sync_to_base`) — equivalent to GitHub's "rebase and merge"
789 /// once that has happened.
790 Rebase,
791}
792
793/// Merge policy.
794#[derive(Debug, Clone, Deserialize, Serialize)]
795#[serde(deny_unknown_fields, default)]
796pub struct Merge {
797 /// Default is [`MergeMode::None`]: magi never touches your base branch
798 /// unless you ask it to.
799 pub mode: MergeMode,
800 /// Base branch. Defaults to the branch checked out when the run started.
801 pub base: Option<String>,
802 /// How the winner is attached to `base`; see [`MergeStyle`]. Ignored by
803 /// `mode = "pr"`.
804 pub style: MergeStyle,
805 /// Remote for `mode = "pr"`.
806 pub remote: String,
807 /// After a `mode = "pr"` run lands, open a `chore/release-vX.Y.Z` pull
808 /// request sized to the change by an agent's own judgement, so a version
809 /// bump does not depend on a human remembering to cut one.
810 ///
811 /// Only acts on Rust repositories (a `Cargo.toml` at the root of the base
812 /// branch); on any other repository it is a no-op that records one event.
813 ///
814 /// On by default. **Turning this off means a merge landed from the phone
815 /// never becomes a release**, so `POST /api/upgrade` keeps reporting
816 /// "already on the newest release" against a `main` that has moved past
817 /// it - the same gap this feature exists to close. Only for a repository
818 /// that wants to keep cutting releases by hand.
819 pub release_bump: bool,
820}
821
822impl Default for Merge {
823 fn default() -> Self {
824 Self {
825 mode: MergeMode::None,
826 base: None,
827 style: MergeStyle::default(),
828 remote: "origin".to_owned(),
829 release_bump: true,
830 }
831 }
832}
833
834/// How magi keeps itself current.
835#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
836#[serde(rename_all = "lowercase")]
837pub enum UpdateMode {
838 /// Never check.
839 Off,
840 /// Check in the background and print a one-line banner when a newer
841 /// release exists.
842 Notify,
843 /// Check and install silently.
844 Install,
845}
846
847/// Self-update policy.
848#[derive(Debug, Clone, Deserialize, Serialize)]
849#[serde(deny_unknown_fields, default)]
850pub struct Update {
851 /// Default is [`UpdateMode::Notify`]: magi tells you, and lets you decide.
852 pub mode: UpdateMode,
853 /// Minimum time between checks, e.g. `24h`. kaishin's default when unset.
854 pub interval: Option<String>,
855}
856
857impl Default for Update {
858 fn default() -> Self {
859 Self {
860 mode: UpdateMode::Notify,
861 interval: None,
862 }
863 }
864}
865
866/// Who performs the release after a `chore/release-vX.Y.Z` pull request merges.
867#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Deserialize, Serialize)]
868#[serde(rename_all = "lowercase")]
869pub enum ReleaseMode {
870 /// The repository's own workflows do (`auto-tag.yml` then `release.yml`),
871 /// and the release pull request merges on its checks.
872 #[default]
873 Actions,
874 /// magi does, from this machine: no CI is awaited, the owner approves the
875 /// merge, and magi then tags and runs [`Release::commands`]. See
876 /// [`crate::release_local`].
877 Local,
878}
879
880/// `[release]`: releasing without GitHub Actions. Opt-in per repository.
881#[derive(Debug, Clone, Deserialize, Serialize)]
882#[serde(deny_unknown_fields, default)]
883pub struct Release {
884 /// [`ReleaseMode::Actions`] (default: nothing changes) or
885 /// [`ReleaseMode::Local`].
886 pub mode: ReleaseMode,
887 /// Shell commands run in order, from a clean checkout of the merge commit,
888 /// once the tag is pushed. The first failure stops the list. They see
889 /// `MAGI_RELEASE_VERSION`, `MAGI_RELEASE_TAG`, `MAGI_RELEASE_COMMIT` and
890 /// `MAGI_RELEASE_PR` in the environment; `{{ ... }}` cannot carry the
891 /// version because teravars renders the whole file before any release
892 /// exists. Only read when `mode = "local"`.
893 pub commands: Vec<String>,
894 /// Minutes each command may run before it is killed and counted as failed.
895 pub timeout_minutes: u64,
896}
897
898impl Default for Release {
899 fn default() -> Self {
900 Self {
901 mode: ReleaseMode::Actions,
902 commands: Vec::new(),
903 timeout_minutes: 30,
904 }
905 }
906}
907
908impl Release {
909 /// Is this repository released by magi rather than by its workflows?
910 pub fn is_local(&self) -> bool {
911 self.mode == ReleaseMode::Local
912 }
913}
914
915/// Top-level configuration.
916#[derive(Debug, Clone, Default, Deserialize, Serialize)]
917#[serde(deny_unknown_fields, default)]
918pub struct Config {
919 /// Agent roster.
920 pub agents: Vec<AgentSpec>,
921 /// Role assignment.
922 pub roles: Roles,
923 /// Graph shape.
924 pub graph: Graph,
925 /// Blindness policy.
926 pub blind: Blind,
927 /// Verification commands.
928 pub verify: Verify,
929 /// Disk hygiene.
930 pub disk: Disk,
931 /// Merge policy.
932 pub merge: Merge,
933 /// Self-update policy.
934 pub update: Update,
935 /// Project-specific text appended to the node prompts.
936 pub prompts: Prompts,
937 /// How the operator is told a run is waiting on them.
938 pub notify: Notify,
939 /// Local repositories the plan surface can start or derive a conversation
940 /// against.
941 pub repos: Repos,
942 /// Policy for the standing conversation ([`crate::talk`]).
943 pub talk: Talk,
944 /// How many runs `magi serve`'s own loop drives at once.
945 pub daemon: Daemon,
946 /// Who tags and publishes after a release pull request merges.
947 pub release: Release,
948 /// Context-window sizes in tokens, keyed by model name, merged over
949 /// [`BUILTIN_CONTEXT_WINDOWS`]. See [`Config::context_window`].
950 pub context_windows: BTreeMap<String, u64>,
951}
952
953/// Context windows of models magi commonly drives, in tokens.
954///
955/// A convenience, not a source of truth: vendors resize windows and ship new
956/// models faster than this table is edited, so an entry that is stale or
957/// missing is fixed by `[context_windows]` in `magi.toml`, which wins. Matched
958/// by [`Config::context_window`]: exact name first, then the longest key that
959/// prefixes the model name (so a dated or suffixed id such as
960/// `claude-sonnet-4-5-20250929` finds `claude-sonnet-4-5`). A model matching
961/// nothing has no percentage - the UI shows the raw count.
962const BUILTIN_CONTEXT_WINDOWS: &[(&str, u64)] = &[
963 ("claude-opus-4", 200_000),
964 ("claude-sonnet-4", 200_000),
965 ("claude-haiku-4", 200_000),
966 ("claude-3", 200_000),
967 ("opus", 200_000),
968 ("sonnet", 200_000),
969 ("haiku", 200_000),
970 ("gpt-5", 400_000),
971 ("gpt-4.1", 1_000_000),
972 ("gpt-4o", 128_000),
973 ("o3", 200_000),
974 ("o4-mini", 200_000),
975 ("gemini-2.5", 1_000_000),
976 ("deepseek", 128_000),
977];
978
979impl Config {
980 /// Context window in tokens for `model`: `[context_windows]` first, then
981 /// the built-in table; within each, an exact name beats the longest
982 /// prefix. `None` for an unknown model, which is a deliberate answer -
983 /// guessing a denominator would print a confident wrong percentage.
984 pub fn context_window(&self, model: &str) -> Option<u64> {
985 fn lookup<'a>(model: &str, entries: impl Iterator<Item = (&'a str, u64)>) -> Option<u64> {
986 let mut best: Option<(usize, u64)> = None;
987 for (key, window) in entries {
988 if key == model {
989 return Some(window);
990 }
991 if model.starts_with(key) && best.is_none_or(|(len, _)| key.len() > len) {
992 best = Some((key.len(), window));
993 }
994 }
995 best.map(|(_, w)| w)
996 }
997 lookup(
998 model,
999 self.context_windows.iter().map(|(k, w)| (k.as_str(), *w)),
1000 )
1001 .or_else(|| lookup(model, BUILTIN_CONTEXT_WINDOWS.iter().copied()))
1002 }
1003}
1004
1005/// How the daemon loop itself behaves, as opposed to what one run does.
1006///
1007/// Machine-layer material in the same sense [`Repos::roots`] is: how many
1008/// competitions this machine's own loop is willing to babysit at once is a
1009/// fact about the machine running `magi serve`, not about any one
1010/// repository's task, so it belongs in `<config_dir>/magi/config.toml`
1011/// rather than a repository's own `magi.toml` - though, like `Repos::roots`,
1012/// nothing stops a repository from setting it too, since a scalar field
1013/// takes whichever layer has the highest precedence.
1014#[derive(Debug, Clone, Deserialize, Serialize)]
1015#[serde(deny_unknown_fields, default)]
1016pub struct Daemon {
1017 /// How many runs `magi serve` may have actively in flight at once.
1018 /// **One by default** - today's behaviour, one run at a time.
1019 ///
1020 /// This is a different knob from [`Graph::max_parallel`], and the two
1021 /// must not be confused: `max_parallel` bounds how many agent *processes*
1022 /// one run starts inside itself (implementers, judges, reviewers -
1023 /// candidates competing on a single task); this field bounds how many
1024 /// *runs* - whole competitions, each with its own `max_parallel` budget -
1025 /// the loop drives side by side, possibly across different tasks and
1026 /// different repositories. Raising `max_parallel` buys a bigger panel for
1027 /// one task; raising this buys more tasks worked at once. A config file
1028 /// that meant one and wrote the other would either starve a competition
1029 /// of judges or leave the rest of the backlog waiting for no reason.
1030 ///
1031 /// A run parked waiting on the operator's land-merge approval - see
1032 /// [`crate::land`] - does not hold one of these slots while it waits: the
1033 /// whole point of parking there is to let the loop spend the slot on
1034 /// something runnable instead of sitting on a decision only a human can
1035 /// make. So even at the default of `1`, an approval that comes back does
1036 /// not queue behind whatever else the loop happens to be running.
1037 pub max_concurrent_runs: usize,
1038 /// Let a task marked [`crate::queue::Task::interrupt`] (`magi task
1039 /// interrupt`) cut ahead of whatever `magi serve` already has in flight,
1040 /// instead of waiting for it to finish.
1041 ///
1042 /// **Off by default.** When enabled, a run that is in flight and is not
1043 /// itself the interrupt candidate may be paused at its next safe node
1044 /// boundary - see [`crate::graph::Runner::park_here`] - so the marked
1045 /// task can run alone; the paused run resumes automatically, through the
1046 /// same path any other parked run does, the moment the interrupting
1047 /// task's own run reaches a terminal status. This is opt-in because it
1048 /// bends the loop's own "one run at a time" principle (see this repository's
1049 /// `magi serve` help) for a specific, explicit operator request, and a
1050 /// repository that never files an interrupt task pays nothing for having
1051 /// it on - but an operator who does not want any run of theirs preempted,
1052 /// ever, should leave this `false`.
1053 pub pause_for_interrupts: bool,
1054 /// How many deputies `magi serve` runs at once. A deputy is the short-lived
1055 /// seat that waits on one open conductor question (see [`crate::deputy`]);
1056 /// each is a live agent conversation, so this is bounded - **two by
1057 /// default**, because the agent CLIs' quota is the scarce resource. A
1058 /// question over the limit keeps its place and starts when a deputy
1059 /// finishes; `0` runs none.
1060 pub max_deputies: usize,
1061 /// Minutes a release-bump pull request may make no progress before
1062 /// `magi serve` raises a notice and asks the owner (see
1063 /// [`crate::release_watch`]). Progress is a change of head commit or of any
1064 /// check's verdict. A required check that stays red after the one rerun the
1065 /// watcher is allowed escalates at once, whatever this says. **Sixty by
1066 /// default**; `0` turns the watcher off.
1067 pub release_stall_minutes: u64,
1068}
1069
1070impl Default for Daemon {
1071 fn default() -> Self {
1072 Self {
1073 max_concurrent_runs: 1,
1074 pause_for_interrupts: false,
1075 max_deputies: 2,
1076 release_stall_minutes: 60,
1077 }
1078 }
1079}
1080
1081/// Where `magi repos` and `GET /api/repos` look for local checkouts.
1082///
1083/// `roots` is one of the array keys [`array_merge_policy`] marks as
1084/// append-across-layers: which checkouts exist in general is a *machine*
1085/// fact in the same way the agent roster is - a repository's own `magi.toml`
1086/// cannot state where its siblings live before magi has resolved which
1087/// repository to read that file from in the first place - but a repository
1088/// that genuinely has an extra root worth scanning is not forced to choose
1089/// between an error and losing the machine's roots outright. Both layers'
1090/// roots are scanned; see [`Config::refuse_split_arrays`] for the keys that
1091/// are still refused.
1092#[derive(Debug, Clone, Deserialize, Serialize)]
1093#[serde(deny_unknown_fields, default)]
1094pub struct Repos {
1095 /// Roots to scan for a ghq-layout checkout: `<root>/<host>/<owner>/<repo>`
1096 /// with a `.git` directory. Empty by default - nothing is scanned unless
1097 /// asked to be.
1098 pub roots: Vec<PathBuf>,
1099 /// How long a scan is trusted before the next request re-scans it,
1100 /// seconds. `0` means never trust it: scan on every request. Defaults to
1101 /// a day, the same order of magnitude as [`Graph::answer_timeout`] for
1102 /// the same reason - a checkout does not usually appear or vanish inside
1103 /// a session, so there is little to gain from scanning more often than
1104 /// that, and an explicit refresh exists for the moment one does.
1105 pub scan_ttl: u64,
1106 /// How often `magi serve` runs `git fetch origin` in every checkout under
1107 /// `roots`, seconds, so `origin/main` stays fresh whatever state the
1108 /// working tree is in. Fetch only: no branch, HEAD or working tree is
1109 /// touched. `0` disables it.
1110 pub fetch_interval: u64,
1111}
1112
1113impl Default for Repos {
1114 fn default() -> Self {
1115 Self {
1116 roots: Vec::new(),
1117 scan_ttl: 86_400,
1118 fetch_interval: 600,
1119 }
1120 }
1121}
1122
1123/// Project-specific text appended to each node's prompt.
1124///
1125/// **Additive by construction.** These fields cannot replace magi's prompts,
1126/// only extend them, and that restriction is the whole design. The built-in
1127/// prompts carry the invariants the competition rests on: a judging prompt
1128/// names no authors, every structured answer must arrive as one fenced `json`
1129/// block, and a judge is told not to speculate about who wrote what. A config
1130/// that could overwrite them would let a typo silently un-blind the panel or
1131/// break the parser, and the symptom would be "the judges got worse" rather
1132/// than an error.
1133///
1134/// Repository-wide context belongs in `AGENTS.md`, which every agent already
1135/// reads from the checkout. Use these fields for the things a *magi node*
1136/// needs to know and a repository file cannot say - for instance that
1137/// reviewers here should ignore formatting because a hook owns it.
1138#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1139#[serde(deny_unknown_fields, default)]
1140pub struct Prompts {
1141 /// Appended to every node's prompt.
1142 pub all: String,
1143 /// Appended for implementers.
1144 pub implement: String,
1145 /// Appended for judges, both ranking and voting.
1146 pub judge: String,
1147 /// Appended for reviewers.
1148 pub review: String,
1149 /// Appended for the fixer.
1150 pub fix: String,
1151}
1152
1153impl Prompts {
1154 /// The overlay for one node, or `None` when nothing is configured.
1155 ///
1156 /// `node` is the graph's own node name, so a new node gets no overlay
1157 /// rather than the wrong one.
1158 pub fn overlay(&self, node: &str) -> Option<String> {
1159 let specific = match node {
1160 "implement" => &self.implement,
1161 "judge" | "vote" | "deliberate" => &self.judge,
1162 "review" => &self.review,
1163 "fix" => &self.fix,
1164 _ => "",
1165 };
1166 let mut parts: Vec<&str> = Vec::new();
1167 for p in [self.all.trim(), specific.trim()] {
1168 if !p.is_empty() {
1169 parts.push(p);
1170 }
1171 }
1172 if parts.is_empty() {
1173 return None;
1174 }
1175 Some(parts.join("\n\n"))
1176 }
1177}
1178
1179/// How the operator is told that a run is waiting on them.
1180///
1181/// A command rather than a built-in integration: magi is one binary with no
1182/// network dependencies, and every operator's notification path is different -
1183/// ntfy, a Slack webhook, a Windows toast, an SSH to a machine that beeps.
1184/// Shelling out keeps all of them possible and none of them magi's problem.
1185#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1186#[serde(deny_unknown_fields, default)]
1187pub struct Notify {
1188 /// Command and arguments. `{summary}`, `{run}` and `{url}` are replaced.
1189 /// Empty means no notification - the web UI is then the only surface.
1190 pub command: Vec<String>,
1191}
1192
1193/// Policy for [`crate::talk`], the standing conversation.
1194#[derive(Debug, Clone, Default, Deserialize, Serialize)]
1195#[serde(deny_unknown_fields, default)]
1196pub struct Talk {
1197 /// Let the conversation's agent edit files in the repository instead of
1198 /// filing a task for one. **Off by default** - see
1199 /// [`crate::talk`]'s module doc for why an edit made mid-conversation is
1200 /// an edit no run and no review can be attributed to, which is exactly
1201 /// the property a repository entered in a competition depends on. A
1202 /// repository that is never judged - dotfiles, a personal config
1203 /// checkout - has nothing to lose by turning this on in its own
1204 /// `magi.toml`, and a one-line fix stops costing a queued task to get.
1205 pub allow_write: bool,
1206 /// Extra chat personas, `[[talk.personas]]`. They add to the built-ins in
1207 /// [`crate::persona`]; an entry with a built-in's id replaces it. Like every
1208 /// array outside [`array_merge_policy`]'s append list, declaring it in two
1209 /// layers is refused.
1210 pub personas: Vec<PersonaSpec>,
1211}
1212
1213/// One `[[talk.personas]]` entry: a tone for the standing chat, nothing more.
1214#[derive(Debug, Clone, Default, PartialEq, Eq, Deserialize, Serialize)]
1215#[serde(deny_unknown_fields)]
1216pub struct PersonaSpec {
1217 /// Stable id the conversation stores. Not `default`.
1218 pub id: String,
1219 /// What the selector shows.
1220 pub name: String,
1221 /// The voice instruction appended to the chat's system prompt.
1222 pub prompt: String,
1223}
1224
1225/// Roles resolved to concrete agent specs for one run.
1226#[derive(Debug, Clone)]
1227pub struct ResolvedRoles {
1228 /// One per candidate.
1229 pub implementers: Vec<AgentSpec>,
1230 /// One per judge.
1231 pub judges: Vec<AgentSpec>,
1232 /// One per reviewer slot.
1233 pub reviewers: Vec<AgentSpec>,
1234 /// The configured fixer chain in order, if `[roles] fixer` is set
1235 /// (resolved like [`crate::agent::pick_chain`]: unknown or uninstalled ids
1236 /// skipped, duplicates keep their first place). `None` means the winner's
1237 /// own author.
1238 pub fixer: Option<Vec<AgentSpec>>,
1239 /// Queue conductor, explicitly selected or resolved by the standalone-seat fallback.
1240 pub conductor: AgentSpec,
1241 /// The full ordered implementer roster, in [`Roles::implementers`]'s own
1242 /// order — or `[[agents]]` in file order, when that list is empty. Unlike
1243 /// [`Self::implementers`], never truncated to `graph.implementers` and
1244 /// never `rotate`d/wrapped: a solo run (`implementers = 1`) resolves
1245 /// `implementers` down to a single slot, but `graph::Runner`'s per-seat
1246 /// quota fallback needs the *whole* list to walk forward through when
1247 /// that one slot's agent runs out of quota mid-run.
1248 pub implementer_roster: Vec<AgentSpec>,
1249 /// [`Self::implementer_roster`]'s counterpart for judge seats: the whole
1250 /// `[roles] judges` list (or every agent), untruncated and unrotated, for
1251 /// the per-seat handover when a judge's agent fails.
1252 pub judge_roster: Vec<AgentSpec>,
1253 /// Likewise for reviewer seats.
1254 pub reviewer_roster: Vec<AgentSpec>,
1255}
1256
1257/// Every array-valued key in a config table, as a dotted path.
1258///
1259/// Dotted so the error names `roles.implementers` rather than `implementers`:
1260/// an operator with three config files needs to know which key, not just that
1261/// there was one. `vars` is skipped because it is teravars' own input, merged
1262/// on purpose and never deserialised into `Config`.
1263fn array_keys(table: &toml::value::Table, prefix: &str) -> Vec<String> {
1264 let mut out = Vec::new();
1265 for (k, v) in table {
1266 if prefix.is_empty() && k == "vars" {
1267 continue;
1268 }
1269 let path = if prefix.is_empty() {
1270 k.clone()
1271 } else {
1272 format!("{prefix}.{k}")
1273 };
1274 match v {
1275 toml::Value::Array(_) => out.push(path),
1276 toml::Value::Table(t) => out.extend(array_keys(t, &path)),
1277 _ => {}
1278 }
1279 }
1280 out
1281}
1282
1283/// How an array key behaves when two config layers both declare it.
1284#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1285enum ArrayMerge {
1286 /// Two layers may both declare it; the composed value is the
1287 /// low-to-high-priority concatenation teravars already produces (see
1288 /// [`Config::load_layers`]'s doc for why that order and no dedup).
1289 Append,
1290 /// Two layers declaring it is refused; see
1291 /// [`Config::refuse_split_arrays`].
1292 Replace,
1293}
1294
1295/// The single place that decides, for a dotted array key (as returned by
1296/// [`array_keys`]), whether declaring it in two config layers is a
1297/// concatenation the operator asked for or a silent accident.
1298///
1299/// Kept as one match so the whole policy is visible in one place - the same
1300/// reason `claude_quota` and `dropped_stream` close their own classification
1301/// in one spot elsewhere in this codebase. Anything not listed defaults to
1302/// [`ArrayMerge::Replace`]: refusing is the safe default for a key nobody has
1303/// reasoned about yet, and a new array key added later has to be added here
1304/// deliberately to become appendable.
1305///
1306/// - `verify.e2e` / `verify.gate` — a "run all of these, all must exit 0"
1307/// gate. Concatenating two of them is exactly the checks both layers
1308/// wanted, which is what lets a common gate (e.g. `editorconfig-checker`)
1309/// live in a shared layer while a repository's own layer adds its own
1310/// command, instead of every repository copying the shared command into
1311/// its own file.
1312/// - `repos.roots` — a set of directories to scan for checkouts. A
1313/// repository adding its own root on top of the machine's is additive by
1314/// nature, not a replacement of where the machine looks; see
1315/// [`Repos::roots`].
1316///
1317/// Left on the refuse side, and why:
1318/// - `roles.implementers` / `roles.judges` / `roles.reviewers` — an ordered
1319/// list of *seats*, not a set. A machine's two implementers plus a
1320/// repository's one is three seats nobody asked for and nobody is paying
1321/// for on purpose.
1322/// - `notify.command` — an argv. Concatenating two argvs does not produce a
1323/// program that runs; it produces `["ntfy", "publish", "curl", "-X"]`.
1324/// - `blind.strip_lines` — technically safe to concatenate (each entry is
1325/// matched as an independent substring, so a longer list only strips
1326/// *more*), but left on the refuse side anyway: the same list also drives
1327/// `commit_msg_hook`'s generated `sed` addresses, where position matters,
1328/// and a silent three-layer merge is exactly the kind of surprise
1329/// `refuse_split_arrays` exists to catch rather than to reason about
1330/// case-by-case. A repository that wants one more stripped phrase restates
1331/// the whole list; that restatement is visible in review, an accidental
1332/// concatenation would not be.
1333fn array_merge_policy(key: &str) -> ArrayMerge {
1334 match key {
1335 "verify.e2e" | "verify.gate" | "verify.pre_gate" | "repos.roots" => ArrayMerge::Append,
1336 _ => ArrayMerge::Replace,
1337 }
1338}
1339
1340impl Config {
1341 /// Load one file through teravars: Tera rendering, `[vars]` resolution,
1342 /// and the `include = [...]` directive.
1343 pub fn load(path: &Path) -> Result<Self> {
1344 Self::load_layers(&[path.to_path_buf()])
1345 }
1346
1347 /// The Tera render context shared by every layer: `system.*` (from
1348 /// teravars), `env` (magi's own addition - a config that names a shared
1349 /// build-cache directory or a machine-specific path needs
1350 /// `{{ env.NAME | default(value='...') }}`), and `repo` / `repo_name`
1351 /// derived from the last (highest-priority) path's parent directory.
1352 ///
1353 /// Factored out so [`Config::array_provenance`] can re-render a single
1354 /// layer under the exact same context [`Config::load_layers`] uses for
1355 /// the joint render, rather than drifting from it by accident.
1356 fn render_ctx(paths: &[PathBuf]) -> teravars::Context {
1357 let mut ctx = teravars::system_context();
1358 let env: std::collections::BTreeMap<String, String> = std::env::vars().collect();
1359 ctx.insert("env", &env);
1360 if let Some(last) = paths.last()
1361 && let Some(dir) = last.parent()
1362 {
1363 // A layer extracted from `<remote>/<base>` records the checkout it
1364 // stands for beside itself; its own directory is a cache path.
1365 let dir = std::fs::read_to_string(dir.join(REPO_MARKER))
1366 .map(|s| PathBuf::from(s.trim()))
1367 .unwrap_or_else(|_| dir.to_path_buf());
1368 ctx.insert("repo", &dir.to_string_lossy());
1369 ctx.insert(
1370 "repo_name",
1371 &dir.file_name().unwrap_or_default().to_string_lossy(),
1372 );
1373 }
1374 ctx
1375 }
1376
1377 /// Load and deep-merge a stack of config files, later files winning.
1378 ///
1379 /// This is why the config is TOML-through-teravars rather than plain serde:
1380 /// the roster is a *machine* fact (which CLIs and plans you pay for) while
1381 /// the gate is a *repository* fact (`cargo make check` here, `pnpm test`
1382 /// there). Picking one file and ignoring the other would force every repo
1383 /// to restate the roster.
1384 pub fn load_layers(paths: &[PathBuf]) -> Result<Self> {
1385 let mut engine = teravars::Engine::default();
1386 let ctx = Self::render_ctx(paths);
1387 if paths.len() > 1 {
1388 Self::refuse_split_arrays(paths, &mut engine, &ctx)?;
1389 }
1390 let merged = teravars::load_merged(paths, &mut engine, &ctx).with_context(|| {
1391 format!(
1392 "rendering config via teravars: {}",
1393 paths
1394 .iter()
1395 .map(|p| p.display().to_string())
1396 .collect::<Vec<_>>()
1397 .join(", ")
1398 )
1399 })?;
1400 let mut table = merged.config;
1401 Self::normalize_renamed_keys(paths, &mut engine, &ctx, &mut table)?;
1402 // `[vars]` is teravars' own input, already resolved into the render
1403 // context; `deny_unknown_fields` must not trip over it.
1404 table.remove("vars");
1405 // No layer says anything about `agents`: the roster is whatever is on
1406 // `PATH` now, exactly as when no layer exists at all. An explicit
1407 // `agents = []` is a statement and is kept.
1408 let detect_agents = !table.contains_key("agents");
1409 let mut cfg: Self = toml::Value::Table(table)
1410 .try_into()
1411 .context("deserializing magi config")?;
1412 crate::persona::validate(&cfg.talk.personas)?;
1413 if detect_agents {
1414 cfg.agents = Self::autodetected().agents;
1415 }
1416 Ok(cfg)
1417 }
1418
1419 /// `graph.candidates` was renamed `graph.implementers`. Both spellings are
1420 /// read, but the layers are merged into one table before serde sees it, so
1421 /// an old name in a lower layer and the new name in a higher one would
1422 /// arrive together and fail as a duplicate field instead of letting the
1423 /// higher layer win. Resolve it here: a single layer that writes both is
1424 /// refused (naming both keys and the file); otherwise the value from the
1425 /// last layer that wrote either key becomes `implementers`.
1426 fn normalize_renamed_keys(
1427 paths: &[PathBuf],
1428 engine: &mut teravars::Engine,
1429 ctx: &teravars::Context,
1430 table: &mut toml::map::Map<String, toml::Value>,
1431 ) -> Result<()> {
1432 let both = matches!(
1433 table.get("graph"),
1434 Some(toml::Value::Table(g)) if g.contains_key("candidates") && g.contains_key("implementers")
1435 );
1436 if !both {
1437 return Ok(());
1438 }
1439 let mut winner: Option<toml::Value> = None;
1440 for path in paths {
1441 let one = teravars::load_merged([path], engine, ctx)
1442 .with_context(|| format!("rendering {}", path.display()))?;
1443 let Some(toml::Value::Table(g)) = one.config.get("graph") else {
1444 continue;
1445 };
1446 if g.contains_key("candidates") && g.contains_key("implementers") {
1447 bail!(
1448 "`[graph]` sets both `implementers` and its deprecated alias \n `candidates` in {}; keep only `implementers`.",
1449 path.display()
1450 );
1451 }
1452 if let Some(v) = g.get("implementers").or_else(|| g.get("candidates")) {
1453 winner = Some(v.clone());
1454 }
1455 }
1456 if let Some(toml::Value::Table(g)) = table.get_mut("graph") {
1457 g.remove("candidates");
1458 if let Some(v) = winner {
1459 g.insert("implementers".to_owned(), v);
1460 }
1461 }
1462 Ok(())
1463 }
1464
1465 /// Refuse an array that two layers both declare, unless
1466 /// [`array_merge_policy`] says that key is meant to accumulate.
1467 ///
1468 /// teravars **appends** arrays when it merges layers, and that is wrong for
1469 /// most arrays magi has: `implementers` is an ordered list of seats,
1470 /// `notify.command` is an argv. Concatenating two of them yields something
1471 /// nobody wrote - three implementers out of a machine's two and a
1472 /// repository's one, or an argv of `["ntfy", "publish", "curl", "-X"]`.
1473 ///
1474 /// Replacing instead would be the right merge rule for those keys, but the
1475 /// rule lives in teravars, which several other projects depend on;
1476 /// changing it there is a decision for that crate, not something to fake
1477 /// here by re-reading the files with different semantics and hoping the
1478 /// two paths agree.
1479 ///
1480 /// So magi refuses the ambiguity rather than resolving it silently, for
1481 /// every array key except the short, deliberate list
1482 /// [`array_merge_policy`] marks [`ArrayMerge::Append`] - for those, the
1483 /// concatenation teravars already produces *is* what both files say, so
1484 /// there is nothing to refuse. The cost of guessing wrong on the refused
1485 /// keys is a roster the operator did not ask for and is paying for by the
1486 /// token; the append keys carry no such risk because every element runs
1487 /// (or every directory is scanned) regardless of order.
1488 fn refuse_split_arrays(
1489 paths: &[PathBuf],
1490 engine: &mut teravars::Engine,
1491 ctx: &teravars::Context,
1492 ) -> Result<()> {
1493 let mut seen: std::collections::BTreeMap<String, PathBuf> = Default::default();
1494 for path in paths {
1495 let one = teravars::load_merged([path], engine, ctx)
1496 .with_context(|| format!("rendering {}", path.display()))?;
1497 for key in array_keys(&one.config, "") {
1498 if array_merge_policy(&key) == ArrayMerge::Append {
1499 continue;
1500 }
1501 if let Some(first) = seen.get(&key) {
1502 bail!(
1503 "`{key}` is an array declared in two config layers:\n \
1504 {}\n {}\nteravars appends arrays when it merges, so \
1505 magi would run the concatenation of both - which is \
1506 not what either file says. Declare `{key}` in exactly \
1507 one of them.",
1508 first.display(),
1509 path.display()
1510 );
1511 }
1512 seen.insert(key, path.clone());
1513 }
1514 }
1515 Ok(())
1516 }
1517
1518 /// Which layers contributed to a composed, appendable array key (e.g.
1519 /// `"verify.gate"`), in the same low-to-high-priority order
1520 /// [`Config::load_layers`] concatenates them in. Layers that do not
1521 /// declare `key` at all are omitted.
1522 ///
1523 /// This is a **display aid for `magi doctor` only.** The command list
1524 /// that actually runs always comes from the one joint
1525 /// [`teravars::load_merged`] call in `load_layers`, never from this
1526 /// function - the exact hazard [`Config::refuse_split_arrays`] warns
1527 /// about is two merge paths that might disagree, so this function must
1528 /// never become a second source of the *composed* value, only of which
1529 /// file wrote which line in it.
1530 ///
1531 /// Re-rendering each layer alone can, in principle, resolve a
1532 /// `{{ vars.x }}` differently than the joint render would, if `x` is
1533 /// defined in one layer and referenced in another - the same caveat
1534 /// `refuse_split_arrays`'s structural, key-only check already lives with.
1535 /// None of magi's own gate commands cross that line, and a doctor listing
1536 /// is read by a human who can compare it against the joint one printed
1537 /// alongside it, so this is judged worth the simplicity of not
1538 /// threading provenance through the real load path.
1539 pub fn array_provenance(paths: &[PathBuf], key: &str) -> Vec<(PathBuf, Vec<String>)> {
1540 let mut engine = teravars::Engine::default();
1541 let ctx = Self::render_ctx(paths);
1542 let mut out = Vec::new();
1543 for path in paths {
1544 let Ok(one) = teravars::load_merged([path], &mut engine, &ctx) else {
1545 continue;
1546 };
1547 let mut cur = &one.config;
1548 let mut found = None;
1549 let parts: Vec<&str> = key.split('.').collect();
1550 for (i, part) in parts.iter().enumerate() {
1551 match cur.get(*part) {
1552 Some(toml::Value::Array(a)) if i == parts.len() - 1 => {
1553 found = Some(a);
1554 break;
1555 }
1556 Some(toml::Value::Table(t)) => cur = t,
1557 _ => break,
1558 }
1559 }
1560 let Some(values) = found else { continue };
1561 let strings: Vec<String> = values
1562 .iter()
1563 .filter_map(|v| v.as_str().map(str::to_owned))
1564 .collect();
1565 if !strings.is_empty() {
1566 out.push((path.clone(), strings));
1567 }
1568 }
1569 out
1570 }
1571
1572 /// Each layer rendered on its own, with the outcome per file: the
1573 /// settings screen's way of saying which layer a value came from and which
1574 /// layer is the one that does not parse. A **display aid only**, for the
1575 /// same reason as [`Config::array_provenance`]: the effective config
1576 /// always comes from the one joint [`Config::load_layers`].
1577 pub(crate) fn layer_tables(paths: &[PathBuf]) -> Vec<(PathBuf, Result<toml::Table>)> {
1578 let mut engine = teravars::Engine::default();
1579 let ctx = Self::render_ctx(paths);
1580 paths
1581 .iter()
1582 .map(|path| {
1583 let one = teravars::load_merged([path], &mut engine, &ctx)
1584 .map(|m| m.config)
1585 .with_context(|| format!("rendering {}", path.display()));
1586 (path.clone(), one)
1587 })
1588 .collect()
1589 }
1590
1591 /// Render a composed command list for `magi doctor`: the joined command
1592 /// line the run actually uses, plus - only when more than one layer
1593 /// contributed - which layer wrote which line.
1594 ///
1595 /// A single contributing layer (the common case today) stays the plain
1596 /// one-line summary magi has always printed, `empty` included: that
1597 /// honest "(none — ...)" is what caught a real gate-composition gap
1598 /// before this array could compose at all, and composition should not
1599 /// make the common case noisier.
1600 pub fn describe_composed(
1601 paths: &[PathBuf],
1602 commands: &[String],
1603 key: &str,
1604 empty: &str,
1605 ) -> String {
1606 if commands.is_empty() {
1607 return empty.to_owned();
1608 }
1609 let joined = commands.join(" && ");
1610 let provenance = Self::array_provenance(paths, key);
1611 if provenance.len() <= 1 {
1612 return joined;
1613 }
1614 let mut out = joined;
1615 for (path, cmds) in &provenance {
1616 out.push_str(&format!("\n [{}] {}", path.display(), cmds.join(" && ")));
1617 }
1618 out
1619 }
1620
1621 /// Resolve the config for `repo`, honouring an explicit `--config` path.
1622 ///
1623 /// Returns the config and the layers it came from, empty for built-in
1624 /// defaults. The repository layers come from the remote-tracking ref as it
1625 /// stands (see the module doc); use [`Config::discover_fetched`] where a
1626 /// stale ref would matter.
1627 pub fn discover(repo: &Path, explicit: Option<&Path>) -> Result<(Self, Vec<PathBuf>)> {
1628 if let Some(p) = explicit {
1629 let paths = vec![p.to_path_buf()];
1630 return Ok((Self::load_layers(&paths)?, paths));
1631 }
1632 let paths = Self::layers_checked(repo)?;
1633 if paths.is_empty() {
1634 return Ok((Self::autodetected(), paths));
1635 }
1636 Ok((Self::load_layers(&paths)?, paths))
1637 }
1638
1639 /// [`Config::discover`] after `git fetch <remote> <base>`: for every path
1640 /// that is about to start work. A failed fetch is an error.
1641 pub async fn discover_fetched(
1642 repo: &Path,
1643 explicit: Option<&Path>,
1644 ) -> Result<(Self, Vec<PathBuf>)> {
1645 if explicit.is_none() && is_git_worktree(repo) {
1646 // A checkout that was never cloned from the remote has no
1647 // `<remote>/HEAD`; learn it here (refs/remotes only) so an
1648 // ordinary start recovers instead of failing in `discover`.
1649 let (remote, cfg_base) = probe_remote_base(repo);
1650 let base = crate::git::merge_base_branch(repo, &remote, cfg_base.as_deref()).await?;
1651 let out = crate::git::fetch(repo, &remote, &base)
1652 .await
1653 .with_context(|| format!("fetching {remote}/{base} to read magi.toml"))?;
1654 if !out.ok() {
1655 bail!(
1656 "cannot read magi.toml: `git fetch {remote} {base}` failed ({}); refusing to use the local checkout's copy, which may be stale",
1657 out.stderr.lines().next().unwrap_or("").trim()
1658 );
1659 }
1660 if cfg_base.is_none() {
1661 crate::git::ensure_remote_head(repo, &remote, &base).await;
1662 }
1663 }
1664 Self::discover(repo, explicit)
1665 }
1666
1667 /// [`Config::layers`], but an unreadable remote ref is an error.
1668 fn layers_checked(repo: &Path) -> Result<Vec<PathBuf>> {
1669 if !is_git_worktree(repo) {
1670 return Ok(Self::layers(repo));
1671 }
1672 let mut paths: Vec<PathBuf> = Self::machine_layer()
1673 .into_iter()
1674 .filter(|p| p.is_file())
1675 .collect();
1676 paths.extend(Self::repo_layers(repo)?);
1677 Ok(paths)
1678 }
1679
1680 /// Only the repository layers (lowest first), from `<remote>/<base>` in a
1681 /// git working tree and from disk elsewhere.
1682 pub(crate) fn repo_layers(repo: &Path) -> Result<Vec<PathBuf>> {
1683 if !is_git_worktree(repo) {
1684 return Ok([
1685 repo.join(".magi").join("config.toml"),
1686 repo.join("magi.toml"),
1687 ]
1688 .into_iter()
1689 .filter(|p| p.is_file())
1690 .collect());
1691 }
1692 remote_layers(repo)
1693 }
1694
1695 /// Environment variable that relocates the machine-wide config layer.
1696 ///
1697 /// Set it to a directory and magi reads `<dir>/magi/config.toml` instead
1698 /// of the one under [`dirs::config_dir`]; set it to the empty string and
1699 /// magi reads no machine layer at all.
1700 ///
1701 /// This exists because the machine layer is otherwise unavoidable, and a
1702 /// test that builds a config fixture is not asking for the operator's
1703 /// preferences to be merged into it. Adding `[repos] roots` to the real
1704 /// machine config on a development box turned two passing tests red -
1705 /// `repos_list_returns_name_and_path_for_every_configured_root` and
1706 /// `repos_list_only_rescans_within_the_ttl_when_asked_to`, whose fixtures
1707 /// declare `[repos] roots` of their own, which [`Config::layers`] then
1708 /// found in two layers and [`Config::refuse_split_arrays`] correctly
1709 /// refused. CI never saw it: a runner has no machine config, so the suite
1710 /// was green there and red only where somebody actually uses magi.
1711 ///
1712 /// An operator gets the same escape hatch for free: a second machine
1713 /// config, or none, without moving files about.
1714 pub const CONFIG_DIR_ENV: &str = "MAGI_CONFIG_DIR";
1715
1716 /// Every config layer that applies to `repo`, in increasing precedence.
1717 ///
1718 /// The machine layer is whatever [`Config::machine_layer`] resolves to,
1719 /// which is nothing at all in a test build.
1720 pub fn layers(repo: &Path) -> Vec<PathBuf> {
1721 let mut paths = Vec::new();
1722 paths.extend(Self::machine_layer());
1723 paths.push(repo.join(".magi").join("config.toml"));
1724 paths.push(repo.join("magi.toml"));
1725 paths.retain(|p| p.is_file());
1726 paths
1727 }
1728
1729 /// The machine-wide layer's path, when there is one.
1730 ///
1731 /// **A test build has none unless it names one.** A fixture is a complete
1732 /// statement of the config under test, and the operator's own preferences
1733 /// have no business being merged into it - least of all silently, on one
1734 /// machine, in a suite that is green everywhere else.
1735 #[cfg(test)]
1736 pub(crate) fn machine_layer() -> Option<PathBuf> {
1737 std::env::var(Self::CONFIG_DIR_ENV)
1738 .ok()
1739 .filter(|dir| !dir.trim().is_empty())
1740 .map(|dir| PathBuf::from(dir).join("magi").join("config.toml"))
1741 }
1742
1743 /// The machine-wide layer's path, when there is one.
1744 #[cfg(not(test))]
1745 pub(crate) fn machine_layer() -> Option<PathBuf> {
1746 match std::env::var(Self::CONFIG_DIR_ENV) {
1747 // Named, and empty on purpose: no machine layer.
1748 Ok(dir) if dir.trim().is_empty() => None,
1749 Ok(dir) => Some(PathBuf::from(dir).join("magi").join("config.toml")),
1750 Err(_) => dirs::config_dir().map(|dir| dir.join("magi").join("config.toml")),
1751 }
1752 }
1753
1754 /// Built-in config whose roster is the agent CLIs found on `PATH`.
1755 pub fn autodetected() -> Self {
1756 let mut cfg = Self::default();
1757 for (kind, id, model) in [
1758 (AgentKind::Claude, "opus", Some("opus")),
1759 (AgentKind::Claude, "sonnet", Some("sonnet")),
1760 (AgentKind::Antigravity, "antigravity", None),
1761 (AgentKind::Opencode, "opencode", None),
1762 (AgentKind::Codex, "codex", None),
1763 (AgentKind::Omp, "omp", None),
1764 ] {
1765 if kind.program().is_some_and(which) && !cfg.agents.iter().any(|a| a.id == id) {
1766 cfg.agents.push(AgentSpec {
1767 id: id.to_owned(),
1768 kind,
1769 model: model.map(str::to_owned),
1770 command: Vec::new(),
1771 extra_args: Vec::new(),
1772 env: BTreeMap::new(),
1773 prompt_delivery: None,
1774 });
1775 }
1776 }
1777 cfg
1778 }
1779
1780 /// The shared build cache the verify commands and the agents both build
1781 /// into, when the config declares one. See [`Verify::cache_dir`].
1782 pub fn cache_dir(&self) -> Option<PathBuf> {
1783 self.verify.cache_dir()
1784 }
1785
1786 /// Look an agent up by id.
1787 pub fn agent(&self, id: &str) -> Result<&AgentSpec> {
1788 self.agents
1789 .iter()
1790 .find(|a| a.id == id)
1791 .with_context(|| format!("no agent with id `{id}` in the roster"))
1792 }
1793
1794 /// Rotate `count` seats out of `ids`, or out of the whole roster at
1795 /// `offset` when `ids` is empty.
1796 ///
1797 /// The one rotation rule - explicit ids cycle, an empty list rotates the
1798 /// roster - shared by every seat count [`Config::resolve_roles`] fills in,
1799 /// rather than each seat reimplementing it and drifting apart.
1800 fn rotate(&self, ids: &[String], count: usize, offset: usize) -> Result<Vec<AgentSpec>> {
1801 let mut out = Vec::with_capacity(count);
1802 for i in 0..count {
1803 let spec = if ids.is_empty() {
1804 self.agents[(i + offset) % self.agents.len()].clone()
1805 } else {
1806 self.agent(&ids[i % ids.len()])?.clone()
1807 };
1808 out.push(spec);
1809 }
1810 Ok(out)
1811 }
1812
1813 /// `ids`, resolved to specs in the order named, or the whole `[[agents]]`
1814 /// roster in file order when `ids` is empty — the same "explicit ids
1815 /// stand alone, an empty list means the whole roster" rule [`Self::rotate`]
1816 /// applies, but with no `count` to truncate to and no `offset` to wrap by.
1817 /// See [`ResolvedRoles::implementer_roster`] for why a truncated, rotated
1818 /// list cannot answer the question this exists for.
1819 fn full_roster(&self, ids: &[String]) -> Result<Vec<AgentSpec>> {
1820 if ids.is_empty() {
1821 Ok(self.agents.clone())
1822 } else {
1823 ids.iter().map(|id| self.agent(id).cloned()).collect()
1824 }
1825 }
1826
1827 /// Fill the roles out to the configured widths.
1828 ///
1829 /// An empty role list rotates through the whole roster, so a three-agent
1830 /// roster with `implementers = 3` gives one implementation per agent, and
1831 /// `judges = 3` rotates the judge seats by one so that judge *i* is not the
1832 /// author of candidate *i* whenever the roster has more than one agent.
1833 pub fn resolve_roles(&self) -> Result<ResolvedRoles> {
1834 if self.agents.is_empty() {
1835 bail!(
1836 "agent roster is empty: no agent CLI found on PATH and no \
1837 [[agents]] in the config. Run `magi init` to write a starter \
1838 magi.toml."
1839 );
1840 }
1841 Ok(ResolvedRoles {
1842 implementers: self.rotate(&self.roles.implementers, self.graph.implementers, 0)?,
1843 judges: self.rotate(&self.roles.judges, self.graph.judges, 1)?,
1844 reviewers: self.rotate(&self.roles.reviewers, self.graph.reviewers, 0)?,
1845 fixer: match self.roles.fixer.as_ref() {
1846 // Ids are validated against the roster here; whether the CLI
1847 // is installed is left to invocation, like every other seat.
1848 Some(choice) => Some(crate::agent::pick_chain(
1849 &self.agents,
1850 Some(choice),
1851 &|_| true,
1852 "fixer",
1853 )?),
1854 None => None,
1855 },
1856 // Role resolution validates roster shape, but deliberately does
1857 // not preflight a CLI. The other graph seats have always deferred
1858 // that failure to invocation; doing it only for the conductor
1859 // made otherwise usable graph commands and `doctor` fail as one.
1860 conductor: match self.roles.conductor.as_ref().map(AgentChoice::ids) {
1861 Some(ids) if ids.len() == 1 => self.agent(ids[0])?.clone(),
1862 // A fallback chain: the first id the roster knows. The rest
1863 // are `agent::pick_chain`'s business at invocation.
1864 Some(ids) if !ids.is_empty() => ids
1865 .iter()
1866 .find_map(|id| self.agent(id).ok())
1867 .cloned()
1868 .with_context(|| {
1869 format!("[roles] conductor names no agent in the roster: {ids:?}")
1870 })?,
1871 // Keep the normal standalone-seat preference when something
1872 // is installed, but retain a roster fallback when it is not.
1873 // Invocation then reports the unavailable CLI in the same
1874 // place it does for every other graph role.
1875 _ => crate::agent::pick(&self.agents, None, &crate::agent::installed)
1876 .unwrap_or_else(|_| self.agents[0].clone()),
1877 },
1878 implementer_roster: self.full_roster(&self.roles.implementers)?,
1879 judge_roster: self.full_roster(&self.roles.judges)?,
1880 reviewer_roster: self.full_roster(&self.roles.reviewers)?,
1881 })
1882 }
1883
1884 /// Advisor seats for the design-deliberation stage (see
1885 /// `graph::Runner::advise`): `[roles] advisors` when set, otherwise the
1886 /// judge roster - see [`Roles::advisors`] for why that fallback and not
1887 /// the whole roster.
1888 ///
1889 /// The fallback rotates with `offset = 1`, matching the judges line in
1890 /// [`Config::resolve_roles`] exactly, `ids` and offset both - not just
1891 /// `roles.judges`, which is empty whenever judges themselves are
1892 /// unconfigured and rotating the whole roster. Falling back with
1893 /// `offset = 0` there would silently hand the advisors a *different*
1894 /// agent set than the judges an unconfigured run would actually get,
1895 /// which is the one thing [`Roles::advisors`]'s doc promises will not
1896 /// happen.
1897 ///
1898 /// Called lazily from the graph node itself rather than folded into
1899 /// [`Config::resolve_roles`]: unlike the other roles, a failure here must
1900 /// not stop a run from starting at all - the deliberation stage is an
1901 /// enrichment `[graph] advise` can turn off, not a seat later nodes
1902 /// cannot proceed without - and at the point `resolve_roles` runs (before
1903 /// [`crate::run::RunState`] exists, on `Runner::start`) there would be no
1904 /// run yet for a resolution failure to be reported against.
1905 pub fn advisors(&self) -> Result<Vec<AgentSpec>> {
1906 if self.agents.is_empty() {
1907 bail!(
1908 "agent roster is empty: no agent CLI found on PATH and no \
1909 [[agents]] in the config. Run `magi init` to write a starter \
1910 magi.toml."
1911 );
1912 }
1913 if !self.roles.advisors.is_empty() {
1914 return self.rotate(&self.roles.advisors, self.graph.advisors, 0);
1915 }
1916 self.rotate(&self.roles.judges, self.graph.advisors, 1)
1917 }
1918
1919 /// The untruncated roster advisor seats hand over along: `[roles]
1920 /// advisors` when set, otherwise the judges' roster, exactly as
1921 /// [`Self::advisors`] chooses its own list.
1922 pub fn advisor_roster(&self) -> Result<Vec<AgentSpec>> {
1923 if self.roles.advisors.is_empty() {
1924 self.full_roster(&self.roles.judges)
1925 } else {
1926 self.full_roster(&self.roles.advisors)
1927 }
1928 }
1929
1930 /// Shell prefix for [`Verify`] commands.
1931 pub fn shell(&self) -> Vec<String> {
1932 if let Some(s) = &self.verify.shell {
1933 return s.clone();
1934 }
1935 if which("sh") {
1936 vec!["sh".to_owned(), "-c".to_owned()]
1937 } else {
1938 vec!["cmd".to_owned(), "/C".to_owned()]
1939 }
1940 }
1941
1942 /// Starter config, as written by `magi init`.
1943 pub fn starter_toml() -> String {
1944 let detected = Self::autodetected();
1945 let mut s = String::from(
1946 "# magi — blind multi-agent implementation competition.\n\
1947 # `magi run \"<task>\"` walks: implement (N parallel worktrees)\n\
1948 # -> blind judging -> deliberation -> private final vote\n\
1949 # -> fold losers -> review + E2E loop -> gate -> merge.\n\
1950 #\n\
1951 # Rendered by teravars: a `[vars]` table, env\n\
1952 # and system lookups, and `include = [...]` all work. Tera\n\
1953 # braces are live everywhere in this file, but comments are\n\
1954 # stripped before rendering (teravars >= 0.2.2), so a comment\n\
1955 # may quote `{{ ... }}` freely.\n\
1956 #\n\
1957 # Layers deep-merge in increasing\n\
1958 # precedence, so the roster can live once per machine in\n\
1959 # <config_dir>/magi/config.toml and each repo only states its own\n\
1960 # gate:\n\
1961 # <config_dir>/magi/config.toml < .magi/config.toml < magi.toml\n\n\
1962 [vars]\n\
1963 # Reference it as vars.cache inside Tera braces, anywhere below.\n\
1964 # Single quotes inside the braces: teravars renders the raw file\n\
1965 # text, so TOML's own \\\" escaping never reaches Tera.\n\
1966 cache = \"{{ env.MAGI_CACHE | default(value='/tmp') }}\"\n\n",
1967 );
1968 if detected.agents.is_empty() {
1969 s.push_str(
1970 "# No agent CLI was found on PATH. Fill this in by hand.\n\
1971 # kind = claude | opencode | antigravity | codex | command\n\
1972 [[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n",
1973 );
1974 } else {
1975 for a in &detected.agents {
1976 s.push_str("[[agents]]\n");
1977 s.push_str(&format!("id = {:?}\n", a.id));
1978 s.push_str(&format!("kind = {:?}\n", a.kind.as_str()));
1979 if let Some(m) = &a.model {
1980 s.push_str(&format!("model = {m:?}\n"));
1981 }
1982 s.push('\n');
1983 }
1984 }
1985 s.push_str(
1986 "# Leave a role list empty to rotate through the roster.\n\
1987 # A non-empty list is also an ordered backup list: seats take entries from the\n\
1988 # front (see [graph] counts) and a failed or out-of-quota seat moves on to the\n\
1989 # next agent to its right, each tried once. Same for judges and reviewers.\n\
1990 # implementers = [\"opus\", \"codex\", \"sonnet\"] # with implementers = 1 below: opus sits, codex then sonnet are spares\n\
1991 [roles]\n\
1992 implementers = []\n\
1993 judges = []\n\
1994 reviewers = []\n\
1995 # conductor = \"opus\" # arranges the queue; unset picks a seat like chatter does\n\
1996 # synthesizer = \"opus\" # blends the advisors into one brief; unset picks a seat like chatter does\n\
1997 # synthesizer = [\"opus\", \"codex\"] # array form: fallback chain, each tried once on quota or failure\n\
1998 # language_judge = \"jev\" # kind = \"command\" wrapper deciding if PR text is English; unset keeps the built-in heuristics\n\
1999 # fixer = \"opus\" # applies review findings; unset keeps the winner's own author\n\
2000 # fixer = [\"opus\", \"codex\"] # array form: fallback chain, each tried once on quota or failure\n\n\
2001 [graph]\n\
2002 # Gate GitHub prose; secret redaction is always enabled.\n\
2003 github_text_guard = true\n\
2004 implementers = 3\n\
2005 judges = 3\n\
2006 deliberate_rounds = 1\n\
2007 reviewers = 3\n\
2008 review_rounds = 6\n\
2009 # Fix rounds a failing verify.gate gets before the run is blocked (0 = none).\n\
2010 gate_fix_rounds = 1\n\
2011 max_parallel = 4\n\
2012 language = \"en\"\n\
2013 # One CLI conversation per seat: judges keep their own argument\n\
2014 # across deliberation, the fixer keeps its implementation context.\n\
2015 sessions = true\n\
2016 # Reviewer-seat timeout. When timeout_verify is omitted, E2E and\n\
2017 # the final gate inherit this value for compatibility.\n\
2018 timeout_review = 1200\n\
2019 # Optional independent E2E/final-gate timeout; uncomment to keep\n\
2020 # verification independent if timeout_review changes later.\n\
2021 # timeout_verify = 1200\n\n\
2022 # Chat personas (tone only; the web Chat picks one per conversation).\n\
2023 # Built in: magi, rei, misato, ritsuko, shinji, asuka, kaworu. Entries add to\n\
2024 # them, and one with a built-in's id replaces it. `default` is the plain\n\
2025 # voice and cannot be redefined. Declare this in one layer only.\n\
2026 # [[talk.personas]]\n\
2027 # id = \"gendo\"\n\
2028 # name = \"Gendo Ikari\"\n\
2029 # prompt = \"Speak coldly and tersely, hands folded.\"\n\n\
2030 [verify]\n\
2031 # Run once per review round in the winner's worktree; failures are\n\
2032 # fed back to the fixer.\n\
2033 e2e = []\n\
2034 # Final gate. Every command must exit 0 before a merge.\n\
2035 gate = []\n\
2036 # Mechanical fixers (formatters) run in the winner's worktree just\n\
2037 # before the gate; whatever they change becomes one commit. A failing\n\
2038 # command only warns - the gate stays the arbiter. Same timeout as the\n\
2039 # gate (timeout_verify). Keep it light and idempotent.\n\
2040 # pre_gate = []\n\n\
2041 [merge]\n\
2042 # none | local | pr\n\
2043 mode = \"none\"\n\
2044 # release_bump = true # Rust (Cargo.toml) repositories only; a no-op elsewhere\n\n\
2045 [update]\n\
2046 # off | notify | install — checked in the background, throttled.\n\
2047 mode = \"notify\"\n\
2048 # interval = \"24h\"\n\n\
2049 [daemon]\n\
2050 # Minutes a release-bump pull request (chore/release-v*) may sit with\n\
2051 # no new commit and no check changing state before `magi serve`\n\
2052 # notices and asks you. A failed check is rerun once on its own;\n\
2053 # still red after that escalates at once. 0 turns the watcher off.\n\
2054 # release_stall_minutes = 60\n\n\
2055 [release]\n\
2056 # actions (default) | local. \"local\" is for repositories whose GitHub\n\
2057 # Actions never run (private, no minutes): the release pull request\n\
2058 # does not wait for CI, you approve the merge in magi, and then\n\
2059 # `magi serve` pushes the vX.Y.Z tag (never over an existing one) and\n\
2060 # runs `commands` from a clean checkout of the merge commit. A\n\
2061 # failure holds the release with a notice; it is never retried blind.\n\
2062 # Needs `magi serve` running and [daemon] release_stall_minutes > 0.\n\
2063 # mode = \"actions\"\n\
2064 # Run in order; the first failure stops. They see MAGI_RELEASE_VERSION,\n\
2065 # MAGI_RELEASE_TAG, MAGI_RELEASE_COMMIT and MAGI_RELEASE_PR. Make them\n\
2066 # safe to repeat: a crash mid-command is treated as unfinished.\n\
2067 # commands = [\"cargo build --release\", \"gh release create \\\"$MAGI_RELEASE_TAG\\\" --generate-notes\"]\n\
2068 # timeout_minutes = 30\n",
2069 );
2070 s
2071 }
2072}
2073
2074/// Is `program` on `PATH`?
2075pub fn which(program: &str) -> bool {
2076 find_program(program).is_some()
2077}
2078
2079/// The file a bare `program` name resolves to on `PATH`, the way the OS shell
2080/// would find it.
2081///
2082/// Spawn agents through this, not by bare name: on Windows Rust's std
2083/// only tries `name.exe`, so a CLI installed as an npm `.cmd` shim (codex
2084/// since its 2026-09-23 reinstall) is "not found" even though a shell runs it.
2085/// On Windows an extensionless file is never a match: npm writes an `sh`
2086/// script beside every `.cmd` shim, and spawning that fails with os error 193.
2087pub fn find_program(program: &str) -> Option<PathBuf> {
2088 find_program_on(program, &std::env::var_os("PATH")?)
2089}
2090
2091/// [`find_program`] against an explicit `PATH`, for a child whose environment
2092/// overrides it.
2093pub fn find_program_on(program: &str, paths: &std::ffi::OsStr) -> Option<PathBuf> {
2094 let pathext = std::env::var("PATHEXT").unwrap_or_else(|_| ".EXE;.CMD;.BAT".into());
2095 find_program_in(program, paths, cfg!(windows).then_some(pathext.as_str()))
2096}
2097
2098fn find_program_in(
2099 program: &str,
2100 paths: &std::ffi::OsStr,
2101 pathext: Option<&str>,
2102) -> Option<PathBuf> {
2103 let p = Path::new(program);
2104 if p.components().count() > 1 {
2105 return p.is_file().then(|| p.to_path_buf());
2106 }
2107 std::env::split_paths(paths).find_map(|dir| match pathext {
2108 Some(exts) => {
2109 let bare = dir.join(program);
2110 if p.extension().is_some() && bare.is_file() {
2111 return Some(bare);
2112 }
2113 exts.split(';')
2114 .filter(|e| !e.is_empty())
2115 .map(|e| dir.join(format!("{program}{}", e.to_lowercase())))
2116 .find(|c| c.is_file())
2117 }
2118 None => Some(dir.join(program)).filter(|c| c.is_file()),
2119 })
2120}
2121
2122/// Sidecar naming the checkout an extracted layer stands for.
2123const REPO_MARKER: &str = ".magi-repo";
2124
2125fn git_out(repo: &Path, args: &[&str]) -> Option<String> {
2126 use crate::proc::Quiet as _;
2127 let out = std::process::Command::new("git")
2128 .args(args)
2129 .quiet()
2130 .current_dir(repo)
2131 .stdin(std::process::Stdio::null())
2132 .output()
2133 .ok()?;
2134 out.status
2135 .success()
2136 .then(|| String::from_utf8_lossy(&out.stdout).into_owned())
2137}
2138
2139/// Is `repo` inside a git working tree? A directory that is not has no branch
2140/// to be stale against, so its files are read as they are.
2141fn is_git_worktree(repo: &Path) -> bool {
2142 git_out(repo, &["rev-parse", "--git-dir"]).is_some()
2143}
2144
2145#[derive(Deserialize, Default)]
2146struct ProbeMerge {
2147 base: Option<String>,
2148 remote: Option<String>,
2149}
2150
2151#[derive(Deserialize, Default)]
2152struct Probe {
2153 merge: Option<ProbeMerge>,
2154}
2155
2156/// `[merge]` base / remote from one file, nothing else. The file is rendered
2157/// (env templates, includes) exactly as a real load would, so a machine layer
2158/// saying `base = "{{ env.X }}"` locates the same ref; when rendering fails
2159/// (a checkout file that needs its own repo context) the plain TOML is read
2160/// instead. Unreadable is `None`: the real load reports it.
2161fn probe_merge(path: &Path, repo: &Path) -> Option<ProbeMerge> {
2162 if !path.is_file() {
2163 return None;
2164 }
2165 let paths = [path.to_path_buf()];
2166 let mut engine = teravars::Engine::default();
2167 let mut ctx = Config::render_ctx(&paths);
2168 // The layered load renders every layer for the checkout being resolved;
2169 // so does this, or `{{ repo_name }}` would name the file's own directory.
2170 ctx.insert("repo", &repo.to_string_lossy());
2171 ctx.insert(
2172 "repo_name",
2173 &repo.file_name().unwrap_or_default().to_string_lossy(),
2174 );
2175 if let Ok(merged) = teravars::load_merged(&paths, &mut engine, &ctx)
2176 && let Ok(probe) = toml::Value::Table(merged.config).try_into::<Probe>()
2177 {
2178 return probe.merge;
2179 }
2180 let text = std::fs::read_to_string(path).ok()?;
2181 toml::from_str::<Probe>(&text).ok()?.merge
2182}
2183
2184/// The `[merge] remote` / `base` the layers name, before any git lookup.
2185fn probe_remote_base(repo: &Path) -> (String, Option<String>) {
2186 let mut remote = None;
2187 let mut base = None;
2188 let mut sources: Vec<PathBuf> = Config::machine_layer().into_iter().collect();
2189 sources.push(repo.join("magi.toml"));
2190 sources.push(repo.join(".magi").join("config.toml"));
2191 for path in sources {
2192 if let Some(m) = probe_merge(&path, repo) {
2193 remote = remote.or(m.remote.filter(|s| !s.trim().is_empty()));
2194 base = base.or(m.base.filter(|s| !s.trim().is_empty()));
2195 }
2196 }
2197 (remote.unwrap_or_else(|| "origin".to_owned()), base)
2198}
2199
2200/// Where the remote ref is: see the module doc for the order.
2201fn resolve_remote_base(repo: &Path) -> Result<(String, String)> {
2202 let (remote, base) = probe_remote_base(repo);
2203 let base = match base {
2204 Some(b) => b,
2205 None => {
2206 let head = format!("refs/remotes/{remote}/HEAD");
2207 git_out(repo, &["symbolic-ref", "--quiet", &head])
2208 .and_then(|s| crate::git::remote_head_branch(&remote, &s))
2209 .with_context(|| {
2210 format!(
2211 "cannot tell which branch of `{remote}` holds magi.toml: \
2212 set [merge] base, or run `git remote set-head {remote} -a`"
2213 )
2214 })?
2215 }
2216 };
2217 Ok((remote, base))
2218}
2219
2220fn fnv_hex(text: &str) -> String {
2221 let mut hash: u64 = 0xcbf2_9ce4_8422_2325;
2222 for b in text.bytes() {
2223 hash ^= u64::from(b);
2224 hash = hash.wrapping_mul(0x0100_0000_01b3);
2225 }
2226 format!("{hash:016x}")
2227}
2228
2229/// Does the text declare an `include` directive in any form teravars accepts
2230/// (root `include`, bare or quoted, or `[teravars] include`, as a table or an
2231/// inline table)? Parsed as TOML when it parses; a templated file that does
2232/// not parse is judged by a plain search for the word, because over-detecting
2233/// only costs an extra extraction while missing one fails the load.
2234fn declares_include(text: &str) -> bool {
2235 match toml::from_str::<toml::Table>(text) {
2236 Ok(table) => {
2237 table.contains_key("include")
2238 || table
2239 .get("teravars")
2240 .and_then(toml::Value::as_table)
2241 .is_some_and(|t| t.contains_key("include"))
2242 }
2243 Err(_) => text.contains("include"),
2244 }
2245}
2246
2247/// Unpack the whole tree of `sha` into `dest`, so relative `include`s of a
2248/// repository layer resolve against the same commit.
2249fn extract_tree(repo: &Path, sha: &str, dest: &Path) -> Result<()> {
2250 use crate::proc::Quiet as _;
2251 let mut archive = std::process::Command::new("git")
2252 .args(["archive", "--format=tar", sha])
2253 .quiet()
2254 .current_dir(repo)
2255 .stdin(std::process::Stdio::null())
2256 .stdout(std::process::Stdio::piped())
2257 .stderr(std::process::Stdio::null())
2258 .spawn()
2259 .context("running git archive")?;
2260 let tar = std::process::Command::new("tar")
2261 .arg("-x")
2262 .arg("-C")
2263 .arg(dest)
2264 .quiet()
2265 .stdin(archive.stdout.take().context("git archive has no stdout")?)
2266 .output()
2267 .context("running tar")?;
2268 let status = archive.wait().context("waiting for git archive")?;
2269 if !status.success() || !tar.status.success() {
2270 bail!(
2271 "cannot unpack {sha} for the config's includes: {}",
2272 String::from_utf8_lossy(&tar.stderr).trim()
2273 );
2274 }
2275 Ok(())
2276}
2277
2278/// The repository layers (`.magi/config.toml`, `magi.toml`; lowest first) of
2279/// `<remote>/<base>`, extracted from one commit so both files agree.
2280fn remote_layers(repo: &Path) -> Result<Vec<PathBuf>> {
2281 let (remote, base) = resolve_remote_base(repo)?;
2282 let tracking = format!("refs/remotes/{remote}/{base}");
2283 let spec = format!("{tracking}^{{commit}}");
2284 let sha = git_out(repo, &["rev-parse", "--verify", "--quiet", &spec])
2285 .map(|s| s.trim().to_owned())
2286 .filter(|s| !s.is_empty())
2287 .with_context(|| {
2288 format!(
2289 "`{remote}/{base}` does not exist in this checkout; fetch it \
2290 (`git fetch {remote} {base}`) or set [merge] base/remote. magi will not read \
2291 a possibly stale local magi.toml instead"
2292 )
2293 })?;
2294 let key = format!("{sha}-{}", fnv_hex(&repo.to_string_lossy()));
2295 let rels = [".magi/config.toml", "magi.toml"];
2296 let mut texts: Vec<(&str, String)> = Vec::new();
2297 for rel in rels {
2298 let object = format!("{sha}:{rel}");
2299 if git_out(repo, &["cat-file", "-e", &object]).is_none() {
2300 continue;
2301 }
2302 let Some(text) = git_out(repo, &["show", &object]) else {
2303 bail!("cannot read {rel} from {remote}/{base} ({sha})");
2304 };
2305 texts.push((rel, text));
2306 }
2307 let wants_tree = texts.iter().any(|(_, t)| declares_include(t));
2308 // Content-addressed and built beside the final name, then renamed in: a
2309 // concurrent `discover` sees the whole directory or none of it, never a
2310 // half-written file.
2311 let build = |root: &Path| -> Result<PathBuf> {
2312 let final_dir = root.join(&key);
2313 if !final_dir.is_dir() {
2314 std::fs::create_dir_all(root)?;
2315 let tmp = root.join(format!(
2316 "{key}.tmp-{}-{}",
2317 std::process::id(),
2318 std::time::SystemTime::now()
2319 .duration_since(std::time::UNIX_EPOCH)
2320 .map(|d| d.as_nanos())
2321 .unwrap_or_default()
2322 ));
2323 let filled = (|| -> Result<()> {
2324 std::fs::create_dir_all(&tmp)?;
2325 if wants_tree {
2326 extract_tree(repo, &sha, &tmp)?;
2327 }
2328 for (rel, text) in &texts {
2329 let file = tmp.join(rel);
2330 let parent = file.parent().unwrap_or(&tmp);
2331 std::fs::create_dir_all(parent)?;
2332 std::fs::write(&file, text)?;
2333 std::fs::write(parent.join(REPO_MARKER), repo.to_string_lossy().as_bytes())?;
2334 }
2335 Ok(())
2336 })();
2337 if let Err(e) = filled {
2338 let _ = std::fs::remove_dir_all(&tmp);
2339 return Err(e);
2340 }
2341 if std::fs::rename(&tmp, &final_dir).is_err() {
2342 // Lost the race to another process building the same commit.
2343 let _ = std::fs::remove_dir_all(&tmp);
2344 if !final_dir.is_dir() {
2345 bail!("cannot place {}", final_dir.display());
2346 }
2347 }
2348 }
2349 Ok(final_dir)
2350 };
2351 let common = git_out(
2352 repo,
2353 &["rev-parse", "--path-format=absolute", "--git-common-dir"],
2354 )
2355 .map(|s| PathBuf::from(s.trim()).join("magi").join("config"));
2356 let dir = match common.map(|c| build(&c)) {
2357 Some(Ok(d)) => d,
2358 _ => build(&std::env::temp_dir().join("magi-config"))
2359 .with_context(|| format!("extracting config from {remote}/{base}"))?,
2360 };
2361 Ok(texts.iter().map(|(rel, _)| dir.join(rel)).collect())
2362}
2363
2364#[cfg(test)]
2365mod tests {
2366 #[test]
2367 fn context_window_prefers_exact_then_longest_prefix_and_user_over_builtin() {
2368 let mut cfg = Config::default();
2369 assert_eq!(
2370 cfg.context_window("claude-sonnet-4-5-20250929"),
2371 Some(200_000)
2372 );
2373 assert_eq!(cfg.context_window("gpt-4.1-mini"), Some(1_000_000));
2374 assert_eq!(cfg.context_window("mystery-model"), None);
2375 cfg.context_windows
2376 .insert("claude-sonnet-4-5".into(), 1_000_000);
2377 cfg.context_windows.insert("claude-sonnet-4".into(), 5);
2378 cfg.context_windows.insert("mystery".into(), 32_768);
2379 // Longest user prefix beats a shorter one and the built-in table.
2380 assert_eq!(
2381 cfg.context_window("claude-sonnet-4-5-20250929"),
2382 Some(1_000_000)
2383 );
2384 // An exact name beats any prefix.
2385 cfg.context_windows
2386 .insert("claude-sonnet-4-5-20250929".into(), 7);
2387 assert_eq!(cfg.context_window("claude-sonnet-4-5-20250929"), Some(7));
2388 assert_eq!(cfg.context_window("mystery-model"), Some(32_768));
2389 }
2390
2391 use super::*;
2392
2393 /// npm writes an extensionless `sh` script beside `codex.cmd`; on Windows
2394 /// the `.cmd` is the spawnable one (os error 193 otherwise, 2026-09-23).
2395 #[test]
2396 fn windows_lookup_picks_the_cmd_shim_over_the_extensionless_script() {
2397 let dir = tempfile::tempdir().unwrap();
2398 std::fs::write(dir.path().join("codex"), "#!/bin/sh\n").unwrap();
2399 std::fs::write(dir.path().join("codex.cmd"), "@echo off\n").unwrap();
2400 let paths = dir.path().as_os_str();
2401 assert_eq!(
2402 find_program_in("codex", paths, Some(".EXE;.CMD")),
2403 Some(dir.path().join("codex.cmd"))
2404 );
2405 assert_eq!(
2406 find_program_in("codex", paths, None),
2407 Some(dir.path().join("codex"))
2408 );
2409 assert_eq!(find_program_in("claude", paths, Some(".EXE;.CMD")), None);
2410 }
2411
2412 fn spec(id: &str) -> AgentSpec {
2413 AgentSpec {
2414 id: id.to_owned(),
2415 kind: AgentKind::Command,
2416 model: None,
2417 command: vec!["true".to_owned()],
2418 extra_args: Vec::new(),
2419 env: BTreeMap::new(),
2420 prompt_delivery: None,
2421 }
2422 }
2423
2424 #[test]
2425 fn github_text_guard_defaults_on_and_can_be_disabled() {
2426 let default: Graph = toml::from_str("").unwrap();
2427 assert!(default.github_text_guard);
2428 let disabled: Graph = toml::from_str("github_text_guard = false").unwrap();
2429 assert!(!disabled.github_text_guard);
2430 let config = layered("", "[graph]\ngithub_text_guard = false\n").unwrap();
2431 assert!(!config.graph.github_text_guard);
2432 assert!(Config::starter_toml().contains("github_text_guard = true"));
2433 }
2434
2435 #[test]
2436 fn timeout_verify_omitted_from_old_toml_inherits_timeout_review() {
2437 // `timeout_verify` used to not exist: `verify.e2e`/`verify.gate` ran
2438 // under `timeout_review`. A config written before this field existed
2439 // must run exactly as before, which means its default has to be the
2440 // same 1200s `timeout_review` has always defaulted to.
2441 let g: Graph = toml::from_str("timeout_review = 3600").expect("parse");
2442 assert_eq!(g.timeout_verify, None);
2443 assert_eq!(g.verify_timeout(), 3600);
2444 }
2445
2446 #[test]
2447 fn shrinking_timeout_review_does_not_shrink_timeout_verify() {
2448 // The bug this field exists to close: `[graph] timeout_review = 45`
2449 // used to shrink the real-machine `verify.e2e`/`verify.gate` budget
2450 // along with the reviewer seats' own timeout, because both read the
2451 // same field.
2452 let g: Graph = toml::from_str("timeout_review = 45").expect("parse");
2453 assert_eq!(g.timeout_review, 45);
2454 assert_eq!(
2455 g.verify_timeout(),
2456 45,
2457 "an omitted legacy value follows review"
2458 );
2459 let explicit: Graph = toml::from_str("timeout_review = 45\ntimeout_verify = 1200")
2460 .expect("parse explicit override");
2461 assert_eq!(explicit.verify_timeout(), 1200);
2462 }
2463
2464 #[test]
2465 fn graph_implementers_new_key_loads_and_old_key_is_an_alias() {
2466 let g: Graph = toml::from_str("implementers = 4\n").unwrap();
2467 assert_eq!(g.implementers, 4);
2468 let g: Graph = toml::from_str("candidates = 5\n").unwrap();
2469 assert_eq!(g.implementers, 5);
2470 }
2471
2472 fn layered(lower: &str, upper: &str) -> Result<Config> {
2473 let dir = tempfile::tempdir().unwrap();
2474 let a = dir.path().join("a.toml");
2475 let b = dir.path().join("b.toml");
2476 std::fs::write(&a, lower).unwrap();
2477 std::fs::write(&b, upper).unwrap();
2478 Config::load_layers(&[a, b])
2479 }
2480
2481 #[test]
2482 fn graph_implementers_higher_layer_wins_across_spellings() {
2483 let c = layered("[graph]\ncandidates = 2\n", "[graph]\nimplementers = 5\n").unwrap();
2484 assert_eq!(c.graph.implementers, 5);
2485 let c = layered("[graph]\nimplementers = 2\n", "[graph]\ncandidates = 5\n").unwrap();
2486 assert_eq!(c.graph.implementers, 5);
2487 let c = layered("[graph]\ncandidates = 2\n", "[graph]\njudges = 3\n").unwrap();
2488 assert_eq!(c.graph.implementers, 2);
2489 }
2490
2491 #[test]
2492 fn graph_implementers_both_keys_in_one_layer_is_refused() {
2493 let err = layered("", "[graph]\ncandidates = 2\nimplementers = 3\n")
2494 .unwrap_err()
2495 .to_string();
2496 assert!(
2497 err.contains("candidates") && err.contains("implementers"),
2498 "{err}"
2499 );
2500 assert!(err.contains("b.toml"), "{err}");
2501 }
2502
2503 #[test]
2504 fn a_toml_layer_written_before_these_fields_existed_still_parses() {
2505 // `deny_unknown_fields` cuts both ways: a config from before
2506 // `timeout_verify`/`e2e_every_round` existed must still parse, with
2507 // both defaulted rather than refused as unknown-in-reverse.
2508 let g: Graph =
2509 toml::from_str("candidates = 1\nreviewers = 3\nreview_rounds = 6\nmax_parallel = 4\n")
2510 .expect("an old-shaped [graph] table must still parse");
2511 assert_eq!(g.verify_timeout(), Graph::default().timeout_review);
2512 assert!(
2513 !g.e2e_every_round,
2514 "off by default, same as before this field existed"
2515 );
2516 }
2517
2518 #[test]
2519 fn empty_roles_rotate_judges_off_their_own_candidate() {
2520 // Three seats, said out loud: this is a test about *rotation*, and it
2521 // has nothing to say about how many candidates a task buys by default.
2522 let cfg = Config {
2523 agents: vec![spec("a"), spec("b"), spec("c")],
2524 graph: Graph {
2525 implementers: 3,
2526 ..Graph::default()
2527 },
2528 ..Config::default()
2529 };
2530 let roles = cfg.resolve_roles().unwrap();
2531 let impls: Vec<&str> = roles.implementers.iter().map(|a| a.id.as_str()).collect();
2532 let judges: Vec<&str> = roles.judges.iter().map(|a| a.id.as_str()).collect();
2533 assert_eq!(impls, ["a", "b", "c"]);
2534 assert_eq!(judges, ["b", "c", "a"]);
2535 for (i, j) in judges.iter().enumerate() {
2536 assert_ne!(*j, impls[i], "judge {i} must not sit on its own candidate");
2537 }
2538 }
2539
2540 #[test]
2541 fn single_agent_roster_fills_every_seat() {
2542 let cfg = Config {
2543 agents: vec![spec("solo")],
2544 graph: Graph {
2545 implementers: 3,
2546 ..Graph::default()
2547 },
2548 ..Config::default()
2549 };
2550 let roles = cfg.resolve_roles().unwrap();
2551 assert_eq!(roles.implementers.len(), 3);
2552 assert!(roles.judges.iter().all(|a| a.id == "solo"));
2553 }
2554
2555 #[test]
2556 fn implementer_roster_is_the_whole_agent_list_untruncated_when_unset() {
2557 // `implementers = 1` (a solo run) still resolves `implementers` down to
2558 // one slot, but `implementer_roster` must carry every agent in the
2559 // roster, in file order, for `graph::Runner`'s quota fallback to walk
2560 // forward through once that one slot's agent runs out of quota.
2561 let cfg = Config {
2562 agents: vec![spec("a"), spec("b"), spec("c")],
2563 graph: Graph {
2564 implementers: 1,
2565 ..Graph::default()
2566 },
2567 ..Config::default()
2568 };
2569 let roles = cfg.resolve_roles().unwrap();
2570 assert_eq!(roles.implementers.len(), 1);
2571 let roster: Vec<&str> = roles
2572 .implementer_roster
2573 .iter()
2574 .map(|a| a.id.as_str())
2575 .collect();
2576 assert_eq!(roster, ["a", "b", "c"]);
2577 }
2578
2579 #[test]
2580 fn implementer_roster_follows_explicit_ids_in_the_order_named() {
2581 let cfg = Config {
2582 agents: vec![spec("a"), spec("b"), spec("c")],
2583 roles: Roles {
2584 implementers: vec!["c".to_owned(), "a".to_owned()],
2585 ..Roles::default()
2586 },
2587 graph: Graph {
2588 implementers: 1,
2589 ..Graph::default()
2590 },
2591 ..Config::default()
2592 };
2593 let roles = cfg.resolve_roles().unwrap();
2594 // Unaffected by the new field: still just the first named id.
2595 assert_eq!(roles.implementers.len(), 1);
2596 assert_eq!(roles.implementers[0].id, "c");
2597 let roster: Vec<&str> = roles
2598 .implementer_roster
2599 .iter()
2600 .map(|a| a.id.as_str())
2601 .collect();
2602 assert_eq!(roster, ["c", "a"]);
2603 }
2604
2605 #[test]
2606 fn explicit_roles_win() {
2607 let cfg = Config {
2608 agents: vec![spec("a"), spec("b")],
2609 roles: Roles {
2610 implementers: vec!["b".to_owned()],
2611 judges: vec!["a".to_owned()],
2612 reviewers: Vec::new(),
2613 fixer: Some("a".into()),
2614 ..Roles::default()
2615 },
2616 ..Config::default()
2617 };
2618 let roles = cfg.resolve_roles().unwrap();
2619 assert!(roles.implementers.iter().all(|a| a.id == "b"));
2620 assert!(roles.judges.iter().all(|a| a.id == "a"));
2621 let fixer = roles.fixer.unwrap();
2622 assert_eq!(fixer.len(), 1);
2623 assert_eq!(fixer[0].id, "a");
2624 assert_eq!(roles.conductor.id, "a");
2625 }
2626
2627 #[test]
2628 fn fixer_takes_a_string_or_an_ordered_chain() {
2629 let one: Roles = toml::from_str("fixer = \"a\"").unwrap();
2630 assert_eq!(one.fixer.as_ref().unwrap().ids(), ["a"]);
2631 let chain: Roles = toml::from_str("fixer = [\"b\", \"a\"]").unwrap();
2632 assert_eq!(chain.fixer.as_ref().unwrap().ids(), ["b", "a"]);
2633
2634 let resolve = |fixer: Option<AgentChoice>| {
2635 Config {
2636 agents: vec![spec("a"), spec("b"), spec("c")],
2637 roles: Roles {
2638 fixer,
2639 ..Roles::default()
2640 },
2641 ..Config::default()
2642 }
2643 .resolve_roles()
2644 };
2645 let ids = |r: &ResolvedRoles| -> Vec<String> {
2646 r.fixer
2647 .as_ref()
2648 .unwrap()
2649 .iter()
2650 .map(|s| s.id.clone())
2651 .collect()
2652 };
2653 // The string form is a chain of one; unset stays unset (the winner's author).
2654 assert_eq!(ids(&resolve(Some("c".into())).unwrap()), ["c"]);
2655 assert!(resolve(None).unwrap().fixer.is_none());
2656 // Order kept, an unknown id skipped, a duplicate keeps its first place.
2657 let chain = AgentChoice::Chain(vec!["b".into(), "zzz".into(), "a".into(), "b".into()]);
2658 assert_eq!(ids(&resolve(Some(chain)).unwrap()), ["b", "a"]);
2659 // Nothing resolving names the role.
2660 let err = resolve(Some(AgentChoice::Chain(vec!["zzz".into()]))).unwrap_err();
2661 assert!(format!("{err:#}").contains("fixer"), "{err:#}");
2662 }
2663
2664 #[test]
2665 fn unknown_agent_id_is_an_error() {
2666 let cfg = Config {
2667 agents: vec![spec("a")],
2668 roles: Roles {
2669 judges: vec!["nope".to_owned()],
2670 ..Roles::default()
2671 },
2672 ..Config::default()
2673 };
2674 assert!(cfg.resolve_roles().is_err());
2675 }
2676
2677 #[test]
2678 fn conductor_role_is_resolved_validated_and_has_a_fallback() {
2679 let mut cfg = Config {
2680 agents: vec![spec("a"), spec("b")],
2681 ..Config::default()
2682 };
2683 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "a");
2684
2685 cfg.roles.conductor = Some("b".into());
2686 assert_eq!(cfg.resolve_roles().unwrap().conductor.id, "b");
2687
2688 cfg.roles.conductor = Some("missing".into());
2689 assert!(cfg.resolve_roles().is_err());
2690 }
2691
2692 #[test]
2693 fn a_standalone_role_takes_a_string_or_an_array_and_round_trips() {
2694 let one: Roles = toml::from_str("synthesizer = \"opus\"").unwrap();
2695 assert_eq!(one.synthesizer, Some(AgentChoice::One("opus".to_owned())));
2696 assert_eq!(primary(one.synthesizer.as_ref()), Some("opus"));
2697
2698 let chain: Roles = toml::from_str("chatter = [\"opus\", \"codex\"]").unwrap();
2699 assert_eq!(chain.chatter.as_ref().unwrap().ids(), ["opus", "codex"]);
2700 assert_eq!(primary(chain.chatter.as_ref()), Some("opus"));
2701
2702 for roles in [one, chain] {
2703 let text = toml::to_string(&roles).unwrap();
2704 let back: Roles = toml::from_str(&text).unwrap();
2705 assert_eq!(back.synthesizer, roles.synthesizer);
2706 assert_eq!(back.chatter, roles.chatter);
2707 }
2708 let text = toml::to_string(&Roles {
2709 conductor: Some("x".into()),
2710 ..Roles::default()
2711 })
2712 .unwrap();
2713 assert!(
2714 text.contains("conductor = \"x\""),
2715 "string stays a string: {text}"
2716 );
2717 assert!(toml::from_str::<Roles>("synthesizer = 3").is_err());
2718 }
2719
2720 #[test]
2721 fn an_empty_choice_counts_as_unset() {
2722 assert!(AgentChoice::Chain(Vec::new()).ids().is_empty());
2723 assert!(AgentChoice::One(" ".to_owned()).ids().is_empty());
2724 assert_eq!(primary(Some(&AgentChoice::Chain(vec![]))), None);
2725 }
2726
2727 #[test]
2728 fn synthesizer_role_is_a_lazy_lookup_with_the_same_fallback_as_chatter() {
2729 // Unlike `conductor`, `synthesizer` is never validated by
2730 // `resolve_roles` — it is looked up lazily by
2731 // `graph::Runner::synthesize_brief` the same way `[roles] chatter`
2732 // is looked up by `talk::begin`, so this exercises `agent::pick`
2733 // directly instead of going through `resolve_roles`.
2734 let mut cfg = Config {
2735 agents: vec![spec("a"), spec("b")],
2736 ..Config::default()
2737 };
2738 let want = primary(cfg.roles.synthesizer.as_ref());
2739 assert_eq!(
2740 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2741 .unwrap()
2742 .id,
2743 "a",
2744 "unset falls back to agent::pick's own default order"
2745 );
2746
2747 cfg.roles.synthesizer = Some("b".into());
2748 let want = primary(cfg.roles.synthesizer.as_ref());
2749 assert_eq!(
2750 crate::agent::pick(&cfg.agents, want, &crate::agent::installed)
2751 .unwrap()
2752 .id,
2753 "b",
2754 "the named agent wins over the default order"
2755 );
2756 }
2757
2758 #[test]
2759 fn empty_roster_is_an_error() {
2760 assert!(Config::default().resolve_roles().is_err());
2761 }
2762
2763 #[test]
2764 fn advise_defaults_to_on_with_three_proposals() {
2765 let g = Graph::default();
2766 assert!(g.advise);
2767 assert_eq!(g.advisors, 3);
2768 }
2769
2770 #[test]
2771 fn unset_advisors_falls_back_to_the_judge_roster() {
2772 let cfg = Config {
2773 agents: vec![spec("a"), spec("b")],
2774 roles: Roles {
2775 judges: vec!["b".to_owned()],
2776 ..Roles::default()
2777 },
2778 graph: Graph {
2779 advisors: 2,
2780 ..Graph::default()
2781 },
2782 ..Config::default()
2783 };
2784 let advisors = cfg.advisors().expect("advisors resolve");
2785 assert_eq!(advisors.len(), 2);
2786 assert!(
2787 advisors.iter().all(|a| a.id == "b"),
2788 "an unset [roles] advisors must fall back to [roles] judges: {advisors:?}"
2789 );
2790 }
2791
2792 #[test]
2793 fn an_explicit_advisor_roster_wins_over_the_judge_fallback() {
2794 let cfg = Config {
2795 agents: vec![spec("a"), spec("b")],
2796 roles: Roles {
2797 judges: vec!["b".to_owned()],
2798 advisors: vec!["a".to_owned()],
2799 ..Roles::default()
2800 },
2801 graph: Graph {
2802 advisors: 2,
2803 ..Graph::default()
2804 },
2805 ..Config::default()
2806 };
2807 let advisors = cfg.advisors().expect("advisors resolve");
2808 assert!(advisors.iter().all(|a| a.id == "a"));
2809 }
2810
2811 /// Neither `[roles] advisors` nor `[roles] judges` set: an unconfigured
2812 /// advisor roster must resolve to the exact same agents an unconfigured
2813 /// judge panel would get - same ids, same rotation offset - or the
2814 /// promise in [`Roles::advisors`]'s doc ("advisor diversity for free")
2815 /// does not actually hold.
2816 #[test]
2817 fn an_unconfigured_advisor_and_judge_roster_resolve_to_the_same_agents() {
2818 let cfg = Config {
2819 agents: vec![spec("a"), spec("b"), spec("c")],
2820 graph: Graph {
2821 advisors: 3,
2822 judges: 3,
2823 ..Graph::default()
2824 },
2825 ..Config::default()
2826 };
2827 let advisors = cfg.advisors().expect("advisors resolve");
2828 let judges = cfg.resolve_roles().expect("roles resolve").judges;
2829 let advisor_ids: Vec<&str> = advisors.iter().map(|a| a.id.as_str()).collect();
2830 let judge_ids: Vec<&str> = judges.iter().map(|a| a.id.as_str()).collect();
2831 assert_eq!(
2832 advisor_ids, judge_ids,
2833 "an unconfigured advisor roster must be the same seats an unconfigured judge panel gets"
2834 );
2835 }
2836
2837 #[test]
2838 fn an_unresolvable_advisor_seat_is_an_error_naming_the_id() {
2839 let cfg = Config {
2840 agents: vec![spec("a")],
2841 roles: Roles {
2842 advisors: vec!["nope".to_owned()],
2843 ..Roles::default()
2844 },
2845 graph: Graph {
2846 advisors: 1,
2847 ..Graph::default()
2848 },
2849 ..Config::default()
2850 };
2851 let err = cfg.advisors().expect_err("`nope` is not in the roster");
2852 assert!(format!("{err:#}").contains("nope"));
2853 }
2854
2855 #[test]
2856 fn repos_default_to_no_roots_and_a_day_of_trust() {
2857 assert_eq!(Config::default().repos.roots, Vec::<PathBuf>::new());
2858 assert_eq!(Config::default().repos.scan_ttl, 86_400);
2859 assert_eq!(Config::default().repos.fetch_interval, 600);
2860 }
2861
2862 #[test]
2863 fn a_config_file_with_no_repos_table_still_loads() {
2864 let dir = tempfile::tempdir().unwrap();
2865 let path = dir.path().join("magi.toml");
2866 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
2867 let cfg = Config::load(&path).expect("must load without [repos]");
2868 assert_eq!(cfg.repos.roots, Vec::<PathBuf>::new());
2869 assert_eq!(cfg.repos.scan_ttl, 86_400);
2870 }
2871
2872 /// A fixture is the whole config under test.
2873 ///
2874 /// `layers` used to reach for `dirs::config_dir()` unconditionally, so on
2875 /// a machine where somebody had written `<config_dir>/magi/config.toml`
2876 /// the suite silently loaded it as the lowest layer. Adding `[repos]
2877 /// roots` there turned two web tests red - their fixtures declare
2878 /// `[repos] roots` too, and `refuse_split_arrays` rightly refuses one
2879 /// array key spread across two layers. CI stayed green throughout,
2880 /// because a runner has no such file: the suite failed only where magi is
2881 /// actually used.
2882 ///
2883 /// So a test build has no machine layer unless it asks for one, and this
2884 /// is that promise. Written against a real file at the real location so
2885 /// it fails if `machine_layer` starts reading it again.
2886 #[test]
2887 fn a_test_build_does_not_read_the_operators_machine_config() {
2888 let repo = tempfile::tempdir().unwrap();
2889 std::fs::write(repo.path().join("magi.toml"), "[graph]\ncandidates = 2\n").unwrap();
2890
2891 let layers = Config::layers(repo.path());
2892 assert_eq!(
2893 layers,
2894 vec![repo.path().join("magi.toml")],
2895 "only the fixture's own file may be a layer"
2896 );
2897 if let Some(real) = dirs::config_dir() {
2898 let machine = real.join("magi").join("config.toml");
2899 assert!(
2900 !layers.contains(&machine),
2901 "the operator's {} must not be a layer in a test build",
2902 machine.display()
2903 );
2904 }
2905 }
2906
2907 #[test]
2908 fn starter_toml_loads_through_teravars() {
2909 let dir = tempfile::tempdir().unwrap();
2910 let path = dir.path().join("magi.toml");
2911 std::fs::write(&path, Config::starter_toml()).unwrap();
2912 let parsed = Config::load(&path).expect("starter config must load");
2913 assert_eq!(parsed.graph.implementers, 3);
2914 assert_eq!(parsed.merge.mode, MergeMode::None);
2915 assert_eq!(parsed.merge.style, MergeStyle::Merge);
2916 assert!(parsed.graph.sessions);
2917 assert!(parsed.graph.github_text_guard);
2918 assert_eq!(parsed.graph.timeout_review, 1200);
2919 assert_eq!(parsed.graph.verify_timeout(), 1200);
2920 assert_eq!(parsed.update.mode, UpdateMode::Notify);
2921 }
2922
2923 #[test]
2924 fn release_defaults_to_actions_and_the_starter_documents_it() {
2925 let dir = tempfile::tempdir().unwrap();
2926 let path = dir.path().join("magi.toml");
2927 std::fs::write(&path, Config::starter_toml()).unwrap();
2928 let r = Config::load(&path).unwrap().release;
2929 assert_eq!(r.mode, ReleaseMode::Actions);
2930 assert!(!r.is_local());
2931 assert!(r.commands.is_empty());
2932 assert_eq!(r.timeout_minutes, 30);
2933 assert!(Config::starter_toml().contains("# mode = \"actions\""));
2934 }
2935
2936 #[test]
2937 fn release_local_parses_and_unknown_keys_are_refused() {
2938 let dir = tempfile::tempdir().unwrap();
2939 let path = dir.path().join("magi.toml");
2940 std::fs::write(
2941 &path,
2942 "[release]\nmode = \"local\"\ncommands = [\"true\", \"echo $MAGI_RELEASE_TAG\"]\ntimeout_minutes = 5\n",
2943 )
2944 .unwrap();
2945 let r = Config::load(&path).unwrap().release;
2946 assert!(r.is_local());
2947 assert_eq!(r.commands.len(), 2);
2948 assert_eq!(r.timeout_minutes, 5);
2949 std::fs::write(&path, "[release]\nmode = \"local\"\nbogus = 1\n").unwrap();
2950 assert!(Config::load(&path).is_err());
2951 std::fs::write(&path, "[release]\nmode = \"gha\"\n").unwrap();
2952 assert!(Config::load(&path).is_err());
2953 }
2954
2955 #[test]
2956 fn pre_gate_defaults_to_empty_and_the_starter_documents_it() {
2957 let dir = tempfile::tempdir().unwrap();
2958 let path = dir.path().join("magi.toml");
2959 std::fs::write(&path, Config::starter_toml()).unwrap();
2960 assert!(Config::load(&path).unwrap().verify.pre_gate.is_empty());
2961 assert!(Config::starter_toml().contains("# pre_gate = []"));
2962 }
2963
2964 #[test]
2965 fn starter_toml_explains_inherited_and_explicit_verify_timeouts() {
2966 let starter = Config::starter_toml();
2967 assert!(starter.contains("When timeout_verify is omitted, E2E and"));
2968 assert!(starter.contains("verification independent if timeout_review changes later"));
2969 assert!(starter.contains("# timeout_verify = 1200"));
2970 }
2971
2972 #[test]
2973 fn starter_toml_documents_chat_personas() {
2974 let starter = Config::starter_toml();
2975 assert!(starter.contains("# [[talk.personas]]"));
2976 assert!(starter.contains("tone only"));
2977 }
2978
2979 #[test]
2980 fn talk_personas_parse_and_are_validated() {
2981 let dir = tempfile::tempdir().unwrap();
2982 let path = dir.path().join("magi.toml");
2983 std::fs::write(
2984 &path,
2985 "[[talk.personas]]\nid = \"rei\"\nname = \"Quiet\"\nprompt = \"Be brief.\"\n\n\
2986 [[talk.personas]]\nid = \"gendo\"\nname = \"Gendo\"\nprompt = \"Be cold.\"\n",
2987 )
2988 .unwrap();
2989 let cfg = Config::load(&path).expect("loads");
2990 assert_eq!(cfg.talk.personas.len(), 2);
2991 let catalog = crate::persona::catalog(&cfg.talk.personas);
2992 let rei = catalog.iter().find(|p| p.id == "rei").unwrap();
2993 assert_eq!(
2994 (rei.name.as_str(), rei.prompt.as_str()),
2995 ("Quiet", "Be brief.")
2996 );
2997 assert_eq!(catalog.last().unwrap().id, "gendo");
2998
2999 for (body, needle) in [
3000 (
3001 "[[talk.personas]]\nid = \"\"\nname = \"n\"\nprompt = \"p\"\n",
3002 "empty `id`",
3003 ),
3004 (
3005 "[[talk.personas]]\nid = \"a\"\nname = \"n\"\nprompt = \" \"\n",
3006 "empty `prompt`",
3007 ),
3008 (
3009 "[[talk.personas]]\nid = \"a\"\nname = \"n\"\nprompt = \"p\"\n\
3010 [[talk.personas]]\nid = \"a\"\nname = \"m\"\nprompt = \"q\"\n",
3011 "more than once",
3012 ),
3013 (
3014 "[[talk.personas]]\nid = \"default\"\nname = \"n\"\nprompt = \"p\"\n",
3015 "cannot be redefined",
3016 ),
3017 ] {
3018 std::fs::write(&path, body).unwrap();
3019 let err = format!("{:#}", Config::load(&path).unwrap_err());
3020 assert!(err.contains(needle), "{needle}: {err}");
3021 }
3022 }
3023
3024 #[test]
3025 fn talk_personas_in_two_layers_are_refused() {
3026 let dir = tempfile::tempdir().unwrap();
3027 let machine = dir.path().join("machine.toml");
3028 let repo = dir.path().join("repo.toml");
3029 let one = "[[talk.personas]]\nid = \"a\"\nname = \"n\"\nprompt = \"p\"\n";
3030 std::fs::write(&machine, one).unwrap();
3031 std::fs::write(&repo, one.replace("\"a\"", "\"b\"")).unwrap();
3032 let err = format!("{:#}", Config::load_layers(&[machine, repo]).unwrap_err());
3033 assert!(err.contains("talk.personas"), "{err}");
3034 }
3035
3036 #[test]
3037 fn starter_toml_documents_role_lists_as_backup_order() {
3038 let starter = Config::starter_toml();
3039 assert!(starter.contains("also an ordered backup list"));
3040 assert!(starter.contains("codex then sonnet are spares"));
3041 }
3042
3043 /// A repository whose ruleset forbids merge commits declares that once,
3044 /// here, rather than magi asking GitHub about it on every render (see
3045 /// [`MergeStyle`]'s own doc for why).
3046 #[test]
3047 fn a_repository_can_declare_a_linear_history_merge_style() {
3048 let dir = tempfile::tempdir().unwrap();
3049 let path = dir.path().join("magi.toml");
3050 std::fs::write(&path, "[merge]\nmode = \"none\"\nstyle = \"squash\"\n").unwrap();
3051 let parsed = Config::load(&path).expect("config must load");
3052 assert_eq!(parsed.merge.style, MergeStyle::Squash);
3053 }
3054
3055 #[test]
3056 fn later_layers_win_and_vars_render() {
3057 let dir = tempfile::tempdir().unwrap();
3058 let machine = dir.path().join("machine.toml");
3059 let project = dir.path().join("magi.toml");
3060 // The machine layer owns the roster...
3061 std::fs::write(
3062 &machine,
3063 "[[agents]]\nid = \"opus\"\nkind = \"claude\"\nmodel = \"opus\"\n\n\
3064 [graph]\ncandidates = 3\nmax_parallel = 8\n",
3065 )
3066 .unwrap();
3067 // ...and the project layer only states what is repo-specific, plus a
3068 // `[vars]` value interpolated into a command.
3069 std::fs::write(
3070 &project,
3071 "[vars]\ncache = \"/shared\"\n\n\
3072 [graph]\ncandidates = 2\n\n\
3073 [verify]\ngate = [\"CARGO_TARGET_DIR={{ vars.cache }}/t cargo test\"]\n",
3074 )
3075 .unwrap();
3076
3077 let cfg = Config::load_layers(&[machine, project]).expect("layered load");
3078 assert_eq!(cfg.agents.len(), 1, "roster comes from the machine layer");
3079 assert_eq!(cfg.graph.implementers, 2, "project layer wins");
3080 assert_eq!(cfg.graph.max_parallel, 8, "machine layer survives");
3081 assert_eq!(
3082 cfg.verify.gate,
3083 ["CARGO_TARGET_DIR=/shared/t cargo test".to_owned()]
3084 );
3085 // The rendered command is where the cache path is read back from.
3086 assert_eq!(cfg.cache_dir(), Some(PathBuf::from("/shared/t")));
3087 }
3088
3089 #[test]
3090 fn talk_defaults_to_an_hour_and_an_unwritten_config_still_gets_it() {
3091 // An operator who writes no `[graph]` timeout keys at all must still
3092 // land on the hour, not on the five/fifteen minutes this turn used
3093 // to hardcode before it read from config.
3094 let g = Graph::default();
3095 assert_eq!(g.timeout_talk, 3600);
3096
3097 let dir = tempfile::tempdir().unwrap();
3098 let path = dir.path().join("magi.toml");
3099 std::fs::write(&path, "[graph]\ncandidates = 2\n").unwrap();
3100 let cfg = Config::load(&path).expect("must load without timeout_talk set");
3101 assert_eq!(cfg.graph.timeout_talk, 3600);
3102 }
3103
3104 #[test]
3105 fn an_overridden_talk_timeout_reaches_the_loaded_config() {
3106 let dir = tempfile::tempdir().unwrap();
3107 let path = dir.path().join("magi.toml");
3108 std::fs::write(&path, "[graph]\ntimeout_talk = 120\n").unwrap();
3109 let cfg = Config::load(&path).expect("must load");
3110 assert_eq!(cfg.graph.timeout_talk, 120);
3111 }
3112
3113 #[test]
3114 fn the_disk_defaults_are_the_measurements_made_up_front() {
3115 let cfg = Config::default();
3116 assert_eq!(cfg.disk.min_free_bytes, 8 * 1024 * 1024 * 1024);
3117 assert!(cfg.disk.auto_fold);
3118 assert_eq!(cfg.disk.fold_grace_secs, 6 * 60 * 60);
3119 assert_eq!(cfg.disk.cache_limit_bytes, 10 * 1024 * 1024 * 1024);
3120 }
3121
3122 #[test]
3123 fn an_unset_disk_section_is_the_safe_default() {
3124 let dir = tempfile::tempdir().unwrap();
3125 std::fs::write(dir.path().join("magi.toml"), "[graph]\ncandidates = 1\n").unwrap();
3126 let cfg = Config::load(&dir.path().join("magi.toml")).expect("load");
3127 assert_eq!(cfg.disk, Disk::default());
3128 }
3129
3130 #[test]
3131 fn env_is_available_to_templates_with_a_default() {
3132 let dir = tempfile::tempdir().unwrap();
3133 let path = dir.path().join("magi.toml");
3134 // teravars ships no `env`; magi adds it, and the `default` filter has
3135 // to cover the unset case or every machine would need the variable.
3136 //
3137 // Deliberately no named variable: `env` is keyed by the exact spelling
3138 // the OS reports, and Windows says `Path` where POSIX says `PATH`, so a
3139 // test asserting `env.PATH` passes on one runner and fails on another.
3140 // The map's non-emptiness is the platform-neutral claim.
3141 std::fs::write(
3142 &path,
3143 "[verify]\n\
3144 gate = [\"cache={{ env.MAGI_TEST_UNSET_XYZ | default(value='fallback') }}\", \
3145 \"populated={{ env | length > 0 }}\"]\n",
3146 )
3147 .unwrap();
3148 let cfg = Config::load(&path).expect("env lookup must render");
3149 assert_eq!(cfg.verify.gate[0], "cache=fallback");
3150 assert_eq!(cfg.verify.gate[1], "populated=true");
3151 }
3152
3153 #[test]
3154 fn a_broken_template_names_the_file() {
3155 let dir = tempfile::tempdir().unwrap();
3156 let path = dir.path().join("magi.toml");
3157 std::fs::write(&path, "[graph]\nlanguage = \"{{ nope.\"\n").unwrap();
3158 let err = Config::load(&path).expect_err("must not silently ignore");
3159 assert!(err.to_string().contains("teravars"), "{err}");
3160 }
3161
3162 #[test]
3163 fn tera_syntax_in_comments_is_inert() {
3164 // teravars >= 0.2.2 strips `#` comments before Tera sees the file, so a
3165 // comment may quote template syntax without rendering. Before 0.2.2 this
3166 // load failed: the commented-out braces reached the template parser.
3167 let dir = tempfile::tempdir().unwrap();
3168 let path = dir.path().join("magi.toml");
3169 std::fs::write(
3170 &path,
3171 "# a comment may quote templates: `{{ env.NOPE | default(value='x') }}` and `{% if %}`\n\
3172 [graph]\ncandidates = 2\n",
3173 )
3174 .unwrap();
3175 let cfg = Config::load(&path).expect("comments must be inert, not rendered");
3176 assert_eq!(cfg.graph.implementers, 2);
3177 }
3178
3179 #[test]
3180 fn opencode_defaults_to_file_delivery() {
3181 let mut s = spec("oc");
3182 s.kind = AgentKind::Opencode;
3183 assert_eq!(s.delivery(), Delivery::File);
3184 s.prompt_delivery = Some(Delivery::Argv);
3185 assert_eq!(s.delivery(), Delivery::Argv);
3186 }
3187 #[test]
3188 fn the_land_loop_is_on_but_it_cannot_merge_without_being_asked() {
3189 // Both default on, and that pair is the safety property: `land` takes
3190 // over the watching an operator was doing by hand, `land_approval`
3191 // keeps the irreversible step a human decision. An unattended merge
3192 // needs BOTH flipped, which has to be chosen deliberately twice.
3193 let g = Graph::default();
3194 assert!(
3195 g.land,
3196 "stopping at an open PR left the watching to a human"
3197 );
3198 assert!(
3199 g.land_approval,
3200 "on-by-default land is only defensible while this is also on"
3201 );
3202 assert!(g.land_rounds > 0, "a loop with no budget never terminates");
3203 assert!(
3204 g.hold_contested_merge,
3205 "a contested hand-off must still reach a human when approvals are off"
3206 );
3207 }
3208 #[test]
3209 fn an_array_declared_in_two_layers_is_refused_instead_of_concatenated() {
3210 // teravars appends arrays. For an ordered list of seats, or an argv,
3211 // the concatenation is something neither file says - and the operator
3212 // pays for the extra seats by the token.
3213 let dir = tempfile::tempdir().unwrap();
3214 let machine = dir.path().join("machine.toml");
3215 let repo = dir.path().join("magi.toml");
3216 std::fs::write(&machine, "[roles]\nimplementers = [\"a\", \"b\"]\n").unwrap();
3217 std::fs::write(&repo, "[roles]\nimplementers = [\"oc\"]\n").unwrap();
3218
3219 let err = Config::load_layers(&[machine.clone(), repo.clone()])
3220 .expect_err("two layers naming one array must not merge silently")
3221 .to_string();
3222 assert!(err.contains("roles.implementers"), "{err}");
3223 // Both files are named: the fix is to delete one of them, and the
3224 // operator has to know which two to choose between.
3225 assert!(err.contains("machine.toml"), "{err}");
3226 assert!(err.contains("magi.toml"), "{err}");
3227 }
3228
3229 #[test]
3230 fn a_scalar_in_one_layer_and_an_array_in_another_still_merges() {
3231 // The split the layering exists for: state a preference machine-wide,
3232 // let the repository own its own lists.
3233 let dir = tempfile::tempdir().unwrap();
3234 let machine = dir.path().join("machine.toml");
3235 let repo = dir.path().join("magi.toml");
3236 std::fs::write(&machine, "[roles]\nchatter = \"opus\"\n").unwrap();
3237 std::fs::write(
3238 &repo,
3239 "[[agents]]\nid = \"oc\"\nkind = \"opencode\"\n\n\
3240 [roles]\nimplementers = [\"oc\"]\n",
3241 )
3242 .unwrap();
3243
3244 let cfg = Config::load_layers(&[machine, repo]).expect("layers merge");
3245 assert_eq!(primary(cfg.roles.chatter.as_ref()), Some("opus"));
3246 assert_eq!(cfg.roles.implementers, ["oc"]);
3247 assert_eq!(cfg.agents.len(), 1, "the roster is not doubled");
3248 }
3249
3250 #[test]
3251 fn two_layers_declaring_verify_gate_run_both_in_priority_order() {
3252 // The `editorconfig-checker` distribution problem: a shared layer
3253 // wants to add a gate command without erasing the repository's own.
3254 let dir = tempfile::tempdir().unwrap();
3255 let machine = dir.path().join("machine.toml");
3256 let repo = dir.path().join("magi.toml");
3257 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
3258 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
3259
3260 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
3261 assert_eq!(
3262 cfg.verify.gate,
3263 [
3264 "editorconfig-checker".to_owned(),
3265 "cargo make check".to_owned()
3266 ],
3267 "low-priority (machine) command first, high-priority (repo) command after"
3268 );
3269 }
3270
3271 #[test]
3272 fn two_layers_declaring_verify_e2e_run_both_in_priority_order() {
3273 let dir = tempfile::tempdir().unwrap();
3274 let machine = dir.path().join("machine.toml");
3275 let repo = dir.path().join("magi.toml");
3276 std::fs::write(&machine, "[verify]\ne2e = [\"shared-smoke-test\"]\n").unwrap();
3277 std::fs::write(&repo, "[verify]\ne2e = [\"cargo test\"]\n").unwrap();
3278
3279 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
3280 assert_eq!(
3281 cfg.verify.e2e,
3282 ["shared-smoke-test".to_owned(), "cargo test".to_owned()]
3283 );
3284 }
3285
3286 #[test]
3287 fn two_layers_declaring_repos_roots_are_both_scanned() {
3288 let dir = tempfile::tempdir().unwrap();
3289 let machine = dir.path().join("machine.toml");
3290 let repo = dir.path().join("magi.toml");
3291 std::fs::write(&machine, "[repos]\nroots = [\"/machine/root\"]\n").unwrap();
3292 std::fs::write(&repo, "[repos]\nroots = [\"/repo/root\"]\n").unwrap();
3293
3294 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
3295 assert_eq!(
3296 cfg.repos.roots,
3297 [PathBuf::from("/machine/root"), PathBuf::from("/repo/root")]
3298 );
3299 }
3300
3301 #[test]
3302 fn duplicate_gate_commands_across_layers_both_run() {
3303 // Dropping the duplicate would be a silent surprise; the operator
3304 // sees a slower gate, never a missing one.
3305 let dir = tempfile::tempdir().unwrap();
3306 let machine = dir.path().join("machine.toml");
3307 let repo = dir.path().join("magi.toml");
3308 std::fs::write(&machine, "[verify]\ngate = [\"same-command\"]\n").unwrap();
3309 std::fs::write(&repo, "[verify]\ngate = [\"same-command\"]\n").unwrap();
3310
3311 let cfg = Config::load_layers(&[machine, repo]).expect("appendable arrays must merge");
3312 assert_eq!(
3313 cfg.verify.gate,
3314 ["same-command".to_owned(), "same-command".to_owned()]
3315 );
3316 }
3317
3318 #[test]
3319 fn notify_command_is_still_refused_across_two_layers() {
3320 // An argv, not a set: concatenating two of them is not a program.
3321 let dir = tempfile::tempdir().unwrap();
3322 let machine = dir.path().join("machine.toml");
3323 let repo = dir.path().join("magi.toml");
3324 std::fs::write(&machine, "[notify]\ncommand = [\"ntfy\", \"publish\"]\n").unwrap();
3325 std::fs::write(&repo, "[notify]\ncommand = [\"curl\", \"-X\"]\n").unwrap();
3326
3327 let err = Config::load_layers(&[machine.clone(), repo.clone()])
3328 .expect_err("an argv split across layers must not concatenate")
3329 .to_string();
3330 assert!(err.contains("notify.command"), "{err}");
3331 assert!(err.contains("machine.toml"), "{err}");
3332 assert!(err.contains("magi.toml"), "{err}");
3333 }
3334
3335 #[test]
3336 fn one_layer_declaring_verify_gate_runs_unchanged() {
3337 // The classification must not change behaviour for the configuration
3338 // this very repository has today: exactly one layer names the gate.
3339 let dir = tempfile::tempdir().unwrap();
3340 let path = dir.path().join("magi.toml");
3341 std::fs::write(&path, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
3342
3343 let cfg = Config::load(&path).expect("single layer must still load");
3344 assert_eq!(cfg.verify.gate, ["cargo make check".to_owned()]);
3345 }
3346
3347 #[test]
3348 fn describe_composed_names_the_contributing_layers_only_when_there_are_two() {
3349 let dir = tempfile::tempdir().unwrap();
3350 let machine = dir.path().join("machine.toml");
3351 let repo = dir.path().join("magi.toml");
3352 std::fs::write(&machine, "[verify]\ngate = [\"editorconfig-checker\"]\n").unwrap();
3353 std::fs::write(&repo, "[verify]\ngate = [\"cargo make check\"]\n").unwrap();
3354 let paths = vec![machine.clone(), repo.clone()];
3355
3356 let cfg = Config::load_layers(&paths).expect("appendable arrays must merge");
3357 let described =
3358 Config::describe_composed(&paths, &cfg.verify.gate, "verify.gate", "(none)");
3359 assert!(described.contains("editorconfig-checker && cargo make check"));
3360 assert!(
3361 described.contains(&machine.display().to_string()),
3362 "{described}"
3363 );
3364 assert!(
3365 described.contains(&repo.display().to_string()),
3366 "{described}"
3367 );
3368
3369 // A single contributing layer stays the plain one-line summary.
3370 let single = vec![repo.clone()];
3371 let solo_cfg = Config::load_layers(&single).expect("single layer loads");
3372 let solo_described =
3373 Config::describe_composed(&single, &solo_cfg.verify.gate, "verify.gate", "(none)");
3374 assert_eq!(solo_described, "cargo make check");
3375 }
3376
3377 mod remote_layers {
3378 use super::*;
3379
3380 fn git(dir: &Path, args: &[&str]) {
3381 use crate::proc::Quiet as _;
3382 let out = std::process::Command::new("git")
3383 .args(args)
3384 .quiet()
3385 .current_dir(dir)
3386 .output()
3387 .unwrap();
3388 assert!(out.status.success(), "git {args:?}: {out:?}");
3389 }
3390
3391 /// A checkout whose origin/main carries `remote` as magi.toml and whose
3392 /// working tree carries `disk`.
3393 fn fixture(remote: &str, disk: &str) -> (tempfile::TempDir, PathBuf) {
3394 let tmp = tempfile::tempdir().unwrap();
3395 let bare = tmp.path().join("o.git");
3396 git(tmp.path(), &["init", "--bare", "-b", "trunk", "o.git"]);
3397 let repo = tmp.path().join("repo");
3398 std::fs::create_dir_all(&repo).unwrap();
3399 git(&repo, &["init", "-b", "trunk"]);
3400 git(&repo, &["config", "user.name", "t"]);
3401 git(&repo, &["config", "user.email", "t@example.com"]);
3402 std::fs::write(repo.join("magi.toml"), remote).unwrap();
3403 git(&repo, &["add", "-A"]);
3404 git(&repo, &["commit", "-m", "x"]);
3405 git(&repo, &["remote", "add", "origin", &bare.to_string_lossy()]);
3406 git(&repo, &["push", "origin", "trunk"]);
3407 git(&repo, &["fetch", "origin"]);
3408 git(&repo, &["remote", "set-head", "origin", "trunk"]);
3409 std::fs::write(repo.join("magi.toml"), disk).unwrap();
3410 (tmp, repo)
3411 }
3412
3413 #[test]
3414 fn reads_the_remote_blob_not_the_working_tree() {
3415 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "[graph]\ncandidates = 5\n");
3416 let (cfg, _) = Config::discover(&repo, None).unwrap();
3417 assert_eq!(cfg.graph.implementers, 2);
3418 }
3419
3420 #[test]
3421 fn detached_head_still_reads_the_remote() {
3422 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "[graph]\ncandidates = 5\n");
3423 git(&repo, &["checkout", "--detach"]);
3424 let (cfg, _) = Config::discover(&repo, None).unwrap();
3425 assert_eq!(cfg.graph.implementers, 2);
3426 }
3427
3428 #[test]
3429 fn a_missing_ref_is_an_error_not_a_fallback() {
3430 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "[graph]\ncandidates = 5\n");
3431 git(&repo, &["update-ref", "-d", "refs/remotes/origin/trunk"]);
3432 let err = format!("{:#}", Config::discover(&repo, None).unwrap_err());
3433 assert!(err.contains("origin"), "{err}");
3434 }
3435
3436 #[test]
3437 fn merge_base_in_the_checkout_locates_the_ref() {
3438 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "[merge]\nbase = \"nope\"\n");
3439 assert!(Config::discover(&repo, None).is_err());
3440 }
3441
3442 #[test]
3443 fn the_magi_dir_layer_is_read_too() {
3444 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "");
3445 std::fs::write(repo.join("magi.toml"), "[graph]\ncandidates = 2\n").unwrap();
3446 std::fs::create_dir_all(repo.join(".magi")).unwrap();
3447 std::fs::write(repo.join(".magi/config.toml"), "[graph]\njudges = 3\n").unwrap();
3448 git(&repo, &["add", "-A"]);
3449 git(&repo, &["commit", "-m", "y"]);
3450 git(&repo, &["push", "origin", "trunk"]);
3451 git(&repo, &["fetch", "origin"]);
3452 let (cfg, layers) = Config::discover(&repo, None).unwrap();
3453 assert_eq!((cfg.graph.implementers, cfg.graph.judges), (2, 3));
3454 assert_eq!(layers.len(), 2);
3455 }
3456
3457 #[test]
3458 fn an_include_in_a_repository_layer_resolves_against_the_same_commit() {
3459 let (_t, repo) = fixture("include = [\"gate.toml\"]\n", "");
3460 std::fs::write(repo.join("magi.toml"), "include = [\"gate.toml\"]\n").unwrap();
3461 std::fs::write(repo.join("gate.toml"), "[graph]\ncandidates = 2\n").unwrap();
3462 git(&repo, &["add", "-A"]);
3463 git(&repo, &["commit", "-m", "inc"]);
3464 git(&repo, &["push", "origin", "trunk"]);
3465 git(&repo, &["fetch", "origin"]);
3466 // The working tree's copy differs and must not be used.
3467 std::fs::write(repo.join("gate.toml"), "[graph]\ncandidates = 9\n").unwrap();
3468 let (cfg, _) = Config::discover(&repo, None).unwrap();
3469 assert_eq!(cfg.graph.implementers, 2);
3470 }
3471
3472 #[test]
3473 fn a_machine_layer_base_is_rendered_before_locating_the_ref() {
3474 let (t, repo) = fixture("[graph]\ncandidates = 2\n", "[merge]\nbase = \"nope\"\n");
3475 let m = t.path().join("machine.toml");
3476 std::fs::write(
3477 &m,
3478 "[merge]\nbase = \"{{ env.MAGI_TEST_NO_SUCH | default(value='trunk') }}\"\n",
3479 )
3480 .unwrap();
3481 let (remote, base) = {
3482 let probe = probe_merge(&m, &repo).unwrap();
3483 (probe.remote, probe.base)
3484 };
3485 assert_eq!((remote, base), (None, Some("trunk".to_owned())));
3486 }
3487
3488 #[test]
3489 fn a_machine_layer_base_sees_the_checkouts_repo_name() {
3490 let (t, repo) = fixture("[graph]\ncandidates = 2\n", "");
3491 let m = t.path().join("machine.toml");
3492 std::fs::write(&m, "[merge]\nbase = \"{{ repo_name }}\"\n").unwrap();
3493 let probe = probe_merge(&m, &repo).unwrap();
3494 assert_eq!(probe.base.as_deref(), Some("repo"));
3495 }
3496
3497 #[test]
3498 fn every_include_form_is_recognised() {
3499 assert!(declares_include("include = [\"a.toml\"]\n"));
3500 assert!(declares_include("\"include\" = [\"a.toml\"]\n"));
3501 assert!(declares_include("teravars = { include = [\"a.toml\"] }\n"));
3502 assert!(declares_include("[teravars]\ninclude = [\"a.toml\"]\n"));
3503 assert!(!declares_include("[graph]\ncandidates = 2\n"));
3504 }
3505
3506 #[test]
3507 fn an_explicit_config_is_read_as_named() {
3508 let (t, repo) = fixture("[graph]\ncandidates = 2\n", "");
3509 let own = t.path().join("own.toml");
3510 std::fs::write(&own, "[graph]\ncandidates = 4\n").unwrap();
3511 let (cfg, _) = Config::discover(&repo, Some(&own)).unwrap();
3512 assert_eq!(cfg.graph.implementers, 4);
3513 }
3514
3515 #[test]
3516 fn discover_fetched_fails_when_the_fetch_does() {
3517 let (t, repo) = fixture("[graph]\ncandidates = 2\n", "");
3518 std::fs::remove_dir_all(t.path().join("o.git")).unwrap();
3519 let rt = tokio::runtime::Builder::new_current_thread()
3520 .enable_all()
3521 .build()
3522 .unwrap();
3523 let err = rt
3524 .block_on(Config::discover_fetched(&repo, None))
3525 .unwrap_err();
3526 assert!(format!("{err:#}").contains("fetch"), "{err:#}");
3527 }
3528
3529 #[test]
3530 fn discover_fetched_survives_a_fetch_that_leaves_no_origin_head() {
3531 // Never-fetched remote + followRemoteHEAD=never: fetch creates
3532 // origin/trunk but not origin/HEAD, which discovery then re-reads.
3533 let (_t, repo) = fixture("[graph]\ncandidates = 2\n", "");
3534 git(&repo, &["remote", "set-head", "origin", "-d"]);
3535 git(&repo, &["update-ref", "-d", "refs/remotes/origin/trunk"]);
3536 git(
3537 &repo,
3538 &["config", "remote.origin.followRemoteHEAD", "never"],
3539 );
3540 let rt = tokio::runtime::Builder::new_current_thread()
3541 .enable_all()
3542 .build()
3543 .unwrap();
3544 let (cfg, _) = rt.block_on(Config::discover_fetched(&repo, None)).unwrap();
3545 assert_eq!(cfg.graph.implementers, 2);
3546 }
3547
3548 #[test]
3549 fn a_non_git_directory_reads_its_files() {
3550 let dir = tempfile::tempdir().unwrap();
3551 std::fs::write(dir.path().join("magi.toml"), "[graph]\ncandidates = 4\n").unwrap();
3552 let (cfg, _) = Config::discover(dir.path(), None).unwrap();
3553 assert_eq!(cfg.graph.implementers, 4);
3554 }
3555 }
3556}