diff --git a/docs/testing.md b/docs/testing.md index f76b024..643a307 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -6,6 +6,24 @@ binding the results to that image's digest; a `skipped` suite blocks admission exactly like a failure. See [`gotchas.md`](gotchas.md) for the traps that live in the harness rather than in Stream. +## Three receipt names that are not the command name + +A receipt records twenty suites. Seventeen are named exactly like the `just` +target that runs them, so a red entry tells you what to re-run. Three do not, +and `scripts/admit` is the authority on the mapping: + +| suite in the receipt | how to run it | +|---|---| +| `lifecycle-oracle` | `just oracle` | +| `unit-debug` | `zig build test` | +| `unit-releasesafe` | `zig build test -Doptimize=ReleaseSafe` | + +So the everyday `zig build test` below is two of the twenty admission suites, +and the unit tests are graded in both build modes — `ReleaseSafe` differs from +`Debug` in more than speed, since release-mode safety checks and different +undefined-behaviour handling can hide or expose a bug that the other mode does +not. There is no `just lifecycle-oracle`; searching for one finds nothing. + ## Everyday ```