amont_runtime/dispatch.rs
1//! The two dispatchers.
2//!
3//! They are NOT the same shape, and both shapes are load-bearing:
4//!
5//! - `pre-commit` runs its checks CONCURRENTLY and reports EVERY failure.
6//! Serial would be a visible slowdown on each commit; stopping at the first
7//! failure would hide the rest, so you'd fix one lint error, commit, and
8//! immediately meet the next.
9//! - `pre-push` runs them SERIALLY and stops at the FIRST failure, naming just
10//! that check. The steps are ordered and expensive (protected branch, then
11//! branch name, then rebase, then the whole test suite) and there is no point
12//! running tests after a rebase conflict.
13//!
14//! Resist the tempting shared `run_all` helper — collapsing these is the
15//! obvious way to silently lose the distinction. `tests/dispatchers.rs` pins
16//! both.
17//!
18//! Checks are FUNCTIONS in this binary, called directly. They used to be files:
19//! `.git/hooks/pre-commit-*`, each an identical `sh` shim whose only job was to
20//! re-exec this same binary and tell it its own name. One commit therefore cost
21//! 27 processes — a shim, the binary, then 13 more shims and 13 more binaries —
22//! to do work the binary already had in a table.
23//!
24//! Deleting that removed the filename glob (order was lexicographic, so a
25//! rename could silently reorder a gate), the shebang emulation Windows needed
26//! because it cannot execute a `#!` script, and the spawn plumbing under both.
27//! Order is now a declared list in `registry`.
28
29use std::sync::Mutex;
30
31use crate::check::{Check, Outcome, Severity, Stage, Verdict};
32use crate::configured_skips;
33use crate::registry::{all_stage_checks, Ctx, Overrides};
34use crate::ui::{highlight, valid_sign, warning_sign};
35
36/// The checks for a stage, minus anything `hook.skip` filters out. Resolution
37/// goes through `names_check`, the one rule this and the severity lookup share:
38/// `git config hook.skip ruff` skips `pre-commit-ruff` by short name.
39fn selected(stage: Stage, manifest: &crate::manifest::Manifest) -> Vec<&dyn Check> {
40 selected_during(stage, &[], manifest)
41}
42
43/// Do this repository's hooks apply the CONVENTIONS, or only the safety net?
44///
45/// `git config amont.conventions declared` (usually `--global`, set by
46/// `amont enroll`) scopes the house rules to repositories that commit an
47/// `amont.conf` — the standing grant of `init.templateDir` then becomes safe
48/// to hand a whole team: a clone of somebody else's project gets conflict,
49/// secret, size and debug-leftover protection, and none of this team's
50/// opinions about commit subjects or branch names. The default,
51/// `everywhere`, keeps today's behaviour exactly.
52///
53/// Presence of the manifest is the declaration; its CONTENT stays
54/// trust-gated. Reading presence executes nothing, so no consent is needed.
55pub fn conventions_apply(manifest: &crate::manifest::Manifest) -> bool {
56 manifest.declared || !declared_mode()
57}
58
59/// One config read per process — this sits on the hook path of every commit.
60fn declared_mode() -> bool {
61 static MODE: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
62 *MODE.get_or_init(|| {
63 crate::config::enumerated_or(
64 "amont.conventions",
65 &["everywhere", "declared"],
66 "everywhere",
67 ) == "declared"
68 })
69}
70
71/// The checks for a stage, minus `hook.skip` and minus anything that declares
72/// it does not run during an operation currently in progress.
73fn selected_during<'a>(
74 stage: Stage,
75 in_progress: &[crate::check::GitState],
76 manifest: &'a crate::manifest::Manifest,
77) -> Vec<&'a dyn Check> {
78 let skips = configured_skips();
79 // Externals are included here, so `hook.skip` and the severity override
80 // govern a declared command exactly as they govern a built-in. A repository
81 // that can add a check it cannot disable would be a worse deal than not
82 // being able to add one.
83 let (kept, dropped): (Vec<_>, Vec<_>) = all_stage_checks(stage, manifest)
84 .into_iter()
85 .partition(|c| !skips.iter().any(|s| crate::skip_suppresses(c.name(), s)));
86 let names: Vec<&str> = dropped.iter().map(|c| c.name()).collect();
87 announce_skips(&names);
88
89 // Announced separately from `hook.skip`, and with the operation named: "not
90 // during a rebase" is a property of the moment and will be true again in a
91 // minute, which is a different thing to tell a reader than "you disabled
92 // this".
93 let (kept, paused): (Vec<_>, Vec<_>) = kept.into_iter().partition(|check| {
94 !check
95 .scope()
96 .not_during
97 .iter()
98 .any(|state| in_progress.contains(state))
99 });
100 if !paused.is_empty() {
101 let what = in_progress
102 .iter()
103 .map(|s| s.as_str())
104 .collect::<Vec<_>>()
105 .join(" and ");
106 println!(
107 "{} {} check(s) paused during {what}: {}",
108 warning_sign(),
109 paused.len(),
110 paused
111 .iter()
112 .map(|c| c.name())
113 .collect::<Vec<_>>()
114 .join(", ")
115 );
116 }
117
118 // The conventions split, last: a held-back check was neither skipped (a
119 // choice about THIS repository) nor paused (a property of the moment) —
120 // this repository simply never subscribed. One line, count not names:
121 // in the clone-of-somebody-else's-project case this prints on every
122 // commit, and fifteen names every time is how a safety message becomes
123 // scroll-past noise.
124 if conventions_apply(manifest) {
125 return kept;
126 }
127 let (kept, held): (Vec<_>, Vec<_>) = kept
128 .into_iter()
129 .partition(|check| check.reach() == crate::check::Reach::Safety);
130 if !held.is_empty() {
131 println!(
132 "{} {} convention check(s) held back — no amont.conf here and \
133 amont.conventions is `declared`; the safety net still runs",
134 warning_sign(),
135 held.len(),
136 );
137 }
138 kept
139}
140
141/// Say out loud which checks did not run.
142///
143/// A skip is otherwise invisible at exactly the moment it matters. With
144/// `hook.skip = merge-conflict` set, a commit printed six green ticks and no
145/// hint that a seventh check had been disabled — the developer sees a clean run
146/// and concludes they are covered.
147///
148/// It is worse than it sounds, because one value can silence a whole stage:
149/// `hook.skip = pre-commit` suppresses all fifteen. That is now something
150/// somebody meant rather than the accident it once was — `e` used to cost
151/// twenty by substring reach — but a commit under it still looks exactly like a
152/// commit that had nothing to report.
153///
154/// One line, only when something was actually skipped, so a normal commit is
155/// unchanged. This reaches every skip however it was created — hand-edited
156/// config included — which no dashboard can claim.
157fn announce_skips(dropped: &[&str]) {
158 if dropped.is_empty() {
159 return;
160 }
161 // Two lines, not one: "you decided this" (hook.skip on this machine)
162 // and "your team decided this" (a skip line in the committed
163 // amont.conf) are different things to be told — the same reason paused
164 // and held-back get their own sentences. A name both sources suppress
165 // is announced as the machine's: the local decision is the nearer one.
166 let (machine, _policy) = crate::skips_by_source();
167 let (yours, theirs): (Vec<&&str>, Vec<&&str>) = dropped
168 .iter()
169 .partition(|name| machine.iter().any(|s| crate::skip_suppresses(name, s)));
170 let say = |names: &[&&str], via: &str| {
171 if names.is_empty() {
172 return;
173 }
174 let plural = if names.len() == 1 { "check" } else { "checks" };
175 println!(
176 "{} {} {plural} skipped by {}: {}",
177 warning_sign(),
178 names.len(),
179 highlight(via),
180 names.iter().map(|n| **n).collect::<Vec<_>>().join(", ")
181 );
182 };
183 say(&yours, "hook.skip");
184 say(&theirs, "amont.conf");
185}
186
187/// Say, once per stage, what the manifest's policy could not do — withheld
188/// behind trust, or aiming at names that exist nowhere. Policy that silently
189/// does not apply is a silent behaviour change, which is the one kind this
190/// codebase does not allow itself.
191fn announce_policy_state(manifest: &crate::manifest::Manifest) {
192 if let Some(why) = manifest.policy_withheld {
193 println!(
194 "{} {} policy not applied: {why}",
195 warning_sign(),
196 highlight(crate::manifest::MANIFEST),
197 );
198 }
199 for note in &manifest.policy_notes {
200 println!("{} {}", warning_sign(), note);
201 }
202 // The version floor rides the same two call sites: once per stage,
203 // beside the other "this repository expects something you lack" lines.
204 crate::skew::announce_minimum();
205}
206
207/// Run every item concurrently and collect `(name, code)` in the INPUT order.
208///
209/// Extracted so the concurrency itself can be tested with a rendezvous instead
210/// of a stopwatch — an earlier wall-clock test was flaky the moment the machine
211/// was busy, and a threshold that trips under load teaches you to ignore it.
212fn run_concurrently<T, R, F>(items: &[T], run: F, if_thread_died: R) -> Vec<R>
213where
214 T: Sync,
215 R: Send + Sync + Clone,
216 F: Fn(&T) -> R + Sync,
217{
218 let slots: Vec<Mutex<Option<R>>> = items.iter().map(|_| Mutex::new(None)).collect();
219 std::thread::scope(|scope| {
220 for (item, slot) in items.iter().zip(&slots) {
221 let run = &run;
222 let died = &if_thread_died;
223 scope.spawn(move || {
224 // CAUGHT, not propagated. `thread::scope` re-raises a child
225 // panic in the parent, which would abort the whole hook with a
226 // backtrace and throw away the other nineteen checks' results —
227 // and would make `if_thread_died` unreachable, which is what it
228 // was until this test existed to notice.
229 let outcome = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| run(item)))
230 .unwrap_or_else(|_| died.clone());
231 *slot.lock().expect("poisoned") = Some(outcome);
232 });
233 }
234 });
235 slots
236 .into_iter()
237 .map(|s| {
238 s.into_inner()
239 .expect("poisoned")
240 .unwrap_or_else(|| if_thread_died.clone())
241 })
242 .collect()
243}
244
245/// Take the index-fidelity hold, or say why the caller must stop.
246///
247/// Extracted from `pre_commit` so that `amont run` — which its own doc
248/// comment calls "a rehearsal of the hook" — can take exactly the same hold
249/// rather than judging the working tree while a real commit judges the index.
250///
251/// Around the WHOLE fan-out, not per check: twenty checks run concurrently and
252/// would fight over one working tree.
253fn hold_unstaged() -> Result<crate::staged_only::StagedOnly, Verdict> {
254 // BEFORE `enter()`, not after: `enter()` is what checks out the tree and
255 // parks the unstaged half, and a signal landing in the gap between that
256 // and the handler being armed would hit the default disposition — dead
257 // process, tree left checked out, nothing restored. The handler no-ops
258 // harmlessly on a signal that arrives before there is anything held.
259 crate::staged_only::install_signal_handler();
260 match crate::staged_only::StagedOnly::enter() {
261 Ok(guard) => Ok(guard),
262 Err(e) => {
263 // Refusing to check the wrong content is the safe direction; a
264 // check that read the tree would be answering about a commit
265 // nobody is making.
266 eprintln!("{e}");
267 Err(Verdict::Block)
268 }
269 }
270}
271
272pub fn pre_commit(ctx: &Ctx) -> Verdict {
273 // Before anything runs: a pinned tool at the wrong version makes every
274 // verdict below it suspect, and the warning costs one --version per pin.
275 crate::manifest::verify_tool_pins(&ctx.manifest.pins);
276 announce_policy_state(ctx.manifest);
277 let in_progress = crate::git_states_in_progress();
278 let checks = selected_during(Stage::PreCommit, &in_progress, ctx.manifest);
279
280 let held = match hold_unstaged() {
281 Ok(guard) => guard,
282 Err(verdict) => return verdict,
283 };
284
285 let severities = Overrides::read();
286 let (verdict, outcomes) = run_stage_traced(&checks, ctx, &severities);
287
288 // The shadow-mode ledger. Silent, best-effort, and never consulted by any
289 // verdict — see `crate::downgrade`.
290 crate::downgrade::note(&downgraded_events(&checks, &outcomes, &severities));
291
292 // What post-commit will bind to the commit: the gate-declared checks
293 // that RAN clean, recorded while the index still is the commit's tree.
294 // Called on every verdict — an empty record clears any leftover marker,
295 // so a blocked attempt (or a repo with nothing declared) cannot leave an
296 // earlier attempt's marker to vouch for the next commit. `Unavailable`
297 // deliberately does not qualify: a check whose tool is missing judged
298 // nothing, and stamping it would be the paper promise this exists to
299 // replace.
300 // EVERY blocking declaration, not only the npm GATE names: a custom
301 // `pre-commit check … block …` earns its stamp the same way, and a
302 // same-named pre-push declaration defers to it (see `pair_verdict`).
303 let ran: Vec<String> = if matches!(verdict, Verdict::Block) {
304 Vec::new()
305 } else {
306 crate::hooks::run_tests::blocking_commit_decls(&ctx.manifest.externals)
307 .into_iter()
308 .filter(|d| {
309 checks
310 .iter()
311 .zip(&outcomes)
312 .any(|(c, o)| c.name() == d.id && matches!(o, Outcome::Passed | Outcome::Fixed))
313 })
314 .map(|d| d.script)
315 .collect()
316 };
317 let ran: Vec<&str> = ran.iter().map(String::as_str).collect();
318 crate::gate_stamp::record(&ran);
319
320 drop(held);
321 verdict
322}
323
324/// The checks that FAILED without blocking, each with why — the shadow-mode
325/// signal [`crate::downgrade`] keeps.
326///
327/// Derived at the hook entry points and deliberately NOT inside
328/// [`run_stage_traced`], which is where `classify` already computes the same
329/// set. `run_all` reaches that function too, so recording there would let
330/// every `amont run` rehearsal inflate a ledger a lead is going to read as a
331/// count of real commits — and `run --all-files` over a dirty tree would add
332/// dozens of events for content nobody is committing.
333///
334/// A check that DECLARES `warn` is counted but is not evidence about a
335/// rollout: it was never going to block, so calling it "would have blocked"
336/// would inflate the one number the whole feature exists to produce. Only an
337/// override of a blocking check earns that.
338fn downgraded_events(
339 checks: &[&dyn Check],
340 outcomes: &[Outcome],
341 severities: &Overrides,
342) -> Vec<(String, crate::downgrade::Origin)> {
343 checks
344 .iter()
345 .zip(outcomes)
346 .filter(|(_, o)| matches!(o, Outcome::Failed))
347 .filter(|(c, _)| matches!(severities.of(**c), Severity::Warn))
348 .map(|(c, _)| (c.name().to_string(), downgrade_origin(*c, severities)))
349 .collect()
350}
351
352/// Why this check did not block. Shared, because `pre_push` fail-fasts and
353/// never builds an outcomes vector to hand to [`downgraded_events`].
354fn downgrade_origin(check: &dyn Check, severities: &Overrides) -> crate::downgrade::Origin {
355 use crate::downgrade::Origin;
356 use crate::registry::Source;
357 if matches!(check.severity(), Severity::Warn) {
358 return Origin::Declared;
359 }
360 match severities.applied_with_source(check.name()) {
361 Some((_, _, Source::Config)) => Origin::Config,
362 Some((_, _, Source::Policy)) => Origin::Policy,
363 // Declared `block`, resolved `warn`, and nothing claims to have
364 // overridden it: a contradiction. Count it, but not as evidence — the
365 // conservative direction for a number whose only failure mode is
366 // being too alarming.
367 None => Origin::Declared,
368 }
369}
370
371/// The pre-commit body, over the checks it is GIVEN.
372///
373/// A seam, so a test can hand it a check that panics. Without it the value
374/// standing in for a dead check was a literal at one call site that no test
375/// could reach — the rule was asserted on the runner and merely hoped for here.
376fn run_stage(checks: &[&dyn Check], ctx: &Ctx, severities: &Overrides) -> Verdict {
377 run_stage_traced(checks, ctx, severities).0
378}
379
380/// [`run_stage`], keeping the per-check outcomes — index-aligned with
381/// `checks` — alive past the verdict. `pre_commit` needs them to know which
382/// gate-declared checks actually ran (`gate_stamp`); `Report` cannot answer
383/// that, because `classify` deliberately drops the names of `Passed`.
384fn run_stage_traced(
385 checks: &[&dyn Check],
386 ctx: &Ctx,
387 severities: &Overrides,
388) -> (Verdict, Vec<Outcome>) {
389 if checks.is_empty() {
390 return (Verdict::Proceed, Vec::new());
391 }
392 // One slot per check: everything a check says lands in its own buffer
393 // and reaches stdout as ONE block when it finishes — see `live`. Off
394 // (`amont.progress false`), no sink is ever installed and every print
395 // streams exactly as it always did.
396 let stage = crate::live::enabled().then(|| {
397 let names: Vec<&str> = checks.iter().map(|c| c.name()).collect();
398 crate::live::Stage::begin(&names)
399 });
400 let items: Vec<(usize, &&dyn Check)> = checks.iter().enumerate().collect();
401 let outcomes = run_concurrently(
402 &items,
403 |(idx, check)| {
404 let _sink = stage.as_ref().map(|s| s.enter(*idx));
405 // The block is emitted however the check leaves — a panicking
406 // check's partial output still reaches the reader, above the
407 // dead-check verdict `run_concurrently` fills in.
408 let _flush = stage
409 .as_ref()
410 .map(|s| crate::live::FinishOnDrop::new(s, *idx));
411 let sub = Ctx {
412 name: check.name(),
413 args: ctx.args,
414 hooks_dir: ctx.hooks_dir,
415 push: ctx.push,
416 manifest: ctx.manifest,
417 };
418 check.run(&sub)
419 },
420 // A check whose thread died has not passed. Stated here, where the slot
421 // is filled, rather than hidden in a `Default` impl that every future
422 // `#[derive(Default)]` would silently inherit.
423 Outcome::Failed,
424 );
425
426 let report = classify(checks, &outcomes, severities);
427 announce(&report);
428 (report.verdict(), outcomes)
429}
430
431/// What a stage concluded, before anything is printed or exited.
432///
433/// A VALUE, so the classification can be asserted directly. While this was one
434/// function that classified, printed and returned an exit code, its tests could
435/// only check the code — whether the right thing was SAID went untested.
436#[derive(Debug, Default, PartialEq, Eq)]
437struct Report<'a> {
438 /// Repaired. The commit proceeds, but the author's files changed under
439 /// them and that must be said out loud.
440 fixed: Vec<&'a str>,
441 /// Failed, and the severity that applies blocks.
442 blocked: Vec<&'a str>,
443 /// Failed, but configured to warn. The check printed an error and meant it,
444 /// so somebody has to say it did not block.
445 downgraded: Vec<&'a str>,
446 /// Could not run. Distinct from "passed", which is the whole point.
447 unavailable: Vec<&'a str>,
448}
449
450impl Report<'_> {
451 fn verdict(&self) -> Verdict {
452 Verdict::blocking(!self.blocked.is_empty())
453 }
454}
455
456/// Pure: outcomes and severities in, a verdict out. No IO.
457fn classify<'a>(
458 checks: &[&'a dyn Check],
459 outcomes: &[Outcome],
460 severities: &Overrides,
461) -> Report<'a> {
462 let mut report = Report::default();
463 for (check, outcome) in checks.iter().zip(outcomes) {
464 match outcome {
465 // `Warned` needs nothing: a check that chose to warn has already
466 // said what it wanted to, and a roll-up would only repeat it.
467 Outcome::Passed | Outcome::Warned => {}
468 Outcome::Fixed => report.fixed.push(check.name()),
469 Outcome::Unavailable => report.unavailable.push(check.name()),
470 Outcome::Failed => match severities.of(*check) {
471 Severity::Block => report.blocked.push(check.name()),
472 Severity::Warn => report.downgraded.push(check.name()),
473 },
474 }
475 }
476 report
477}
478
479/// Says what happened. Prints; decides nothing.
480fn announce(report: &Report) {
481 if !report.fixed.is_empty() {
482 // Louder than a pass, because files on disk are not what the author
483 // left them: they asked for the repair, but they did not watch it.
484 println!(
485 "{} {} check(s) fixed and re-staged: {}",
486 valid_sign(),
487 report.fixed.len(),
488 report.fixed.join(", ")
489 );
490 }
491 if !report.unavailable.is_empty() {
492 // Distinct from "passed". Silence here is how a repo looks verified
493 // when nothing actually ran — the trailing count is the one line
494 // guaranteed to be read, whatever the twenty blocks above said.
495 println!(
496 "{} {} check(s) could not run: {}",
497 warning_sign(),
498 report.unavailable.len(),
499 report.unavailable.join(", ")
500 );
501 }
502 if !report.downgraded.is_empty() {
503 println!(
504 "{} {} check(s) reported a problem but are set to warn: {}",
505 warning_sign(),
506 report.downgraded.len(),
507 report.downgraded.join(", ")
508 );
509 }
510 if report.blocked.is_empty() {
511 return;
512 }
513 println!("\n🚨 Error raised by:");
514 for name in &report.blocked {
515 println!(" - {}", highlight(name));
516 }
517}
518
519/// Point every check at `git ls-files` instead of the index.
520///
521/// THE definition, called from both entry points. There used to be two: this
522/// one, and a copy in `main.rs` built from a RAW `ls-files` — no `-z` — whose
523/// output git QUOTES for any unusual byte, so `é.json` arrived as the nine-byte
524/// literal `"\303\251.json"` and was handed to prettier and eslint as a path
525/// that does not exist. And because `override_file_set` writes a `OnceLock`,
526/// main's quoted list WON: whichever ran first was the one that counted, and
527/// main's ran first. `git.rs` documents this exact failure.
528pub fn enter_all_files_mode() {
529 crate::hooks::common::override_file_set(
530 crate::git::stdout_paths(&["ls-files"]).unwrap_or_default(),
531 );
532}
533
534/// `amont run` — every applicable check, on demand.
535///
536/// Two questions, and the mode says which it answers:
537///
538/// - **staged** (default) is "would my commit pass" — the same set a commit
539/// would check, so it is a rehearsal of the hook, and it takes the same
540/// index-fidelity hold the hook takes.
541/// - **`--all-files`** is "does my working tree pass". Deliberately NOT the same
542/// question: on a dirty tree it reports on content that is not committed and
543/// may never be. That is right for adopting a check into an existing
544/// repository, where `git add .` is not an acceptable way to measure the mess,
545/// and it is why `--all-files` takes no stash — there is no staged/unstaged
546/// distinction to protect when the answer is "all of it".
547pub fn run_all(ctx: &Ctx, all_files: bool) -> Verdict {
548 // ORDER: the override goes in FIRST. It is what tells `fixing_enabled` and
549 // `restage` that the file set is not the index, and both are consulted
550 // from inside the checks below.
551 if all_files {
552 enter_all_files_mode();
553 if crate::hooks::common::fixing_requested() {
554 println!(
555 "{} {} is set, but fixing is off for {}: the input set is the \
556 working tree, not the index",
557 warning_sign(),
558 highlight("amont.fix"),
559 highlight("--all-files")
560 );
561 }
562 // Stash-free, per decision 1 of docs/index-fidelity-and-run-modes.md:
563 // there is no staged/unstaged distinction to protect when the input
564 // set is `git ls-files`, so a hold would be surprising extra mutation
565 // with no correctness upside.
566 return run_stage(
567 &selected(Stage::PreCommit, ctx.manifest),
568 ctx,
569 &Overrides::read(),
570 );
571 }
572
573 // Staged mode IS a rehearsal of the commit, so it takes the same hold the
574 // commit does. Without it, `amont run` failed on garbage in the tree
575 // that `git commit` — which holds the unstaged half aside — passed, and
576 // vice versa: the two modes disagreed about the same repository, which is
577 // exactly what this mode exists not to do.
578 let held = match hold_unstaged() {
579 Ok(guard) => guard,
580 Err(verdict) => return verdict,
581 };
582 let verdict = run_stage(
583 &selected(Stage::PreCommit, ctx.manifest),
584 ctx,
585 &Overrides::read(),
586 );
587 // AFTER the report has been printed: dropping earlier would put the
588 // unstaged content back under a check that is still reading files.
589 drop(held);
590 verdict
591}
592
593/// `amont run <check>` — one check by name. `None` when there is no such
594/// check, which the caller turns into a usage error.
595///
596/// Lives here rather than in `main.rs` so `registry::lookup` stays inside the
597/// runtime, and so the hold decision is made once: a named check takes the
598/// index-fidelity hold only when it is a `Stage::PreCommit` check running in
599/// staged mode. A pre-push or commit-msg check invoked by name must never
600/// touch the working tree — nothing about a push is a staging operation.
601/// Resolve what `amont run <name>` means, exactly as `hook.skip` resolves a
602/// name — the rest of the tool taught `ban-terms`; making `run` demand the
603/// full id was a pointless second vocabulary. Ambiguity is an answer, not a
604/// guess: the two `branch-pattern` checks are different code at different
605/// stages.
606///
607/// Public because the CALLER needs the answer before anything else happens:
608/// main decides whether to synthesize push refs from the resolved name, and
609/// an ambiguous name must say so rather than fail on a missing upstream it
610/// was never going to use.
611pub fn resolve_check_name(name: &str, manifest: &crate::manifest::Manifest) -> Named2 {
612 if crate::registry::lookup(name, manifest).is_some() {
613 return Named2::Resolved(name.to_string());
614 }
615 let mut matches: Vec<String> = crate::registry::CHECKS
616 .iter()
617 .map(|c| c.name.to_string())
618 .chain(manifest.externals.iter().map(|e| e.id.clone()))
619 .filter(|id| crate::skip_suppresses(id, name))
620 .collect();
621 matches.dedup();
622 match matches.len() {
623 0 => Named2::Unknown,
624 1 => Named2::Resolved(matches.remove(0)),
625 _ => Named2::Ambiguous(matches),
626 }
627}
628
629/// How a run name resolved.
630pub enum Named2 {
631 Resolved(String),
632 Unknown,
633 Ambiguous(Vec<String>),
634}
635
636pub fn run_named(ctx: &Ctx, name: &str, all_files: bool) -> Named {
637 let full: String = match resolve_check_name(name, ctx.manifest) {
638 Named2::Resolved(id) => id,
639 Named2::Unknown => return Named::Unknown,
640 Named2::Ambiguous(ids) => return Named::Ambiguous(ids),
641 };
642 let name = full.as_str();
643 let Some(run_check) = crate::registry::lookup(name, ctx.manifest) else {
644 return Named::Unknown;
645 };
646 // The Ctx must carry the RESOLVED id: lookup's closure re-resolves
647 // through `ctx.name`, and handing it the short name back would panic on
648 // the very ambiguity this function just settled.
649 let ctx = &Ctx {
650 name,
651 args: ctx.args,
652 hooks_dir: ctx.hooks_dir,
653 push: ctx.push,
654 manifest: ctx.manifest,
655 };
656 if all_files {
657 enter_all_files_mode();
658 return Named::Ran(run_check(ctx));
659 }
660 let is_pre_commit_check = crate::registry::one_named(name, ctx.manifest)
661 .is_some_and(|c| c.stage() == Stage::PreCommit);
662 if !is_pre_commit_check {
663 return Named::Ran(run_check(ctx));
664 }
665 let held = match hold_unstaged() {
666 Ok(guard) => guard,
667 Err(verdict) => return Named::Ran(verdict),
668 };
669 let verdict = run_check(ctx);
670 drop(held);
671 Named::Ran(verdict)
672}
673
674/// What `run_named` resolved a name to.
675pub enum Named {
676 Ran(Verdict),
677 /// Nothing matches — full id, short name, or entrypoint.
678 Unknown,
679 /// A short name that reaches more than one check; the caller lists them
680 /// so the user can pick a full id.
681 Ambiguous(Vec<String>),
682}
683
684pub fn pre_push(ctx: &Ctx) -> Verdict {
685 // The notes push `attest` makes re-enters this hook; its ref list is only
686 // ever the attest ref, so there is nothing to prove — and proving it
687 // would recurse.
688 if crate::attest::push_guard_active() {
689 return Verdict::Proceed;
690 }
691 crate::manifest::verify_tool_pins(&ctx.manifest.pins);
692 announce_policy_state(ctx.manifest);
693 // NB: no CHERRY_PICK_HEAD check here — the zsh pre-push had none either.
694 let severities = Overrides::read();
695 // pre-push had NO state guard at all, with a comment admitting it existed
696 // only because the zsh version had none. Now it asks the same question
697 // pre-commit does and each check answers for itself.
698 let in_progress = crate::git_states_in_progress();
699 let pre_push_checks = selected_during(Stage::PrePush, &in_progress, ctx.manifest);
700 let stage = crate::live::enabled().then(|| {
701 let names: Vec<&str> = pre_push_checks.iter().map(|c| c.name()).collect();
702 crate::live::Stage::begin(&names)
703 });
704 // What actually PASSED, for the attestation at the bottom. `Warned` and
705 // `Unavailable` stay out — "could not run" is not "passed" — and a
706 // commit-time-gated pair counts, because its stamps say the check ran on
707 // every pushed tree.
708 let mut passed: Vec<String> = Vec::new();
709 // Accumulated rather than written per check: one append at the end costs a
710 // single file open, and the loop below can leave early.
711 let mut downgraded: Vec<(String, crate::downgrade::Origin)> = Vec::new();
712 // PUSH STAMPS. The tips being pushed, and what earlier runs of THIS gate
713 // recorded against their trees — an `amont run pre-push` rehearsal, or a
714 // push whose gate passed and whose transport then died. A scoped gate
715 // (a test suite: its verdict is a function of the tree alone) whose
716 // stamp sits on every tip is not run again; the unscoped ones
717 // (branch-protect, secrets — questions about the push, not the content)
718 // always run. `amont.pushStamps false` turns the reuse off.
719 //
720 // Reading `ctx.push` here may consume stdin, exactly as `attest` does
721 // below; every pre-push check reads it anyway.
722 let tips: Vec<String> = {
723 let mut t: Vec<String> = ctx
724 .push
725 .get()
726 .iter()
727 .filter(|r| !r.local_oid.chars().all(|c| c == '0'))
728 .map(|r| r.local_oid.clone())
729 .collect();
730 t.dedup();
731 t
732 };
733 let reuse_stamps = crate::gate_stamp::push_stamps_enabled();
734 let push_stamps = if reuse_stamps && !tips.is_empty() {
735 crate::gate_stamp::stamps_for(&tips)
736 } else {
737 Default::default()
738 };
739 let stamped_on_every_tip = |name: &str| -> bool {
740 !tips.is_empty()
741 && tips.iter().all(|t| {
742 push_stamps
743 .get(t)
744 .is_some_and(|s| s.iter().any(|g| g == name))
745 })
746 };
747 // What actually RAN and passed here (as opposed to being vouched for by
748 // a stamp) — the set this run may stamp in turn.
749 let mut ran_and_passed: Vec<String> = Vec::new();
750 for (idx, check) in pre_push_checks.iter().enumerate() {
751 let _sink = stage.as_ref().map(|s| s.enter(idx));
752 let _flush = stage
753 .as_ref()
754 .map(|s| crate::live::FinishOnDrop::new(s, idx));
755 // A declared pre-push external whose NAME is also declared at
756 // pre-commit (blocking) is a gate pair: the commit-time side earned
757 // per-commit stamps, and this side runs only for pushes carrying
758 // commits with no record of it — the same contract the npm gate has
759 // always had, for vocabularies npm never heard of (`cargo test`,
760 // `pytest`, anything). Messages mirror the npm gate's exactly;
761 // docs/checks.md quotes them.
762 // The push side of a pair is `(name, scope)`, from whichever of the
763 // two kinds of check this is. A declared pre-push external supplies
764 // its own; anything else is a BUILT-IN, and `pairing_name` plus the
765 // registry's scope say the same two things about it.
766 //
767 // The external is tried FIRST and its inputs are unchanged, so the
768 // declared path behaves exactly as before — that is what the
769 // untouched declared-pair tests prove.
770 if !check.scope().is_unscoped() && stamped_on_every_tip(check.name()) {
771 crate::say!(
772 "{} {} passed on this exact tree earlier — not repeating it here",
773 valid_sign(),
774 highlight(check.name()),
775 );
776 passed.push(check.name().to_string());
777 continue;
778 }
779 let declared = ctx
780 .manifest
781 .externals
782 .iter()
783 .find(|e| e.stage == Stage::PrePush && e.id == check.name());
784 let builtin_scope = check.scope();
785 let pairing: Option<(&str, &crate::check::Scope)> = match declared {
786 Some(ext) => match &ext.kind {
787 crate::manifest::Kind::Runnable { scope, .. } => {
788 Some((ext.short_name.as_str(), scope))
789 }
790 // A declared pre-push entry that runs nothing has no scope to
791 // judge with, and is not a built-in either. Nothing to pair.
792 _ => None,
793 },
794 None => Some((check.pairing_name(), &builtin_scope)),
795 };
796 if let Some((name, push_scope)) = pairing {
797 match crate::hooks::run_tests::pair_verdict(name, push_scope, ctx.manifest, ctx.push) {
798 crate::hooks::run_tests::PairVerdict::Gated => {
799 crate::say!(
800 "{} {} gated at commit instead — not repeating it here",
801 valid_sign(),
802 highlight(name),
803 );
804 passed.push(check.name().to_string());
805 continue;
806 }
807 crate::hooks::run_tests::PairVerdict::Unstamped(n) => {
808 crate::say!(
809 "{} {} is declared at commit time, but {n} pushed \
810 commit{} carr{} no record of it — running it here",
811 warning_sign(),
812 name,
813 if n == 1 { "" } else { "s" },
814 if n == 1 { "ies" } else { "y" },
815 );
816 }
817 crate::hooks::run_tests::PairVerdict::NotPaired => {}
818 }
819 }
820 let sub = Ctx {
821 name: check.name(),
822 args: ctx.args,
823 hooks_dir: ctx.hooks_dir,
824 push: ctx.push,
825 manifest: ctx.manifest,
826 };
827 match check.run(&sub) {
828 Outcome::Passed => {
829 passed.push(check.name().to_string());
830 if !check.scope().is_unscoped() {
831 ran_and_passed.push(check.name().to_string());
832 }
833 }
834 // Announced, never fatal: a check that could not run has not
835 // invalidated anything, and neither has a warning.
836 Outcome::Unavailable => {
837 println!(
838 "{} {} could not run",
839 warning_sign(),
840 highlight(check.name())
841 )
842 }
843 Outcome::Warned => {}
844 // Cannot occur: `Fix::Rewrite` is refused on a pre-push
845 // declaration, so nothing here can repair anything.
846 Outcome::Fixed => {}
847 Outcome::Failed => match severities.of(*check) {
848 Severity::Warn => {
849 downgraded.push((
850 check.name().to_string(),
851 downgrade_origin(*check, &severities),
852 ));
853 println!(
854 "{} {} reported a problem (severity warn)",
855 warning_sign(),
856 highlight(check.name())
857 );
858 }
859 // Fail-fast applies ONLY to Block: the later steps are
860 // expensive and their preconditions are gone.
861 Severity::Block => {
862 // Record what already warned before leaving. Those checks
863 // ran and reported; a later check blocking does not unmake
864 // them, and dropping them here would make the ledger quietly
865 // under-count every push that ended badly.
866 crate::downgrade::note(&downgraded);
867 println!("\n🚨 Error raised by hook {}", highlight(check.name()));
868 return Verdict::Block;
869 }
870 },
871 }
872 }
873 // Every block gate passed — stamp the tips with the scoped gates that
874 // RAN here, so the next push of this content (a retry after a dropped
875 // connection, or the real push after an `amont run pre-push` rehearsal)
876 // skips them. Only when what ran is what is being pushed: with
877 // `amont.testPushedTree` the suite ran on the tip itself; otherwise it
878 // ran on the working tree, which vouches for the tip only when the two
879 // are the same content — HEAD, with nothing tracked modified.
880 // The same proxy `attestable` uses, for the same reason: a scoped gate
881 // whose files the push never touched returns `Passed` having run
882 // nothing, and a stamp for THAT would let a later push that does touch
883 // them skip a suite nobody ran.
884 if reuse_stamps && !ran_and_passed.is_empty() {
885 let changed = crate::pushrefs::changed_files(ctx.push.get());
886 let really_ran: Vec<String> = pre_push_checks
887 .iter()
888 .filter(|c| ran_and_passed.iter().any(|p| p == c.name()))
889 .filter(|c| c.scope().touches(&changed))
890 .map(|c| c.name().to_string())
891 .collect();
892 stamp_tips(&tips, &really_ran);
893 }
894 // …and say so to CI, if this repository opted in.
895 // Gated behind `enabled()` HERE, not just inside `attest_push`: reading
896 // `ctx.push` may consume stdin, and a disabled repo should leave stdin
897 // exactly as it found it.
898 if !passed.is_empty() && crate::attest::enabled() {
899 let remote = ctx
900 .args
901 .first()
902 .map(|a| a.to_string_lossy().into_owned())
903 .unwrap_or_default();
904 let changed = crate::pushrefs::changed_files(ctx.push.get());
905 let vouched = attestable(&pre_push_checks, &passed, &changed);
906 crate::attest::attest_push(&remote, ctx.push.get(), &vouched);
907 }
908 crate::downgrade::note(&downgraded);
909 Verdict::Proceed
910}
911
912/// Push-stamp every tip whose content is what the gates actually tested.
913///
914/// See the comment at the call site for the two cases. Silent when nothing
915/// qualifies — a dirty working tree is the ordinary state of a machine
916/// mid-work, and a note on every push would teach people to ignore it.
917fn stamp_tips(tips: &[String], gates: &[String]) {
918 let pushed_tree_mode = crate::pushed_tree::enabled();
919 let head = crate::git::stdout(&["rev-parse", "HEAD"]);
920 // Tracked modifications only: untracked files are not in any tree the
921 // suite could have been asked about, and `status --porcelain` with
922 // `--untracked-files=no` is the cheapest honest answer.
923 let worktree_clean = || {
924 crate::git::stdout(&["status", "--porcelain", "--untracked-files=no"])
925 .is_some_and(|s| s.trim().is_empty())
926 };
927 let mut stamped: Vec<&str> = Vec::new();
928 for tip in tips {
929 let vouchable =
930 pushed_tree_mode || (head.as_deref() == Some(tip.as_str()) && worktree_clean());
931 if !vouchable {
932 continue;
933 }
934 let spec = format!("{tip}^{{tree}}");
935 let Some(tree) = crate::git::stdout(&["rev-parse", &spec]) else {
936 continue;
937 };
938 if crate::gate_stamp::stamp_push(tip, &tree, gates) {
939 stamped.push(tip);
940 }
941 }
942 if !stamped.is_empty() {
943 crate::say!(
944 "{} stamped {} for this tree — the next push of it skips them ({})",
945 valid_sign(),
946 highlight(&gates.join(" ")),
947 crate::gate_stamp::NOTES_REF,
948 );
949 }
950}
951
952/// Of the checks that passed, the ones an attestation may actually VOUCH for.
953///
954/// A language gate whose scope the push never touched returns `Passed` having
955/// run nothing — `cargo_test` walks its refs, finds no crate root, and falls
956/// out of the loop green. That is right for a push gate (there was nothing to
957/// object to) and wrong for an attestation: a JS-only push was minting
958/// `gates … pre-push-cargo-test pre-push-go-test pre-push-pytest`, and in a
959/// MIXED repository CI would then skip a suite that nobody ran on that tree.
960///
961/// The declared `scope` is the honest filter, and the same data `amont list`
962/// already reports. Unscoped checks (`Scope::ALWAYS` — branch-protect,
963/// secrets) match everything and are vouched for, which is accurate: they
964/// really did run. An empty `changed` vouches for nothing scoped, which is
965/// the safe direction — CI runs the suite.
966///
967/// [`Scope::touches`], NOT `Scope::matches`. `matches` also asks whether the
968/// repository has opted in — whether a `Cargo.toml` exists — and asking that
969/// of a push DIFF can only answer no unless the push happened to touch the
970/// marker. So `pre-push-cargo-test` was vouched for by a push that edited
971/// `Cargo.toml` and never by one that edited only `.rs` files, which is the
972/// ordinary case and the one worth skipping CI for. The feature attested
973/// almost nothing, silently, and looked like it worked.
974///
975/// WHAT THIS IS STILL A PROXY FOR, stated plainly because the trust path
976/// deserves it: the honest question is "did this gate actually run", and no
977/// gate reports that. `rust_tools::test` returns `Passed` whether it ran a
978/// suite or found no crate root and fell out of its loop — the very thing
979/// the first paragraph describes. Scope is the closest available stand-in.
980/// It is now a good one: a gate is vouched for only if the push changed a
981/// file its extensions cover.
982///
983/// The gap that remains is narrow and one-directional: a `.rs` file outside
984/// every crate would be covered here while `cargo test` had nothing to say
985/// about it. Closing it properly means an outcome that distinguishes "ran
986/// and passed" from "found nothing to do", which is a change to every gate
987/// and to `Outcome` itself — worth doing, not worth smuggling into this.
988fn attestable(checks: &[&dyn Check], passed: &[String], changed: &[String]) -> Vec<String> {
989 checks
990 .iter()
991 .filter(|c| passed.iter().any(|p| p == c.name()))
992 .filter(|c| c.scope().touches(changed))
993 .map(|c| c.name().to_string())
994 .collect()
995}
996
997#[cfg(test)]
998mod tests {
999 use super::*;
1000 use crate::check::{Builtin, Scope};
1001 use std::sync::atomic::{AtomicUsize, Ordering};
1002
1003 /// A check whose only job is to carry a name and a severity into `report`.
1004 /// Its `run` is never called — `report` is fed outcomes directly, which is
1005 /// what makes `Unavailable` testable at all: the real thing needs a missing
1006 /// binary, and a test that uninstalls the developer's toolchain is worse
1007 /// than no test.
1008 const fn stub(name: &'static str, severity: Severity) -> Builtin {
1009 Builtin {
1010 name,
1011 stage: Stage::PreCommit,
1012 scope: Scope::ALWAYS,
1013 severity,
1014 run: |_| Outcome::Passed,
1015 fix: crate::check::Fix::None,
1016 reach: crate::check::Reach::Convention,
1017 }
1018 }
1019
1020 /// A pre-push gate with an OPT-IN file, as the real Rust and Python
1021 /// gates have: `.rs` files, but only where a `Cargo.toml` exists.
1022 const fn opt_in(
1023 name: &'static str,
1024 exts: &'static [&'static str],
1025 names: &'static [&'static str],
1026 ) -> Builtin {
1027 Builtin {
1028 name,
1029 stage: Stage::PrePush,
1030 scope: Scope::new(exts, names),
1031 severity: Severity::Block,
1032 run: |_| Outcome::Passed,
1033 fix: crate::check::Fix::None,
1034 reach: crate::check::Reach::Convention,
1035 }
1036 }
1037
1038 /// A pre-push gate scoped to one language's files.
1039 const fn scoped(name: &'static str, exts: &'static [&'static str]) -> Builtin {
1040 Builtin {
1041 name,
1042 stage: Stage::PrePush,
1043 scope: Scope::new(exts, &[]),
1044 severity: Severity::Block,
1045 run: |_| Outcome::Passed,
1046 fix: crate::check::Fix::None,
1047 reach: crate::check::Reach::Convention,
1048 }
1049 }
1050
1051 /// The over-claim this filter exists to stop, caught in the wild: a
1052 /// JS-only push minted `gates … pre-push-cargo-test pre-push-go-test
1053 /// pre-push-pytest`, because each of those gates finds nothing of its
1054 /// language to do and returns `Passed` having run NOTHING. Harmless in a
1055 /// single-language repo, unsound in a mixed one — CI would skip a suite
1056 /// nobody ran on that tree.
1057 #[test]
1058 fn a_gate_whose_language_the_push_never_touched_is_not_vouched_for() {
1059 let js = scoped("pre-push-run-tests-js", &[".ts", ".js"]);
1060 let rust = scoped("pre-push-cargo-test", &[".rs"]);
1061 let py = scoped("pre-push-pytest", &[".py"]);
1062 let always = stub("pre-push-secrets", Severity::Block);
1063 let checks: Vec<&dyn Check> = vec![&js, &rust, &py, &always];
1064 let passed: Vec<String> = checks.iter().map(|c| c.name().to_string()).collect();
1065
1066 let changed = vec!["app/routes/home.ts".to_string()];
1067 let vouched = attestable(&checks, &passed, &changed);
1068 assert_eq!(
1069 vouched,
1070 vec![
1071 "pre-push-run-tests-js".to_string(),
1072 "pre-push-secrets".to_string()
1073 ],
1074 "only the gate that had work, plus the unscoped one that always runs"
1075 );
1076
1077 // Nothing computed about the push vouches for nothing scoped — the
1078 // safe direction, since CI then runs the suite.
1079 assert_eq!(
1080 attestable(&checks, &passed, &[]),
1081 vec!["pre-push-secrets".to_string()]
1082 );
1083
1084 // A check that did NOT pass is never vouched for, whatever its scope.
1085 let only_rust_passed = vec!["pre-push-cargo-test".to_string()];
1086 assert!(attestable(&checks, &only_rust_passed, &changed).is_empty());
1087 }
1088
1089 /// No overrides configured. `report` takes them as a VALUE now, so its
1090 /// tests need no repository and no git at all.
1091 fn none() -> Overrides {
1092 Overrides::default()
1093 }
1094
1095 static BLOCKER: Builtin = stub("stub-blocker", Severity::Block);
1096 static WARNER: Builtin = stub("stub-warner", Severity::Warn);
1097
1098 /// The unit tests hold `&dyn Check` for the same reason the dispatcher
1099 /// does: `report` must not be able to tell a built-in from an external.
1100 const fn as_checks(cs: [&'static Builtin; 3]) -> [&'static dyn Check; 3] {
1101 [cs[0], cs[1], cs[2]]
1102 }
1103
1104 /// The classification itself, which used to be unreachable: while one
1105 /// function classified AND printed AND returned a code, a test could assert
1106 /// the code and nothing else.
1107 #[test]
1108 fn every_outcome_lands_in_the_right_bucket() {
1109 let checks: [&dyn Check; 4] = [&BLOCKER, &BLOCKER, &WARNER, &BLOCKER];
1110 let got = classify(
1111 &checks,
1112 &[
1113 Outcome::Passed,
1114 Outcome::Unavailable,
1115 Outcome::Failed,
1116 Outcome::Failed,
1117 ],
1118 &none(),
1119 );
1120 assert_eq!(got.blocked, ["stub-blocker"], "{got:?}");
1121 assert_eq!(got.downgraded, ["stub-warner"], "{got:?}");
1122 assert_eq!(got.unavailable, ["stub-blocker"], "{got:?}");
1123 }
1124
1125 /// A clean stage concludes nothing at all — not an empty message, no
1126 /// message. Twenty checks that passed should print no roll-ups.
1127 #[test]
1128 fn a_clean_stage_has_nothing_to_report() {
1129 let checks: [&dyn Check; 2] = [&BLOCKER, &WARNER];
1130 let got = classify(&checks, &[Outcome::Passed, Outcome::Warned], &none());
1131 assert_eq!(got, Report::default());
1132 assert_eq!(got.verdict(), Verdict::Proceed);
1133 }
1134
1135 #[test]
1136 fn a_blocking_failure_is_the_only_thing_that_fails_the_commit() {
1137 let b: &dyn Check = &BLOCKER;
1138 let w: &dyn Check = &WARNER;
1139 assert_eq!(
1140 classify(&[b], &[Outcome::Failed], &none()).verdict(),
1141 Verdict::Block
1142 );
1143 assert_eq!(
1144 classify(&[b], &[Outcome::Passed], &none()).verdict(),
1145 Verdict::Proceed
1146 );
1147 // Every non-blocking shape, one at a time, so a regression cannot hide
1148 // behind a passing sibling.
1149 assert_eq!(
1150 classify(&[b], &[Outcome::Warned], &none()).verdict(),
1151 Verdict::Proceed
1152 );
1153 assert_eq!(
1154 classify(&[b], &[Outcome::Unavailable], &none()).verdict(),
1155 Verdict::Proceed
1156 );
1157 assert_eq!(
1158 classify(&[w], &[Outcome::Failed], &none()).verdict(),
1159 Verdict::Proceed
1160 );
1161 }
1162
1163 #[test]
1164 fn one_blocking_failure_among_many_still_fails() {
1165 let checks = as_checks([&BLOCKER, &WARNER, &BLOCKER]);
1166 assert_eq!(
1167 classify(
1168 &checks,
1169 &[Outcome::Unavailable, Outcome::Failed, Outcome::Failed],
1170 &none()
1171 )
1172 .verdict(),
1173 Verdict::Block
1174 );
1175 // Same shape, with the only *blocking* failure removed.
1176 assert_eq!(
1177 classify(
1178 &checks,
1179 &[Outcome::Unavailable, Outcome::Failed, Outcome::Passed],
1180 &none()
1181 )
1182 .verdict(),
1183 Verdict::Proceed
1184 );
1185 }
1186
1187 /// The slot of a check whose thread died. Reading that as a pass is how a
1188 /// crash becomes a green commit.
1189 ///
1190 /// Asserted through the RUNNER, not through a `Default` impl: the rule
1191 /// belongs to this call site, and a test on `Outcome::default()` proved
1192 /// only that a trait impl existed, not that the runner used it.
1193 /// A check that PANICS must fail the commit, not pass it — and must not
1194 /// take the other checks down with it.
1195 ///
1196 /// Driven through the stage body rather than the runner, because the value
1197 /// that stands in for a dead check is chosen at the call site and the
1198 /// runner's own test cannot see that choice.
1199 #[test]
1200 fn a_panicking_check_blocks_the_commit() {
1201 static DIES: Builtin = Builtin {
1202 name: "stub-dies",
1203 stage: Stage::PreCommit,
1204 scope: Scope::ALWAYS,
1205 severity: Severity::Block,
1206 run: |_| panic!("this check died"),
1207 fix: crate::check::Fix::None,
1208 reach: crate::check::Reach::Convention,
1209 };
1210 let hook = std::panic::take_hook();
1211 std::panic::set_hook(Box::new(|_| {}));
1212 let push = crate::pushrefs::PushRefs::default();
1213 let manifest = crate::manifest::Manifest::default();
1214 let ctx = Ctx {
1215 name: "pre-commit",
1216 args: &[],
1217 hooks_dir: std::path::Path::new("."),
1218 push: &push,
1219 manifest: &manifest,
1220 };
1221 let verdict = run_stage(&[&DIES], &ctx, &none());
1222 std::panic::set_hook(hook);
1223 assert_eq!(
1224 verdict,
1225 Verdict::Block,
1226 "a check that died must not let the commit through"
1227 );
1228 }
1229
1230 #[test]
1231 fn a_thread_that_dies_leaves_a_failure_behind() {
1232 // The default hook would print a backtrace for the deliberate panic and
1233 // make a passing run look broken.
1234 let hook = std::panic::take_hook();
1235 std::panic::set_hook(Box::new(|_| {}));
1236 let items = ["a", "b", "c"];
1237 let out = run_concurrently(
1238 &items,
1239 |n: &&str| {
1240 if *n == "b" {
1241 panic!("this check died");
1242 }
1243 Outcome::Passed
1244 },
1245 Outcome::Failed,
1246 );
1247 std::panic::set_hook(hook);
1248 assert_eq!(
1249 out,
1250 vec![Outcome::Passed, Outcome::Failed, Outcome::Passed],
1251 "a dead check must not read as one that passed, \
1252 and must not take the other checks down with it"
1253 );
1254 }
1255 use std::time::{Duration, Instant};
1256
1257 /// Concurrency proved by RENDEZVOUS, not by a stopwatch: every task must
1258 /// observe all the others arrive. Were the runner serial, the first task
1259 /// would wait alone, time out, and return non-zero — a failure, not a hang.
1260 #[test]
1261 fn run_concurrently_actually_overlaps() {
1262 static ARRIVED: AtomicUsize = AtomicUsize::new(0);
1263 ARRIVED.store(0, Ordering::SeqCst);
1264 let names: Vec<&'static str> = vec!["a", "b", "c", "d"];
1265 let n = names.len();
1266
1267 let out = run_concurrently(
1268 &names,
1269 move |_: &&str| {
1270 ARRIVED.fetch_add(1, Ordering::SeqCst);
1271 let deadline = Instant::now() + Duration::from_secs(10);
1272 while ARRIVED.load(Ordering::SeqCst) < n {
1273 if Instant::now() > deadline {
1274 return 1; // never met the others — execution was serial
1275 }
1276 std::thread::yield_now();
1277 }
1278 0
1279 },
1280 1,
1281 );
1282 assert!(
1283 out.iter().all(|c| *c == 0),
1284 "tasks did not overlap: {out:?}"
1285 );
1286 }
1287
1288 #[test]
1289 fn results_come_back_in_input_order() {
1290 let names: Vec<&'static str> = vec!["first", "second", "third"];
1291 let out = run_concurrently(&names, |n| if *n == "second" { 7 } else { 0 }, -1);
1292 assert_eq!(out, vec![0, 7, 0], "results keep the input order");
1293 }
1294
1295 /// The filter calls the shared resolver rather than restating it. This test
1296 /// used to inline `n.contains(s)` — its own copy of the rule — and so went
1297 /// on passing after the rule changed underneath it.
1298 #[test]
1299 fn skips_are_filtered_by_the_shared_resolver() {
1300 let all = ["pre-commit-ruff", "pre-commit-prettier"];
1301 let skips = ["ruff".to_string()];
1302 let kept: Vec<_> = all
1303 .iter()
1304 .copied()
1305 .filter(|n| !skips.iter().any(|s| crate::skip_suppresses(n, s)))
1306 .collect();
1307 assert_eq!(kept, vec!["pre-commit-prettier"]);
1308 }
1309
1310 /// The ordinary Rust push: source changed, `Cargo.toml` untouched.
1311 ///
1312 /// This test used to assert the OPPOSITE, and said so — it pinned
1313 /// `attestable` filtering on `Scope::matches`, which also asks whether
1314 /// the repository has opted in. Asking that of a push diff meant a
1315 /// `.rs`-only push, in a repository with a `Cargo.toml` sitting right
1316 /// there, attested nothing. Since that is what nearly every Rust push
1317 /// looks like, the feature was attesting almost nothing at all — quietly,
1318 /// while appearing to work.
1319 #[test]
1320 fn an_ordinary_source_push_is_vouched_for() {
1321 let rust = opt_in("pre-push-cargo-test", &[".rs"], &["Cargo.toml"]);
1322 let checks: Vec<&dyn Check> = vec![&rust];
1323 let passed = vec!["pre-push-cargo-test".to_string()];
1324
1325 let changed = vec!["crates/amont/src/main.rs".to_string()];
1326 assert_eq!(
1327 attestable(&checks, &passed, &changed),
1328 vec!["pre-push-cargo-test".to_string()],
1329 "a push that changed Rust must vouch for the Rust gate"
1330 );
1331
1332 // And still when the marker IS in the diff — the opt-in file is not
1333 // required, but it is not disqualifying either.
1334 let changed = vec![
1335 "crates/amont/src/main.rs".to_string(),
1336 "Cargo.toml".to_string(),
1337 ];
1338 assert_eq!(
1339 attestable(&checks, &passed, &changed),
1340 vec!["pre-push-cargo-test".to_string()]
1341 );
1342 }
1343
1344 /// The over-claim the filter exists to stop, with an opt-in gate: a
1345 /// JS-only push must not vouch for the Rust suite, whatever files the
1346 /// repository contains.
1347 ///
1348 /// This is the half of the contract the fix above must not have broken,
1349 /// and it is the reason `touches` asks about EXTENSIONS rather than
1350 /// dropping the scope test altogether.
1351 #[test]
1352 fn an_opt_in_gate_is_not_vouched_for_by_a_push_in_another_language() {
1353 let rust = opt_in("pre-push-cargo-test", &[".rs"], &["Cargo.toml"]);
1354 let checks: Vec<&dyn Check> = vec![&rust];
1355 let passed = vec!["pre-push-cargo-test".to_string()];
1356
1357 for changed in [
1358 vec!["app/routes/home.ts".to_string()],
1359 // Even the marker alone: editing Cargo.toml changes no Rust
1360 // source, so the suite has nothing new to have verified.
1361 vec!["Cargo.toml".to_string()],
1362 vec![],
1363 ] {
1364 assert!(
1365 attestable(&checks, &passed, &changed).is_empty(),
1366 "must not vouch for the Rust gate on {changed:?}"
1367 );
1368 }
1369 }
1370}