TESTING
docs/TESTING.md
Testing (gbrain repo)
On-demand reference (see CLAUDE.md Reference map). Current behavior + invariants only.
test/e2e/serve-http-oauth.test.ts additionally pins confidential POST/Basic revocation, public-client SDK fallthrough, malformed/mixed authentication rejection, cross-client isolation, unknown-token opacity, metadata auth methods, no-store responses, strict post-revoke 401, and retryable backend 503 semantics.
Test command tiers
Seven test command tiers, each with a clear scope:
| Command | What it runs | Wallclock | When to use |
|---|---|---|---|
bun run test | Parallel unit-test fast loop. Sharded fan-out via scripts/run-unit-parallel.sh (default 4 shards — CPU-detected, clamped to a max of 8; 4 matches CI's fan-out and avoids PGLite WASM-init contention), then a serial pass over *.serial.test.ts. Excludes *.slow.test.ts and test/e2e/*. No pre-checks, no typecheck. Builds/refreshes the PGLite schema snapshot BEFORE the shard fan-out and exports GBRAIN_PGLITE_SNAPSHOT so PGLite-booting files restore a baked schema instead of replaying every migration (~3.5x per booting file; see "PGLite schema snapshot" below). Opt out: GBRAIN_NO_SNAPSHOT=1. Memory-safe by default: total concurrency (shards × intra-shard files) is capped to available memory at GBRAIN_TEST_MEM_PER_FILE_MB (default 1536 — a PGLite WASM instance) per concurrent file, and two phantom-failure classes are automatically re-run serially (the rescue pass): failures carrying the WASM out-of-memory signature, and shards killed externally (SIGTERM/SIGKILL well before the shard timeout — sibling workspaces' process cleanup, memory jetsam). Phantoms pass serially and the run goes green with an oom_rescued note; real failures fail again serially and stay red. Knobs: GBRAIN_TEST_NO_MEM_ADAPT=1, GBRAIN_TEST_NO_OOM_FALLBACK=1, GBRAIN_TEST_MAX_CONCURRENCY (intra-shard, default 4), GBRAIN_TEST_SHARD_TIMEOUT / GBRAIN_TEST_SHARD_KILL_AFTER, plus --shards N / --max-concurrency N / --dry-run script args. | a few minutes on a Mac dev box | Inner edit loop. Default. |
bun run verify | CI's authoritative pre-test gate set, fanned out by scripts/run-verify-parallel.sh through a bounded worker pool (default detect_cpus; override GBRAIN_VERIFY_MAX_PARALLEL) with the heavy checks ordered first (typecheck, the two compile-embed checks, admin build, fuzz bundles, guard self-tests, the PGLite-booting eval checks, whole-tree greps). The battery includes the deterministic check:eval-chronicle and check:eval-canary eval gates. The CHECKS array in that script is the single source of truth — CI literally calls bun run verify in a dedicated job. | ~40s (pool-bounded; longest check dominates) | Before pushing; before /ship. |
bun run test:full | verify && bun run test && bun run test:slow && [smart e2e]. The local equivalent of "everything CI runs." Smart e2e: runs e2e only when DATABASE_URL is set; else loud skip notice to stderr. | ~3-5min depending on slow + e2e | Pre-merge sanity, before opening a PR. |
bun run test:slow | Just the *.slow.test.ts set (intentional cold-path correctness checks). | seconds-to-minutes | When touching slow-path code. |
bun run test:serial | Just the *.serial.test.ts set (cross-file-contention quarantine; one bun process per file for true module-registry isolation), run through a POOL of concurrent per-file processes — the isolation is per-process, not per-machine. Pool defaults to min(detect_cpus, 4) then memory-adapts (same doctrine as the parallel runner); a small growth-guarded set of files (machine-global state or contention-critical timing — see the justified EXCLUSIVE_FILES list in scripts/run-serial-tests.sh, capped at 3 by test/scripts/serial-files.test.ts) runs on a sequential EXCLUSIVE lane after the pool. Per-test timeout 120s (pooled contention headroom); each pooled file is wall-clock-killed at 300s (timeout -k, exit-hang containment). Externally-killed files (exit 143/137 or a missing exit sentinel — sibling-workspace cleanup, memory jetsam) get ONE sequential rescue re-run, mirroring the parallel runner's doctrine: phantoms stay green with a rescue note, real failures stay red. Prints per-file PASS lines plus a top-10 slowest-files list. Knobs: GBRAIN_SERIAL_POOL=N (explicit pool width — bypasses the memory clamp; 1 restores fully-sequential), GBRAIN_SERIAL_FILE_TIMEOUT. | ~2.5min for all ~140 files at pool=4 (was ~8.5min sequential) | Debugging quarantined files; CI's serial-tests job. |
bun run test:e2e | Real Postgres E2E. Requires Docker + DATABASE_URL. Sequential. | ~5-10min | Pre-ship; nightly. |
bun run test:compile-smoke | Self-update integrity verify under a REAL bun build --compile binary, offline (sets GBRAIN_SELFUPDATE_COMPILE_SMOKE=1). The unit suite mocks the network seams; this proves the dependency-free crypto/base64/JSON verify path survives compilation — the failure mode sigstore-js would have hit. | ~5s (one compile) | When touching src/core/binary-self-update.ts; pre-ship on self-update changes. |
There is no check:all script anymore — it was a second, hand-synced guard
registry that drifted from verify (three checks were reachable ONLY from it,
i.e. never ran anywhere). The CHECKS array in scripts/run-verify-parallel.sh
is the single execution list, and it now includes the former check:all-only
extras (check:newlines, check:exports-count, check:no-legacy-getconnection).
The guard REGISTRY is scripts/guards-manifest.tsv (see "Guard registry and
self-test" below).
PGLite schema snapshot (default-on)
scripts/build-pglite-snapshot.ts (bun run build:pglite-snapshot) bakes a
post-initSchema() PGLite data dir into test/fixtures/pglite-snapshot.tar
plus a version file; PGLiteEngine.initSchema() restores the tar instead of
replaying the embedded schema + all migrations when the env var
GBRAIN_PGLITE_SNAPSHOT points at it. Runners activate it through the shared
ensure_pglite_snapshot helper in scripts/lib/test-env.sh (also home of
detect_cpus and detect_available_mem_mb), sourced by
run-unit-parallel.sh, test-shard.sh, run-slow-tests.sh,
run-serial-tests.sh, and run-verify-parallel.sh; scripts/ci-local.sh
calls the builder directly. The helper builds/refreshes the snapshot and
exports the env var, no-ops on GBRAIN_NO_SNAPSHOT=1 or an already-inherited
path, and is non-fatal on build failure — tests fall back to cold init, with
a one-line "active" echo so a silent fallback stays visible in CI logs.
Measured effect: ~3.5x per PGLite-booting file (a cold boot replays every
migration, ~3.1s each on a CI shard). Properties:
- Idempotent. A hash short-circuit exits in ~40ms when the snapshot is
fresh, and REBUILDS a stale one. The hash covers
PGLITE_SCHEMA_SQL, every migration'ssql+sqlFor.pglite, AND each migrationhandler's function source (Function.prototype.toString) — 19+ migrations carry executable handler code with emptysqlthat a sql-only hash cannot see. - Concurrency-safe. Parallel shard runners / sibling workspaces serialize
on an atomic
mkdirlock (test/fixtures/.pglite-snapshot.lock) with staleness-verified takeover of a crashed builder; the tar is written first and the version file last, so a crash can never leave a fresh-looking torn fixture.GBRAIN_SNAPSHOT_LOCK_TIMEOUT_MS(default 120000) bounds the waiter; an exhausted waiter facing a still-live lock proceeds unlocked as a last resort (the loader gate below validates the version file, not the tar bytes). - Never authoritative. The loader (
tryLoadSnapshotinsrc/core/pglite-engine.ts) verifies the schema hash AND the embedding shape the snapshot was baked with (dims=/model=lines in the version file) against what this process would create; any mismatch — including a version file without shape lines — warns once and falls through to normal cold init. A wrong fixture can never poison the suite. - Opt out.
GBRAIN_NO_SNAPSHOT=1skips the build + env export for a run; the migration-replay canary tests clear the env themselves regardless.
Pinned by test/snapshot-shape-guard.test.ts (hash + shape refusal matrix,
handler-source hash sensitivity).
Guard registry and self-test
scripts/guards-manifest.tsv is THE single registry of scripts/check-*
guards (currently 48), each classified scanner (greps/parses repo sources —
must eventually carry fixtures), buildfresh, or repostate (build/freshness
guards are exempt-with-reason, not fixture-tested).
scripts/guard-self-test.sh (bun run check:guard-self-test, wired into
bun run verify) proves every selftest=yes scanner CAN fail: it runs each
one against known-bad (must exit non-zero) and known-good (must pass) fixture
trees under test/fixtures/guards/<guard>/{bad,good}/ via the
GBRAIN_GUARD_ROOT env seam, and enforces manifest completeness — a new
scripts/check-* script that isn't registered in the manifest fails the
build. A guard whose pattern rots into a permanently-green no-op now fails CI
instead of masquerading as coverage.
Shell dispatch and Windows
All four of test, verify, ci:local and test:e2e hand off to shell scripts
under scripts/, so every check:* entry in package.json invokes its script as
bash scripts/<name>.sh instead of relying on the shebang — bun on Windows cannot
exec a .sh directly. Add a new shell-script check with that same prefix. The
scripts/*.ts entries run under bun and take no prefix.
The scripts must also be on disk with Unix line endings. A strict bash (WSL, Linux
CI, macOS) rejects CRLF and dies on the script's first meaningful line; the Cygwin
bash that ships with Git for Windows tolerates it, so a green local run is not by
itself evidence that a script is CRLF-clean.
The root .gitattributes pins *.sh text eol=lf, which overrides the
core.autocrlf=true default that Git for Windows installs. It pins *.md the
same way, because the frontmatter readers anchor on a --- fence followed by a
Unix line ending and a CRLF checkout makes a document parse as having no
frontmatter, silently. Working copies cloned
before those pins need a one-time git rm --cached -r . -q && git reset --hard to
pick them up; see the Windows section of CONTRIBUTING.md.
Wallclock figures in the table above are from a Mac dev box. Windows is
substantially slower because each check pays full process-creation cost, and three
tree-walking checks (check:privacy, check:test-names, check:test-isolation)
plus typecheck can exceed the 120s per-check cap in run-verify-parallel.sh
there even though they pass on Linux and macOS.
CI vs local: intentionally divergent file sets
- CI matrix (
.github/workflows/test.yml) runsscripts/test-shard.shacross 10 matrix shards partitioned by weight-aware LPT bin-packing (scripts/sharding.ts; files with no mined weight fall back to the p75 file weight so a new unweighted file can't silently unbalance a shard) and INCLUDES*.slow.test.ts(the two outlier slow files run as dedicated jobs alongside the matrix) plusevals/**/*.test.ts(keyless-allowlist-gated —test/scripts/evals-collection.test.ts). Each shard's bun process is bounded by--max-concurrency(GBRAIN_TEST_MAX_CONCURRENCY, default 4). Every bun-test job — matrix shards, serial-tests, verify, the slow/eval jobs — activates the PGLite schema snapshot (built in-runner viascripts/lib/test-env.sh; the brainbench gate brings its own in-memory PGLite and skips it; the ~42MB tar is also cached across jobs via actions/cache, with the runner's own hash check staying authoritative). CI EXCLUDES*.serial.test.tsfrom the shards and runs them in the pooledserial-testsjob viabun run test:serial— one bun process per file preserves themock.modulequarantine; the pool runs those processes concurrently.bun run verifygets its own job too, as does the BrainBench memory-conformance gate (brainbenchjob →scripts/ci-brainbench-gate.sh, hermetic in-memory PGLite, ~15s), which compares HEAD's fresh run against master's committed baseline (evals/brainbench/baselines/main.json) — thetest-statusaggregate checks its result explicitly. E2E (.github/workflows/e2e.yml) mirrors the content-hash skip in its owne2e-pass-<hash>namespace (scheduled nightly runs are exempt and always run), runs tier1 and tier2 in parallel with the jsonb-parity job in front of tier2 as the token-spend gate, and aggregates throughe2e-status. CI is the ground truth for "did everything pass." - Local fast loop (
scripts/run-unit-shard.shvia the parallel wrapper) uses round-robin-by-index sharding and EXCLUDES*.slow.test.tsAND*.serial.test.ts. Local trades coverage for inner-loop speed; CI catches what local skips.
This divergence is intentional. Don't try to make them equal — the two scripts deliberately solve different problems. The regression test at test/scripts/run-unit-shard.test.ts pins what the local fast loop should and shouldn't include; test/scripts/run-unit-parallel.test.ts pins the wrapper's memory-adaptive concurrency and the OOM/external-kill serial rescue pass.
Coverage lanes and gates
Line coverage is opt-in via COVERAGE_DIR: when set, the shell lanes
(scripts/test-shard.sh, scripts/run-serial-tests.sh, scripts/run-e2e.sh)
pass --coverage --coverage-reporter=lcov to bun; when unset, the exec line is
byte-identical to a non-coverage run. Every bun process gets its OWN coverage
dir ($COVERAGE_DIR/shard, serial-$idx, e2e-$idx) because a reused dir
silently overwrites lcov.info — the shard runner also pins xargs to a single
batch (-n 100000 -x) so an argv overflow fails loud instead of spawning a
second, overwriting bun process. On a green run each lane writes
$COVERAGE_DIR/lane-manifest.json ({lane, sha, lcovCount, complete}); a red
run writes no manifest, which downstream merging treats as an incomplete lane.
run-e2e.sh specifics: COVERAGE_DIR is normalized to an absolute path
against the repo root before HOME moves (the script redirects
HOME/GBRAIN_HOME and E2E tests spawn CLI subprocesses with varying cwd —
an un-normalized relative dir would scatter output), and E2E_FILE_TIMEOUT_SECS
caps each file's wallclock (default 180s; the nightly coverage lane uses 300s
for instrumentation overhead). Both env names are deliberately
non-GBRAIN_-prefixed so the hermetic env scrub keeps them.
Two corpora.
- PR corpus (
prCorpus) — the 13 coverage-collecting lanes in.github/workflows/test.yml: the 10 matrix shards,serial-tests, and the two dedicated slow jobs. Deterministic (runs identically on every PR); this is the corpus the gates run against. - fullCorpus — nightly, schedule-only in
.github/workflows/e2e.yml:coverage-full-{unit,serial,slow,e2e}+coverage-full-report. Fully self-contained (every lane re-runs with coverage inside that workflow, including the fulltest/e2e/*glob against real Postgres) — the honest merged unit+serial+slow+e2e number, kept as thecoverage-full-mergedtrend artifact.
Merge (scripts/merge-lcov.ts). Walks the input dirs for lcov.info +
lane-manifest.json, sums DA hits per file:line, normalizes paths
repo-relative, and emits a merged lcov plus a summary JSON: src-only
totals/per-dir/per-file percentages, a lineHits map (the diff gate's input),
and the never-loaded src file list. --manifest-expect lane,lane,... pins the
expected lane set; a missing or complete: false manifest, an unparseable
lcov, or a shard lane with lcovCount != 1 marks the summary
degraded: true. Degraded is data, not failure: the merge never aborts (exit
0), and both gates print WOULD PASS/WOULD FAIL and exit 0 on a degraded
summary instead of enforcing against partial data.
Diff gate (scripts/coverage-diff-gate.ts). Gates the added/changed lines
of git diff origin/master...HEAD restricted to gate scope (src/**.ts minus
*.test.ts/*.generated.ts/*.d.ts): covered/(covered+uncovered) must be
≥ 80%, AND no gate-scoped changed file may be entirely absent from the
coverage data (a never-loaded file is one violation — add a test that imports
it). Non-executable lines (no lcov record) don't count against you; empty and
doc-only diffs short-circuit to PASS via the select-e2e classifier. Escape
hatches: a commit body containing [coverage-exempt: reason] passes with a
loud warning, and scripts/coverage-gate-exemptions.txt (exact path or
trailing-/ prefix per line; resolved via
git show origin/master:scripts/coverage-gate-exemptions.txt, never the
working tree, so a PR cannot self-exempt; SHRINK-ONLY — additions need a
graduation review in the PR description) excludes paths from the gate while
still reporting them
([e2e-exempt], [subprocess-undercount]). Report-only unless
COVERAGE_GATE_ENFORCE=1. Exit contract: 0 = pass or report-only, 1 = gate
fail while enforcing, 2 = infrastructure error (missing summary, git failure —
never conflated with a coverage verdict).
Baseline gate (scripts/coverage-baseline-gate.ts). Anti-erosion floor:
reads the baseline via git show origin/master:scripts/coverage-baseline.json
— the master copy, never the working tree, so a PR cannot weaken its own bar —
and compares like-for-like by corpus (--corpus prCorpus in test.yml,
--corpus fullCorpus nightly). A global drop > 0.5pp, a per-directory drop
1.0pp, or a never-loaded-count increase fails (deleting tests shrinks the coverage denominator, which inflates pct for free); a corpus section that is
nullon master is an ungated first landing.provisional: truein the baseline keeps the gate report-only regardless of enforcement — the committed baseline is currently provisional with both corpus sections unseeded.scripts/update-coverage-baseline.ts --summary <json> --corpus <c> [--promote]writes the working-tree baseline (per-file detail limited to the baseline'swatchlist);--promoteflipsprovisional: falseat graduation.
CI wiring. The 13 PR lanes upload coverage-* artifacts; the advisory
coverage-report job downloads + merges (COVERAGE_CORPUS=prCorpus), renders
scripts/render-coverage-summary.ts to the step summary (including the
behavioral-vs-structural counts from scripts/structural-suites.tsv), and
runs both gates with COVERAGE_GATE_ENFORCE: '0'. It is deliberately NOT in
test-status or cache-write needs — it cannot block a PR until graduation.
Bun caveats. Bun/JSC emits line records only, so function coverage is
informational (no reliable function names). There is NO subprocess coverage:
code exercised only through spawned CLI subprocesses undercounts — src/cli.ts
carries a permanent [subprocess-undercount] exemption for this. A src file
never imported by any test produces no lcov record at all; the summary reports
these as a count + sorted list, deliberately never a percentage (physical
lines ≠ executable lines), and the diff gate treats a changed-but-never-loaded
file as a violation.
One-command local smoke (one shard of ten, so totals reflect a tenth of the corpus — this checks the plumbing, not the number):
COVERAGE_DIR=$PWD/.coverage bash scripts/test-shard.sh 1 10 \
&& bun scripts/merge-lcov.ts --out-lcov .coverage/merged.lcov --out-json .coverage/summary.json .coverage \
&& bun scripts/render-coverage-summary.ts --summary .coverage/summary.json
Optional flags: coverage-diff-gate.ts --base <ref> overrides the diff base
(default origin/master); render-coverage-summary.ts --structural scripts/structural-suites.tsv adds the behavioral-vs-structural split to the
rendered summary (both CI lanes pass it); classify-tests.ts --summary prints
counts only.
Failure-first logging
When bun run test finds any failure, the wrapper:
- Writes failure blocks (each prefixed with
--- shard N: <test name> ---) to.context/test-failures.log(workspace-local, gitignored). On systems without a writable.context/, falls back to/tmp/gbrain-test-failures.log. - Prints a loud stderr banner with the absolute log path, plus the last 30 lines of the failure log inlined. Banner survives
| head/| tail/ agent-side log truncation. - Writes a one-line-per-shard summary to
.context/test-summary.txt(shard N/M: pass=X fail=Y skip=Z rc=W). - Exits non-zero. Empty failure log + non-zero exit = infrastructure problem (wedged shard, killed child); the banner says so.
If a shard hits the per-shard GBRAIN_TEST_SHARD_TIMEOUT cap (default 3000s — sized so the heaviest count-balanced shard finishes under 4-way contention; GBRAIN_TEST_SHARD_KILL_AFTER sets the grace after TERM before KILL, default 30s), the wrapper classifies the kill one of two ways:
- EXIT-HANG → warn-pass. If the shard's log had been silent for ≥300s at kill time AND shows zero
(fail)markers, the shard finished all its work, leaked a handle, and never exited (a pre-existing, master-reproducible PGLite-adjacent leak — see TODOS.md "unit-shard exit hang"). The wrapper prints a⚠️ shard N/M: EXIT-HANG ... Treating as pass-with-warningbanner, writesEXIT-HANG (idle Ns, 0 fails) ... warn-passto the summary, and does NOT fail the run. Its pass counts are undercounted (bun never printed its final summary). Bun's per-test--timeoutturns a genuinely hung TEST into a printed(fail)— new output — so this classification cannot mask a hung test; the residual maskable case is a file-level import hang in the very last file, which the banner keeps visible. - WEDGED → hard failure. Anything else (failures present, or the log was still growing) writes
--- shard N: WEDGED after ${SHARD_TIMEOUT}s ---to the failure log with the last 50 lines of the shard log, marks the run failed, and proceeds with other shards' results.
Triage rule: a warn-pass EXIT-HANG line in .context/test-summary.txt is NOT a test failure — don't burn time bisecting it; a WEDGED line is.
File taxonomy
*.test.ts→ fast loop (parallel up-to-4-shard fan-out, memory-adaptive).*.slow.test.ts→ run viabun run test:slowonly (intentional cold-path tests; would dominate the fast loop's wallclock).*.serial.test.ts→ run viabun run test:serialafter the parallel pass completes; one bun process per file (--max-concurrency=1within a shared process is not enough — the module registry still leaksmock.module), with those per-file processes POOLED (per-process isolation never required one-at-a-time execution). Files touching machine-global state (launchd/cron) live on the sequentialEXCLUSIVE_FILESlane insidescripts/run-serial-tests.sh— growth-guarded to ≤3 entries with justification comments. Quarantine for tests that share file-wide state and race when run alongside other files in the samebun testprocess. Several dozen files, discovered by the*.serial.test.tsglob — no list to maintain. Typical residents:mock.module(...)users (top-level mocks leak across files in a shard process, e.g.test/embed.serial.test.ts), env-coupled files (e.g.test/brain-registry.serial.test.ts), and process-lifecycle suites that assert onprocess.exitCode(e.g.test/pglite-engine-disconnect.serial.test.ts). Do not put the parallelism back on a serial file unless you've fixed the contention root cause (it just re-introduces the flake).test/e2e/*.test.ts→ real-Postgres E2E. Skipped whenDATABASE_URLis unset. One out-of-directory file rides this lane:test/phantom-redirect-engine-parity.test.ts(lives intest/for its PGLite arm, but its Postgres arm is only reachable through a DATABASE_URL-bearing lane — the unit wrappers strip the URL per #3485, sorun-e2e.sh's no-args list and CI's parity job carry it).run-e2e.shwraps each file in a hard outer timeout (default 180s;GBRAIN_E2E_FILE_TIMEOUT=<seconds>overrides) because a synchronously-blocking PGLite WASM call can outlive bun's timer-based--timeout; LLM-bound Tier-2 files (skills.test.ts,zeroentropy-live.test.ts) automatically get 4× the cap since real provider round-trips legitimately run past 180s.tests/heavy/*.sh→ ops-shape shell scripts. Cost minutes per run; NOT in defaultbun test. Run viabun run test:heavyor scheduled nightly via.github/workflows/heavy-tests.yml. Examples: pg_upgrade matrix (boot legacy brain → walk to head), RSS budget gate (measure peak worker RSS vs committed baseline), read-latency-under-sync (p50/p95/p99 under concurrent writer load), sync lock regression (N concurrent syncs assert 1 winner + N-1 lock-busy + zero leakedgbrain_cycle_locksrows). Seetests/heavy/README.mdfor when to add a script here vs*.slow.test.ts. Files prefixed with_(e.g.tests/heavy/_build_legacy_fixtures.sh) are helpers/libs invoked by sibling tests — the runner skips them.test/fuzz/*.test.ts→ property-based fuzz harness. Pure-validator targets inpure-validators.test.tsare guarded byscripts/check-fuzz-purity.sh(inbun run verify), whichbun build --target=bunbundles each target and greps the resulting bundle for banned transitive imports (node:fs,node:child_process, engine modules). Anything that fails the guard moves tomixed-validators.test.ts(still property-tested, but no purity guarantee) orfilesystem-validators.test.ts(fs-backed, uses temp dirs). Fuzz tests run in the defaultbun testloop because they're fast (~3s for ~12 properties × 1000 runs each).
The taxonomy above is LANE-based (where a test runs). A second, orthogonal axis is INTENT:
- Behavioral tests execute product code and assert on behavior — the default.
- Structural (source-shape) suites read repo source/doc TEXT and assert on its shape (wiring guards, drift pins,
doctorSource()consumers). They are real invariants but execute no product paths, so they inflate the headline test count without adding line coverage. The committed inventory isscripts/structural-suites.tsv, generated byscripts/classify-tests.ts(suite-level, content-based detectors: repo-anchoredreadFileSync/Bun.filereaders, grep-style exec scanners, the doctor-source helpers) and freshness-checked inbun run verify(check:structural-manifest— regenerate withbun scripts/classify-tests.tswhen suites change shape). The inventory is approximate by design; fix misclassifications in the classifier's detector list, never by hand-editing the TSV. CI's coverage report renders behavioral vs structural counts side by side.
Guards that pin doctor source text read it through test/helpers/doctor-source.ts (doctorSource() = the façade + every src/commands/doctor/** module, for containment assertions; doctorFileSource(rel) = one named file, for positional/ordering assertions) so peeling doctor.ts into modules can't silently move a pinned string out of a guard's sight.
TTY and interactive-CLI testing
Four escalating tools; reach for the cheapest one that answers the question:
| Question | Tool | Example |
|---|---|---|
| Does the TTY/non-TTY branch logic pick right? | Inject isTTY into the pure function — no subprocess | test/init-provider-picker.test.ts, test/jobs-watch-mode.test.ts |
| Does the real CLI behave right when stdin is NOT a terminal? | Spawn the CLI with piped/ignored stdio | test/cli-stdin-hang.test.ts (fast loop); test/e2e/init-fresh-pglite.test.ts (manual test:e2e lane — see the TODOS e2e CI-lane entry) |
| Does the real CLI render menus and read typed input under a REAL terminal? | launchTty from test/helpers/tty-harness.ts in a *.serial.test.ts file | test/init-picker-pty.serial.test.ts |
| How does the install FEEL (stalls, copy, silence windows)? | scripts/dx-explore.ts — instrument, not a test; nothing asserts | transcripts under .context/dx-runs/ (see docs/guides/bootstrap.md) |
Real-PTY test rules: put the file in the serial lane (*.serial.test.ts — that
lane runs in required CI; a new test/e2e/* file does NOT, since unit shards
exclude the directory and the e2e workflow runs only explicitly named files,
no glob);
assert NON-default picker values (bare Enter and each prompt's 60s
readLineSafe timeout both resolve to the default, so a defaults-asserting
test passes with dead input); always await session.close() in a finally
(only close() clears the harness wall timer); and point HOME plus
GBRAIN_HOME at a temp root with pass-through auth keys stripped via
dropEnv so picker state is machine-independent.
Skills-manifest freshness guard
skills/skills.lock.json is a committed sha256 inventory of every bundled file under
skills/ (tamper evidence, not signatures — see src/core/skills-integrity.ts).
Any change under skills/ must regenerate it: bun run scripts/generate-skills-manifest.ts.
scripts/check-skills-manifest-fresh.sh (bun run check:skills-manifest, wired into
bun run verify) regenerates to a tmp file and diffs, failing CI on drift; at runtime
gbrain doctor reports the same drift as a warn-only skills_manifest_integrity check.
Test-isolation lint and helpers
This section is the canonical home of the test-isolation discipline — CONTRIBUTING.md and other docs link here rather than restating the rules.
The cross-file flake class is enforced statically by scripts/check-test-isolation.sh, wired into bun run verify. Rules (non-serial unit files only; *.serial.test.ts and test/e2e/* are skipped):
| Rule | What it bans | Fix |
|---|---|---|
| R1 | process.env.X = ..., bracket assignment, delete process.env.X, Object.assign(process.env, ...), Reflect.set(process.env, ...) | Use withEnv() from test/helpers/with-env.ts, OR rename file to *.serial.test.ts |
| R2 | mock.module(...) anywhere in the file | Rename file to *.serial.test.ts (no DI on production code for testability) |
| R3 | new PGLiteEngine( outside ~50 lines after a beforeAll( line | Use the canonical block (below) inside beforeAll( |
| R4 | Files creating new PGLiteEngine( without engine.disconnect( inside an afterAll( block | Add afterAll(() => engine.disconnect()) |
Files that violated these rules at the isolation-lint baseline are listed in scripts/check-test-isolation.allowlist. The allow-list MUST shrink over time — never add new entries.
Canonical PGLite block (R3 + R4 compliant)
Every test file that needs a PGLite engine should use this exact pattern:
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { resetPgliteState } from './helpers/reset-pglite.ts';
let engine: PGLiteEngine;
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({});
await engine.initSchema();
});
afterAll(async () => {
await engine.disconnect();
});
beforeEach(async () => {
await resetPgliteState(engine);
});
Why this exact shape: beforeAll creates a single engine per file (PGLite WASM cold-start + initSchema is ~20s); beforeEach truncates user data via resetPgliteState ("two orders of magnitude faster" than fresh-engine-per-test); afterAll disconnects so the engine doesn't leak across file boundaries within a shard process.
withEnv pattern (R1 fix)
import { withEnv } from './helpers/with-env.ts';
test('reads OPENAI_API_KEY', async () => {
await withEnv({ OPENAI_API_KEY: 'sk-test' }, async () => {
expect(loadConfig().openai_key).toBe('sk-test');
});
});
// Delete a var (override is undefined):
await withEnv({ GBRAIN_HOME: undefined }, fn);
// Multiple keys:
await withEnv({ A: '1', B: '2', C: undefined }, fn);
withEnv saves the prior value of every key it touches and restores via try/finally — including when the callback throws. It is cross-test safe but NOT intra-file concurrent-safe. process.env is process-global; two test.concurrent() calls in the same file both touching the same key will race. Files using withEnv stay outside the test.concurrent() codemod's eligibility filter.
When to quarantine instead of fix
Rename to *.serial.test.ts when:
- The file uses
mock.module(...)(R2 — there's no clean fix without changing production code). - The file is genuinely env-coupled (e.g.
gbrain-home-isolation.test.ts,claw-test-cli.test.ts) — module-load env readers + ESM caching defeat dynamic-import-after-env tricks. - The file's tests intentionally share state across
it()boundaries.
The quarantine has grown to dozens of files — treat it as debt: every addition needs a reason from the list above, and prefer fixing the contention root cause when one exists.
Unit test inventory
bun test runs all tests without a database. E2E tests skip gracefully when DATABASE_URL is not set.
GBRAIN_HOME isolation preload. test/helpers/gbrain-home-preload.ts (bunfig
[test] preload) points GBRAIN_HOME at a per-run scratch dir when it isn't
already set, so unit tests never read — or clobber — the operator's real
~/.gbrain config/brain. Without it, any config-honoring code path silently
changes behavior with whatever the live config.json says (observed: 27
cycle/autopilot/dream tests flipped red the moment a sibling workspace's run
rewrote the real config, while the identical commit stayed green in CI). The
canonical GBRAIN_HOME convention is config.ts:configDir(): GBRAIN_HOME is a
PARENT dir and .gbrain is appended. Subprocess-spawning tests must set BOTH
HOME: tmp and GBRAIN_HOME: tmp in the child env (HOME alone loses to the
inherited preload value; in-process HOME mutation loses to Bun's cached
os.homedir()). The e2e wrapper sets its own GBRAIN_HOME before bun starts,
which this preload respects. Because the preload respects a pre-set value, the
unit/slow wrappers (run-unit-parallel.sh / run-unit-shard.sh /
run-slow-tests.sh) strip an ambient GBRAIN_HOME at their boundary — same
discipline as the database-URL vars — so a dev shell configured for a real
brain can't ride through. GBRAIN_DEBUG_PRELOAD=1 prints the allocated
scratch home for debugging.
Provider-key strip preload. test/helpers/provider-keys-preload.ts (bunfig
[test] preload) strips the ambient provider credentials the canonical fold
recognizes (ANTHROPIC_API_KEY, OPENAI_API_KEY, Gemini/Google, Voyage,
OpenRouter, ZeroEntropy, DashScope, and the Azure OpenAI endpoint fields) and
defaults GBRAIN_MODEL_DISCOVERY=off (respecting an explicit operator
override), so key-aware model routing (resolveTierDefault) resolves
identically to keyless CI and latest-model discovery never makes a real
network call from a test. Without it, a chat key exported in the dev shell
flips default-model assertions AND turns gated paths into live provider calls
(observed: 183 unit failures + 15-minute retry hangs on an
OPENAI_API_KEY-exporting shell). Tests that want keys inject them explicitly
(configureGateway({env}), withEnv, serial-file process.env) — the
preload removes ambient shell state only, before any test file loads. The e2e
wrapper (scripts/run-e2e.sh) opts back in at its boundary via
GBRAIN_TEST_KEEP_PROVIDER_KEYS=1 — e2e is the lane where real keys are
deliberate (live embed/parity tests skip-gate on them).
Database-URL run guard (#3485). A bun test invocation REFUSES to start while
DATABASE_URL or GBRAIN_DATABASE_URL is ambient in the environment, because some
tests run destructive SQL against whatever those URLs point at (a bare bun test
with ~/.gbrain/.env sourced has wiped a real brain). The guard is a bunfig
[test] preload (test/helpers/database-url-guard-preload.ts); it hard-fails with
instructions rather than silently unsetting (a silent unset would turn
DATABASE_URL-gated e2e tests into green skips). The e2e wrappers
(scripts/run-e2e.sh, the e2e/heavy workflows) opt in at their own boundary via
GBRAIN_TEST_ALLOW_DATABASE_URL=1; the unit/slow wrappers instead strip both
URL vars at their boundary (unit tests need no database), which keeps
bun run test:full working with DATABASE_URL exported. Caveat: bun loads
bunfig.toml from the invocation cwd, so the preload layer only applies to
runs started at the repo root — the per-file name floor below is the layer
that doesn't care about cwd. Two more layers apply after the opt-in: every
test that runs destructive SQL on the ambient URL must call
assertSafeE2eDatabaseUrl() (test/helpers/db-guard.ts — name floor: the database
name must contain "test" as a segment, or be opted in via GBRAIN_E2E_ALLOW_DB)
or carry an inline name floor the coverage gate recognizes
(test/e2e/schema-drift.test.ts keeps its own looksLikeTestDb, deliberately
different because it also accepts *_e2e), and test/db-guard-coverage.test.ts
statically scans the suite and fails when a file connects to DATABASE_URL and
runs destructive SQL unguarded. The heavy shell lane gets the same floor outside
bun: tests/heavy/_db_floor.sh (sourced by scripts/run-heavy.sh for the whole
lane, and by each database-touching heavy script itself, since scripts are
documented for direct invocation — the PGLite-based heavy scripts unset the URL
instead) checks BOTH URL variables and strips query strings before extracting
the database name, so a ?host=/tmp/test-sockets parameter can't smuggle a
test-shaped segment past it.
Unit tests and what they cover:
test/markdown.test.ts— frontmatter parsing;splitBodysentinel precedence, horizontal-rule preservation,inferTypewiki subtypes.test/chunkers/recursive.test.ts— chunking.test/parity.test.ts— operations contract parity.test/cli.test.ts— CLI structure.test/cli-finish-teardown.test.ts— the #2084 teardown contract:computeTeardownDeadlineMsformula/floor/live-registry scaling +GBRAIN_TEARDOWN_DEADLINE_MSoverride (garbage/zero/negative values fall back to the formula);finishCliTeardownclean path (drain BEFORE disconnect, no exit, no warn), backstop on hung drain or disconnect (honors an errored op's exit code), throwing drain/disconnect warned + swallowed; the gbrain-owned verdict channel is immune to PGLite WASMprocess.exitCodewrites;flushThenExitunit coverage with mocked streams (exits once after both stream callbacks, non-TTY aliveness grace, blocked-pipe guard, EPIPE-safe,GBRAIN_FLUSH_GRACE_MSoverride).test/flush-then-exit-harness.test.ts— real spawned-Bun pipe semantics forflushThenExit(fixture:test/fixtures/flush-then-exit-harness.ts): a 4MB piped stdout payload arrives byte-complete with the exit code even with a late reader, small output survives exit with a concurrent reader, and the fence resolves promptly (wall time well under the guard + grace ceiling).test/cli-should-force-exit.test.ts—shouldForceExitAfterMaindaemon-survival gate:serve(stdio and--http) never force-exits, including with preceding global flags; op commands / empty / flag-only argv do; the #2084 case that space-separated global-flag VALUES can't fake a command (--timeout 30s serveresolves to theservedaemon, not a30scommand).test/cli-exit-verdict-pin.test.ts— #2084 structural class pin: grepssrc/so the NEXT rawprocess.exitCode =write fails CI (a raw write bypasses the gbrain-owned verdict channel and gets silently zeroed by the deliberate flush-exit — the bug that made doctor's FAIL path exit 0). Runtime variants live intest/cli-finish-teardown.test.ts; this is the review-time guard.test/cli-pipe-truncation.test.ts— real-CLI pipe completeness (the #1959 incident class), implementation-agnostic: the actual CLI run the way agents run it (piped stdout) produces complete, parseable, byte-stable--tools-jsonoutput and exits deliberately, well under the teardown backstop. Synthetic flush-mechanism coverage stays intest/flush-then-exit-harness.test.ts.test/volunteer-context.test.ts— push-based context core (#2095), hermetic in-memory PGLite:parseWindowlenientuser:/assistant:parsing, multi-turn window extraction, confidence-gated volunteering (arm confidences, multi-turn/newest-turn boosts,min_confidencegate, max-pages cap), slug-only suppression, privacy (rationales are deterministic templates; synopses pass the takes/facts fence), and the approximate usage-stats join.test/watch-command.test.ts—gbrain watchpush transport (#2095): streaming loop, rolling window, session dedupe,--jsonJSONL shape,channel: 'watch'event logging, clean EOF return. Hermetic PGLite + injected line/write deps (no subprocess, no real stdin).test/watch-sigint.serial.test.ts—gbrain watchSIGINT lifecycle against a real spawned CLI subprocess with a tmpdir brain. SERIAL: parallel unit shards flake on concurrent subprocess spawns (same rationale asapply-migrations-pglite-spawn.serial.test.ts).test/init-picker-pty.serial.test.ts— the interactivegbrain initpickers (embedding-provider + search-mode) driven under a REAL pseudo-terminal vialaunchTty: typed input lands (a NON-default mode choice verified by a follow-up non-TTY config read — bare Enter and thereadLineSafetimeout both resolve to defaults, so a defaults-asserting test would pass with dead input), prompt-to-acknowledgement gaps bounded well under the fallback window, plus the Ctrl-D/EOF keyless fallback. On CI, missing PTY support fails loud instead of skipping. Hermetic: HOME + GBRAIN_HOME at a temp root, pass-through auth keys stripped viadropEnv;session.close()infinally. Serial: PTY spawn + full PGLite bootstrap, and the serial lane is what runs in required CI.test/tty-harness.test.ts— the real-PTY harness's pure helpers (stripAnsi,computeStalls,renderStallsReport,parseDriveCommand,buildClaudeTuiSeed) with zero subprocesses; the file's live-PTY smokes aredescribe.skipIf(!ptySupported())-gated.test/autopilot-launchd-lifecycle.serial.test.ts— autopilot lifecycle behavior, not generated-string assertions: the full install → self-disable → status → reinstall → uninstall arc withlaunchctlreplaced by an argv recorder and the generated wrapper executed by a REAL bash against a genuinely deleted repo (every platform), plus a darwin-only fail-SKIP describe against the real launchd under a per-run unique label (GBRAIN_AUTOPILOT_LABEL) so it can never collide with — or tear down — a real install on the host. Serial: spawns subprocesses and pins HOME/GBRAIN_HOME for the whole file.test/autopilot-fanout.test.ts— Autopilot fan-out and #4046 policy regression: targeted idempotency keys reopen per dispatch interval while stable doctor/remediate keys remain unchanged; the 60-minute full-cycle floor wins with a remaining small plan, and an all-fresh restart check advances the process-local clock without masking failed stale-source submissions.test/agent-scheduler-contract.serial.test.ts— the documented external agent-scheduler shell chain (gbrain sync --repo X && gbrain embed --stale, live-sync.md / INSTALL_FOR_AGENTS.md Step 7) driven end-to-end through a real/bin/shagainst a keyless PGLite brain: the&&short-circuit IS the contract (argv arrays can't exercise it), the keyless bare stale embed exits 0, and the pull-failure case that must break the chain does. Anti-vacuity: the fixture commits a real page and every read-back asserts pages >= 1. Serial: real spawned CLI + tmpdir HOME.test/cli-format-volunteer.test.ts—formatResult'svolunteer_contexthuman rendering: pointer lines with confidence/arm/rationale, the empty-result message, the approximate stats summary.test/config.test.ts— config redaction.test/files.test.ts— MIME/hash.test/import-file.test.ts— import pipeline.test/upgrade.test.ts— schema migrations.test/file-migration.test.ts— file migration.test/file-resolver.test.ts— file resolution.test/import-resume.test.ts— import checkpoints.test/migrate.test.ts— migration: v8/v9 helper-btree-index SQL structural assertions; 1000-row wall-clock fixtures guarding the O(n²)→O(n log n) fix; v12/v13 SQL shape;sqlFor+transaction:falserunner semantics; themax_stalled DEFAULT 1regression guard; v24sqlFor.pglite: ''no-op assertion; v117context_volunteer_events(named + idempotent entry, documented columns + both source-scoped indexes afterinitSchema, insert + 90-daypurgeStaleVolunteerEventsround-trip).test/bootstrap.test.ts— bootstrap contract: no-op on fresh install, idempotent across twoinitSchema()calls, no-op on modern brain that already has every probed column, full bootstrap path on a simulated legacy brain, fresh-install regression guard, legacylinksshape coverage.test/schema-bootstrap-coverage.test.ts— CI guard.REQUIRED_BOOTSTRAP_COVERAGElists every forward reference inPGLITE_SCHEMA_SQL; the test fails loudly ifapplyForwardReferenceBootstrapskips one (extend both arrays when adding a column-with-index to the embedded schema blob). Also parsessrc/core/migrate.tssource text for everyALTER TABLE ... ADD COLUMN(top-levelsql:,sqlFor.{postgres,pglite}overrides, AND handler-bodyengine.runMigration(N, \ALTER TABLE ...`)) and asserts each (table, column) pair is covered by the bootstrap OR by the schema blob's CREATE TABLE bodies — catching the column-only forward-reference class (e.g.sources.archived,oauth_clients.source_id) that a CREATE INDEX parser alone can't see.parseBaseTableColumns` strips SQL line + block comments before identifying column names so commented-out lines don't hide adjacent columns.test/helpers/schema-diff.ts+test/helpers/schema-diff.test.ts+test/e2e/schema-drift.test.ts— cross-engine schema parity gate. Helper exports puresnapshotSchema(query)/diffSnapshots(pg, pglite, opts)/formatDiffForFailure(diff)/isCleanDiff(diff)over a four-tuple per column (data_type,udt_name,is_nullable,column_default). E2E test spins up fresh PGLite + Postgres, runsengine.initSchema()on each, snapshotsinformation_schema.columns, then diffs. 2-table allowlist (files,file_migration_ledger) — every other Postgres table must reach PGLite viaPGLITE_SCHEMA_SQLor a migration'ssqlFor.pglitebranch. Sentinels foroauth_clients,mcp_request_log,access_tokens,eval_candidatesgive tighter blame messages. Skips withoutDATABASE_URL. Wired intoscripts/e2e-test-map.tsso changes tosrc/schema.sql,src/core/pglite-schema.ts, orsrc/core/migrate.tstrigger it. The failure message names every drift with a paste-ready hint pointing atsrc/core/pglite-schema.ts.test/setup-branching.test.ts— setup flow.test/slug-validation.test.ts— slug validation.test/storage.test.ts— storage backends.test/supabase-admin.test.ts— Supabase admin.test/yaml-lite.test.ts— YAML parsing.test/check-update.test.ts— version check + update CLI.test/pglite-engine.test.ts— PGLite engine, all BrainEngine methods includingaddLinksBatch/addTimelineEntriesBatch(empty batch, missing optionals, within-batch dedup via ON CONFLICT, missing-slug rows dropped by JOIN, half-existing batch, batch of 100) plusconnect()error-wrap assertion (original error nested, #223 link in message, lock released).test/links-timeline-jsonb-poison.test.ts— gbrain#1861 PGLite half (always-on, noDATABASE_URL). Locks thejsonb_to_recordsetbatch-insert path for links/timeline/takes against free-text "poison" payloads (commas, quotes, backslashes, braces, em-dashes) and asserts NUL is stripped from free-text body fields but rejected in identity fields. gbrain#2011 adds lone-UTF-16-surrogate cases: every free-text field (link context; timeline summary/detail/source; take claim/source) well-forms to U+FFFD across batch + scalar write paths, while a surrogate in an identity field (slug) still fail-closed rejects the batch. The Postgres lane (test/e2e/jsonb-batch-poison-postgres.test.ts) is the one that actually reproduced the original crash.test/engine-factory.test.ts— engine factory + dynamic imports.test/integrations.test.ts— recipe parsing, CLI routing, recipe validation.test/publish.test.ts— content stripping, encryption, password generation, HTML output.test/backlinks.test.ts— entity extraction, back-link detection, timeline entry generation.test/lint.test.ts— LLM artifact detection, code fence stripping, frontmatter validation.test/report.test.ts— report format, directory structure.test/skills-conformance.test.ts— skill frontmatter + required sections validation.test/resolver.test.ts— RESOLVER.md coverage, routing validation; round-trip that every quoted RESOLVER.md trigger matches a frontmattertriggers:entry in the target skill, and everyname="<word>"reference in any SKILL.md resolves to a declared op insrc/core/operations.tsor a Minions handler inPROTECTED_JOB_NAMES.test/search.test.ts— RRF normalization, compiled truth boost, cosine similarity, dedup key.test/sql-ranking.test.ts— source-boost helpers: longest-prefix-match in SQL CASE,detail=hightemporal-bypass, three-meta-char LIKE escape (%,_,\), single-quote SQL-literal doubling, env override parsing forGBRAIN_SOURCE_BOOST+GBRAIN_SEARCH_EXCLUDE,resolveBoostMap/resolveHardExcludesmerge semantics.test/dedup.test.ts— source-aware dedup, compiled truth guarantee, layer interactions.test/query-intent-legacy.test.ts— query intent classification: entity/temporal/event/general (pre-concept behavior pins).test/query-intent-concept.test.ts— theconceptintent: definitional/landscape cue detection, the proper-noun / quoted-phrase / sub-3-word guards, vector-lean weight routing.test/eval.test.ts— retrieval metrics:precisionAtK,recallAtK,mrr,ndcgAtK,parseQrels.test/brainbench-fixtures.test.ts/test/brainbench-generator.test.ts/test/brainbench-metrics.test.ts/test/brainbench-continuity.test.ts/test/brainbench-writeback.test.ts/test/brainbench-adapters.test.ts/test/brainbench-scoreboard.test.ts— the BrainBench memory-conformance unit suites (src/eval/brainbench/): fixture loader/validator + the sealed-gold seal (agoldkey inside a fixture must reject) and committed-corpus integrity; generator determinism (the committed corpus is exactly whatgen.tsproduces, holdout discipline, category counts); metric formulas over hand-built turn rows (zero should-retrieve turns, empty injections, acceptable-vs-gold asymmetry, micro-averaging); cross-harness continuity (writer's decision persists through the production write-back pipeline, reader recalls on the SAME brain); write-back grading the PRODUCTION conversation→facts pipeline via the injected gold extractor; adapter seam contracts over hermetic PGLite (budget caps, suppression modes); scoreboard + gate governance (baseline determinism, count-aware gating, corpus-bless modes, justification flow, isolation gates-at-zero).test/brainbench-floors.test.ts— the pre-registered quality floors as executable assertions against the committed baseline (a baseline bless can't bank a threshold violation).test/eval-brainbench-e2e.test.ts— BrainBench CLI end-to-end via subprocess against a small tmp corpus: the literal exit codes (0 pass / 1 regression / 2 error-or-inconclusive — the CI product),--outartifact validity incl._meta.metric_glossary, byte-deterministic--update-baseline, anti-vacuous-pass, and theeval run-allin-process wiring.test/check-resolvable.test.ts— resolver reachability, MECE overlap, gap detection, proximity-based DRY detection,extractDelegationTargetscoverage.test/dry-fix.test.ts— auto-fix: three shape-aware expander pure-function tests; five guards (working-tree-dirty, no-git-backup, inside-code-fence, already-delegated within 40 lines, ambiguous-multi-match, block-is-callout).test/doctor-fix.test.ts—gbrain doctor --fixCLI integration: dry-run preview, apply path, JSON output shape.test/backoff.test.ts— load-aware throttling, concurrency limits, active hours.test/fail-improve.test.ts— deterministic/LLM cascade, JSONL logging, test generation, rotation.test/transcription.test.ts— provider detection, format validation, API key errors.test/enrichment-service.test.ts— entity slugification, extraction, tier escalation.test/data-research.test.ts— recipe validation, MRR/ARR extraction, dedup, tracker parsing, HTML stripping.test/minions.test.ts— Minions job queue: CRUD, state machine, backoff, stall detection, dependencies, worker lifecycle, lock management, claim mechanics, depth/child-cap, timeouts, cascade kill, idempotency,child_doneinbox, attachments, removeOnComplete/Fail,max_stalledclamp/default/plumbing coverage.test/minion-queue-renewlock-signal.test.ts—renewLockforwards its optional AbortSignal toexecuteRawDirect(stub-engine capture); legacy 3-arg calls unchanged; token-fence miss returns false.test/cycle-drain-renewal.test.ts—runDrainRenewalTick(cycle drain): per-call signal aborted on timeout (slot released), onLost once on a lost fence, throws swallowed, hung renewal resolves at the deadline.test/queue-probe-cancellation.test.ts—probeQueueState/queryWedgeSignalssignal threading: the 1500ms budget CANCELS the losing probe query; fast-path signals never abort; throw still collapses to{probe_failed: true}.test/db-pool-max-lifetime.test.ts—resolveMaxLifetimeSeconds: env forms, 0-disables, 30–60min jitter bounds, warn-once on invalid, per-call jitter variance.test/pool-gauge.test.ts—CheckoutGaugepure semantics + the PostgresEngine seams with fake pools: counted while in flight, released on resolve, on REJECTED queries, and on the SYNCHRONOUS pre-aborted-signal throw (leak guards);getPoolDiagnosticsfail-open.test/db-probe.test.ts—runDbProbeverdict matrix (pool_starved / server_unreachable / unknown), honest-disjunction + no-waiter-arithmetic wording pins, hung probes cancelled via their signals, diagnostics absent/throwing fail open.test/postgres-engine-reserved-routing.test.ts—withReservedConnectionrouting: direct pool when dual-pool active, read pool when kill-switched/in-tx, semaphore cap (directPoolSize−1) with read-pool overflow, permit released on fn throw and reserve failure.test/job-isolation-protocol.test.ts— outcome-file codec round-trip + every decode failure path (missing/malformed/oversize→UnrecoverableError; byte counts, never content), handler-error instanceof reconstruction, child-CLI invocation resolution, and REAL detached-processkillProcessGrouptests incl. the grandchild-death guarantee (exercises the Bun negative-pid/bin/killfallback for real underbun test).test/run-child-entry.test.ts—runChildJobEntryon real in-memory PGLite with a REAL claim-minted token: success (fenced updateProgress lands), handler-failure outcome (exit 0), token-mismatch never runs the handler (exit 14), missing job/handler, parent-death watchdog aborts a live handler.test/child-job-runner.test.ts—runJobInChildagainst real .mjs children: success + full env contract (incl.GBRAIN_DIRECT_POOL_SIZE=1), error/lease outcome reconstruction, crash, SIGTERM-ignorer → group SIGKILL at the injected grace, pre-aborted signal, spawn ENOENT →ChildSpawnInfraError, worker-shutdown drain (report-during-drain completes; non-reporting kill →ChildWorkerShutdownError).test/worker-job-isolation.test.ts— full parent path on PGLite with thefake-run-child.mjsfixture: claim → child → fenced completeJob (real token over env), error outcome → failJob, crash burns the attempt, spawn failure RELEASES with zero attempts burned, and the codex-2 #8 serialization-parity pin (unreportable results fail in BOTH modes, never falsely complete).test/jobs-isolation-flag.test.ts—parseJobIsolationFlag: space/= forms, env fallback + flag-wins, empty-env default, other flags untouched.test/extract.test.ts— link extraction, timeline extraction, frontmatter parsing, directory type inference.test/extract-db.test.ts—gbrain extract --source db: typed link inference, idempotency,--typefilter,--dry-runJSON output.test/extract-fs.test.ts—gbrain extract --source fs: first-run inserts + second-run reports zero, dry-run dedups candidates across files, second-run perf regression guard for the N+1 dedup bug.test/link-extraction.test.ts— canonicalextractEntityRefsboth formats,extractPageLinksdedup,inferLinkTypeheuristics,parseTimelineEntriesdate variants,isAutoLinkEnabledconfig.test/graph-query.test.ts— direction in/out/both, type filter, indented tree output.test/features.test.ts— feature scanning, brain_score calculation, CLI routing, persistence.test/file-upload-security.test.ts— symlink traversal, cwd confinement, slug + filename allowlists, remote vs local trust.test/query-sanitization.test.ts— prompt-injection stripping, output sanitization, structural boundary.test/search-limit.test.ts—clampSearchLimitdefault/cap behavior acrosslist_pagesandget_ingest_log.test/repair-jsonb.test.ts— JSONB repair: TARGETS list, idempotency, engine-awareness.test/migrations-v0_12_2.test.ts— JSONB-repair orchestrator phases: schema → repair → verify → record.test/orphans.test.ts— orphans command: detection, pseudo filtering, text/json/count outputs, MCP op.test/postgres-engine.test.ts—statement_timeoutscoping:sql.begin+SET LOCALshape, source-level grep guardrail against a reintroduced bareSET statement_timeout.test/sync.test.ts— sync logic + regression guard asserting top-levelengine.transactionis not called.test/sync-pull-failed-anchor.serial.test.ts— #3068 regression: a failed internalgit pull(local-path origin vsprotocol.file.allow=never) with zero imports returnspartial/pull_failed(notup_to_date), freezeslast_commit+last_sync_at, recovers after a manual pull; fall-through import of local commits preserved. Serial: pinsGBRAIN_HOMEto a temp dir for the whole file.test/sync-concurrency.test.ts—autoConcurrency()thresholds + PGLite-forces-serial + explicit-override clamping;shouldRunParallel()explicit-bypasses-floor contract;parseWorkers()validation rejecting'0'/'-3'/'foo'/'1.5'/trailing chars.test/sync-parallel.test.ts— PGLite-routed coverage of the bookmark gate under concurrency, head-drift gate, vanished-file failure capture, PGLite-stays-serial, and thegbrain-syncwriter-lock contract.test/sync-all-missing-path.test.ts—sync --all --missing-path <fail|skip>pure helpers:parseMissingPathMode(default fail, explicit values, loud rejection of bad/dangling values, never swallows a following flag) andpartitionMissingPathSources(classification driven only by the injected pathExists predicate — no fs; nulllocal_pathpasses through runnable; order preserved).test/sync-failures.test.ts—classifyErrorCoderegex coverage for all 12 codes against literal production message strings frommarkdown.tsandimport-file.ts;summarizeFailuresByCodesort + pre-classified-honor;recordSyncFailurescode-field persistence;acknowledgeSyncFailuresAcknowledgeResultshape + backfill on legacy entries.test/doctor.test.ts— doctor command; assertions thatjsonb_integrityscans the four JSONB write sites andmarkdown_body_completenessis present.test/utils.test.ts— shared SQL utilities +tryParseEmbeddingnull-return and single-warn semantics.test/build-llms.test.ts—llms.txt/llms-full.txtgenerator: path resolution, idempotence, spec shape, regen-drift guard, content contract, AGENTS.md install-path mirror, size-budget enforcement.test/oauth.test.ts— OAuth 2.1 provider: register, getClient,client_credentialsgrant exchange,authorization_codeflow with PKCE challenge/verifier, refresh token rotation,verifyAccessTokenwith both OAuth + legacyaccess_tokensfallback,revokeToken,sweepExpiredTokens; contract test assertingscope+localOnlyannotations on all operations;coerceTimestampunit cases (null/undefined/string/number/throw-on-NaN); NULL-expires_at-as-expired contract for both refresh + access token paths; cascade-delete contract assertingrevoke-clientpurgesoauth_tokens+oauth_codesvia FK CASCADE; cross-client isolation (wrong-client attempt MUST reject AND rightful owner MUST still succeed atomically afterward); empty-stringredirect_uribypass guard; PKCE DCR public-client gate (token_endpoint_auth_method: "none"returns noclient_secret, defaultclient_secret_postclients get the one-time-reveal secret,getClientNULL→undefined normalization, full PKCE/authorize→/tokenround-trip against a public client).test/mcp-dispatch-summarize.test.ts—summarizeMcpParamsinvariants: declared-keys allow-list intersection, attacker-key-name leak guard (unknown keys counted not named), 1KB byte bucketing for size-probe defense, missing op falls through to fully-redacted shape, declared-keys sorted for deterministic output.test/trust-boundary-contract.test.ts— fail-closed trust semantics under cast bypass:ctx.remote === undefinedtreated as remote/untrusted at every flipped call site;as anyandPartial<>spreads can't downgrade trust by accident.test/check-resolvable-cli.test.ts— CLI wrapper: exit codes, JSON envelope shape, AGENTS.md fallback chain.test/regression-v0_16_4.test.ts—findRepoRootregression guard, hermetic startDir parameterization.test/repo-root.test.ts—findRepoRootwalk semantics + default-arg parity; the 4-tierautoDetectSkillsDirfallback chain ($OPENCLAW_WORKSPACE→~/.openclaw/workspace→ repo-root →./skills); RESOLVER.md/AGENTS.md filename precedence; explicit-env-wins-over-repo-root; tier-0$GBRAIN_SKILLS_DIRvalid/invalid/precedence-over-OPENCLAW_WORKSPACE; the install-path walk inautoDetectSkillsDirReadOnly; no-drift on primary success;AUTO_DETECT_HINT+AUTO_DETECT_HINT_READ_ONLYcontent; regression guard asserting the sharedautoDetectSkillsDirMUST NEVER return'install_path'source (how the read-path/write-path split stays safe).test/resolver-merge.test.ts— multi-file resolver merge:findAllResolverFilesempty / RESOLVER.md-only / AGENTS.md-only / both-present (RESOLVER.md first);checkResolvablemerge semantics acrossskills/RESOLVER.md+../AGENTS.mdfor the OpenClaw layout where the skillpack ships a thin RESOLVER.md and the real dispatcher lives at the workspace root; dedup byskillPath(first occurrence wins); AGENTS.md-at-workspace-root works alone.test/filing-audit.test.ts— filing audit:writes_pages/writes_tofrontmatter, filing-rules JSON validation.test/skill-brain-first.test.ts— shared frontmatter parser;analyzeSkillBrainFirstcompliance ladder across 9 fixtures undertest/fixtures/brain-first-skills/(compliant-callout, compliant-phase, compliant-position, exempt-frontmatter, missing-brain-first, multi-pattern, negation-prose, no-external, typo-frontmatter); offset helpers; external-lookup regex shape; audit snapshot+diff transition logic;FORMERLY_HARDCODED_EXEMPTregression absorption.test/routing-eval.test.ts— fixture parsing, structural routing,ambiguous_with, Haiku tie-break layer.test/skill-manifest.test.ts— skill manifest parser: drift detection, managed-block markers.test/skillify-scaffold.test.ts—gbrain skillify scaffoldstubs: SKILL.md, script, tests, routing-eval fixtures.test/skillpack-install.test.ts— skillpack bundle + surviving installer primitives:bundle.tsenumeration (manifest load/validate, dependency closure,--all) and theinstaller.tsseams that outlived the removedskillpack installcommand (diffSkillbehindgbrain skillpack diff, managed-block build/parse, lockfile concurrency, atomic writes).test/skillpack-sync-guard.test.ts— sync-guard: bundled skills stay byte-identical toskills/source.test/http-transport.test.ts— HTTP transport: bearer auth + missing/no-Bearer/unknown/revoked +/healthbypass; dispatch.ts round-trip; invalid_params; application/json response shape (not SSE); CORS default-deny + allowlist; body cap on Content-Length AND chunked; two-bucket rate limit (refill, exhaust+Retry-After, LRU eviction, TTL prune, pre-auth IP fires before DB);mcp_request_logaudit on success + auth_failed.test/restart-sweep.test.ts—recipes/restart-sweep.mdinlined script: sentinel-anchored fenced-block extraction with salted tmp filenames to bypass ESM cache; constructor-time env reads (proves no module-load snapshot); idempotency layer load/save/atomic-tmp-rename/corrupt-JSON-recovery/30-day-prune;(sessionKey, lastAlertedAt)cooldown gate with 6h threshold; AGGRESSIVE-gate two-state tests; execFile argv shape proving shell metachars inOPENCLAW_TELEGRAM_GROUPcannot reach/bin/sh; real-\n-not-literal alert formatting;GBRAIN_HOMEstate path override.test/eval-longmemeval.test.ts— LongMemEval harness, hermetic with noDATABASE_URLand no API keys: PGLite create + reset over runtime-enumeratedpg_tables, infrastructure-table preservation across resets, JSONL question parsing, retrieval-only and answer-gen modes via stubbedThinkLLMClient,--limitcutoff,--keyword-onlyvs hybrid, default--expansion=offbehavior, perf gate (p50 < 30ms / p99 < 50ms warm reset+import+search on Apple Silicon),--helpworks without a configured brain, fixture round-trip viatest/fixtures/longmemeval-mini.jsonl.test/longmemeval-sanitize.test.ts— sanitization parity pinning thatINJECTION_PATTERNSfromsrc/core/think/sanitize.tsis the single source of truth (adding a pattern there must cover both<take>framing and<chat_session>framing, no per-surface regex drift).test/openai-compat-multimodal.test.ts— gateway's openai-compatible multimodal path: happy-path single + multi-input embedding, unauthenticated proxy mode, dimension-mismatch guard (throwsAIConfigErrorwith model id + observed + expected pre-storage), default-dim fallback when recipe declaresdefault_dims, HTTP 401 / 400 / malformed-JSON / non-array error paths, regression that the existing Voyage/multimodalembeddingsrecipe still routes through its dedicated path. Hermetic via the__setEmbedTransportForTestsseam.test/serve-stdio-lifecycle.test.ts—MCP_STDIO=1env guard: stdin EOF does NOT trigger shutdown when the env is set, SIGTERM still does (guard scope is correct), unset env preserves the CLI lifecycle. Exercises theServeOptions.mcpStdio?: booleantest seam directly so tests don't mutateprocess.env.test/db-lock-fencing.test.ts— fenced lock identity: aDbLockHandlecarries its acquisition fence,refresh()returns true while owned and false after a steal (0-row fenced UPDATE), a stolen-from handle'srelease()is a fenced no-op that leaves the successor's row intact, andstartCycleLockRefresheraborts its controller withLockStolenErroron a fenced miss while serializing ticks (a slow refresh never overlaps the next).test/cycle-lock-steal.serial.test.ts— runCycle steal-abort arc end-to-end: a mid-run steal produces a structured partial report (reason: 'lock_stolen'), runs no further phases, and never touches the successor's lock row; a steal-free cycle completes and releases normally.test/cycle-any-abort-signal.test.ts—anyAbortSignalcombining: pre-aborted inputs, late aborts propagating their reason, duck-typed signal stubs (noaddEventListener) observed via poll, anddispose()detaching the caller-signal listener + clearing the poll timer (the daemon leak class).test/queue-stall-parent-unblock.test.ts— the sharedkillJobstail: a stall-exhausted child landschild_done(dead)in its parent's inbox and unblocks the parent, a requeued child doesn't touch the parent, all three reapers route through the tail with their own outcome, and the idempotent stranded-parent sweep self-heals parents whose children were already dead (without unblocking parents that still have a live child).test/queue-started-at-retry.test.ts— every automatic re-run path clearsstarted_at(failJob delayed branch, stall requeue, lease release, promoteDelayed, parent re-claim) so a retried job's wall-clock budget measures execution, not backoff wait; end-to-end survival of the wall-clock sweep on a fresh attempt.test/embed-modality-preserved.test.ts—carryChunkMetadatacarries modality + all code-metadata fields through re-embed merges (an image chunk stays image), plus the write-side contract that omitting modality resets it to text (why the shared list is load-bearing).test/import-abort-error.test.ts—runImportpreflight/argv failures throw typedImportAbortErrorinstead of exiting the process; the calling process survives the abort.test/lint-fix-single-pass.test.ts—gbrain lint --fixwalks the tree once andtotal_fixedreports the fixes THIS run applied.test/snapshot-shape-guard.test.ts— PGLite snapshot loader refusal matrix: shape-less version files, dims/model mismatches, and stale schema hashes are all refused; matching hash + shape loads; a migration-handler edit changes the hash.
E2E test inventory
E2E tests live in test/e2e/ and run against real Postgres+pgvector (require DATABASE_URL), except where noted as PGLite in-memory (no DATABASE_URL needed). One file outside the directory also rides the e2e lane: test/phantom-redirect-engine-parity.test.ts (Postgres arm; see the file taxonomy above).
bun run test:e2eruns Tier 1 (mechanical, all operations, no API keys). Includes dedicated cases for the postgres-engineaddLinksBatch/addTimelineEntriesBatchbind path — postgres-js's JSONB bind (jsonb_to_recordset(($1::jsonb)->'rows')) differs from PGLite's and gets its own coverage.test/e2e/search-quality.test.ts— search quality against PGLite (no API keys, in-memory).test/e2e/graph-quality.test.ts— knowledge graph pipeline (auto-link via put_page, reconciliation, traversePaths) against PGLite in-memory.test/e2e/jsonb-batch-poison-postgres.test.ts— gbrain#1861 regression, the engine that actually crashed. Seeds free-text "poison" context (Zoom URL with?pwd=, commas, quotes, Windows backslash path, braces, em-dash) and asserts the links/timeline/takes batch writers no longer error with "malformed array literal"; also asserts NUL is stripped from free-text bodies (context/summary/detail/claim) and still rejected in identity fields. gbrain#2011 adds the lone-surrogate crash lock: a lone UTF-16 surrogate in free text (the value that abortedextract --stalewith22P02on Supabase) well-forms to U+FFFD across batch + scalar paths (incl. timeline + takesource), while a surrogate in an identity field still rejects the batch.DATABASE_URL-gated.test/e2e/postgres-jsonb.test.ts— round-trips all 5 JSONB write sites (pages.frontmatter,raw_data.data,ingest_log.pages_updated,files.metadata,page_versions.frontmatter) against real Postgres and assertsjsonb_typeof='object'plus->>'key'returns the expected scalar. Guards against the double-encode bug.test/e2e/integrity-batch.test.ts— parity forscanIntegrity's batch-load fast path vs sequential. Cases (dedup, hits, validate, topPages) seed a fixture and assert both paths return identical results. Dedup case uses raw SQL viagetConn().unsafe()to seed a(test-source-2, people/alice)row alongside the default-source row, sinceengine.putPagedoesn't take asource_id. Pins multi-source overcounting; the "multi-source duplicate slugs scan once" case expects both batch + sequential paths to report 2.test/e2e/jsonb-roundtrip.test.ts— companion regression against the 4 doctor-scanned JSONB sites. Assertion-level overlap withpostgres-jsonb.test.tsis intentional defense-in-depth: if doctor's scan surface drifts from the actual write surface, one of these tests catches it.test/e2e/sync.test.ts—--skip-failedfailure-loop test alongside happy-path tests: broken file →performSyncreturnsblocked_by_failureswith grouped breakdown →performSync({skipFailed: true})advances bookmark and returnsAcknowledgeResultwith code summary → second broken file → second cycle. Saves and restores the user's real~/.gbrain/sync-failures.jsonlso the test is hermetic. Asserts bookmark gating, JSONL state, dedup across paths, summary aggregation, and the literal doctor-rendering string format.test/e2e/upgrade.test.ts— check-update against real GitHub API (network required).test/e2e/minions-shell-pglite.test.ts— PGLite--followinline shell-job path (in-memory, noDATABASE_URLrequired) — the path the minion-orchestrator skill documents for dev use.test/e2e/job-isolation.test.ts— process isolation on real Postgres (DATABASE_URL-gated, wired EXPLICITLY into.github/workflows/e2e.ymltier1 — the workflow runs only named files): a concurrency-3 isolated drain through real child processes (thefake-run-child.mjsfixture — real spawns, no child DB pools), and the REALjobs run-childCLI entrypoint end-to-end (engine bootstrap incl. the child's own pools, quiet handler registry, token validation, outcome protocol).test/e2e/pglite-cli-exit.serial.test.ts— real spawned-CLI exit behavior on PGLite (in-memory, noDATABASE_URL): read commands (search/get/query) exit 0 promptly; CLI_ONLYcaptureexits clean and frees the single-writer lock; the#2084describes pin every swept disconnect site — a failed op exits 1 with the error on stderr, and the dashboard, read-only-timeout, doctor, anddream --dry-runpaths all exit with no force-exit banner.test/e2e/pgbouncer-teardown.test.ts— PgBouncer TRANSACTION-mode teardown (#2084 / the #1972→#2015→#2084 class). Pins the bug CLASS, not timings: a CLI op against a txn-mode pooled URL exits 0 with intact stdout and does NOT ride the 10s hard-deadline backstop (theengine.disconnect() did not returnbanner is the smoking gun — pre-#2084 it printed on 100% of query-shaped ops). Gated byGBRAIN_PGBOUNCER_URL+GBRAIN_PGBOUNCER_DIRECT_URL(NOTDATABASE_URL) — set automatically bybun run ci:local'spgbouncercompose service; skips gracefully elsewhere. Uses a DEDICATEDgbrain_pgbouncerdatabase so it never races thegbrain_testTRUNCATE fixtures.test/e2e/volunteer-context-postgres.test.ts—volunteer_contexton REAL Postgres (#2095; engine parity beyond the hermetic PGLite unit suite): resolution arms through the actual op handler, the fire-and-forget volunteer-event sink landing rows, the stats join, and the RLS pin thatcontext_volunteer_eventshas ROW LEVEL SECURITY enabled (keeps the v35 auto-RLS event trigger honest for migration-created tables).DATABASE_URL-gated.test/e2e/openclaw-reference-compat.test.ts—check-resolvable+ skillpack install-model against a minimal AGENTS.md workspace fixture (test/fixtures/openclaw-reference-minimal/), regression guard for the OpenClaw deployment shape.test/e2e/workspace-generic-compat.test.ts— always-on (PGLite, no binary): pins the INSTALL_FOR_AGENTS.md "any repo with a workspace" contract againsttest/fixtures/generic-agents-workspace/(Hermes is the motivating consumer):cwd_walk_updetection, theGBRAIN_SKILLS_DIRoverride,check-resolvableon a root AGENTS.md, and scaffold additivity + refuse-overwrite. The real Hermes-behavior proof is the door suite below.test/e2e/install-real-hermes.serial.test.ts— the hermes "door": realhermesbinary + realhermes mcp addhandshake (full-catalog tool discovery; the count tracks the op catalog, so the test asserts discovery happened, not a number) + a paidhermes -zrecall turn against a seeded brain. Triple-gated:GBRAIN_REAL_HERMES_E2E=1(explicit opt-in — run-e2e.sh scrubs GBRAIN_*, so it can never fire underbun run test:e2e) + resolvable binary + non-empty ANTHROPIC key (anthropic-pinned on purpose: a second provider key flips hermes provider-auto into a mis-routed 401). Hermetic HOME + HERMES_HOME with a tripwire on the operator's real config; evidence copies toGBRAIN_E2E_EVIDENCE_DIRfor CI upload. Venue: heavy-tests.yml (real-agent-e2e+hermes-doorjobs).test/e2e/install-real-grok.serial.test.ts— the grok "door" (xAI Grok Build; every asserted shape observed against the pin indocs/mcp/GROK-CLI-PIN.md). SPLIT-GATED, a deliberate divergence from the hermes door: grok'smcp add/list/doctorrun keyless, so the compat tier (version-shape pin, documented-shapegrok mcp add gbrain -- gbrain serve --surface verbsvia a PATH-staged bin dir, saved-TOML asserts viaBun.TOML.parse,mcp doctorhandshake proving the seven-verb surface, vendor-fallback provenance guard, direct-TOML surface) needs onlyGBRAIN_REAL_GROK_E2E=1+ a resolvable binary; the paid SMOKE additionally needs a non-emptyXAI_API_KEYand asserts a PER-RUN NONCE fact (grok has fs/shell tools — the committed fact is greppable, so recall of it proves nothing) with web search disabled.mcp addis lazy (exit 0 always) —mcp doctor <name> --jsonis the honest discriminator (exit 0/1 observed). Hermetic HOME + GROK_HOME + tmp cwd on every spawn (grok reads vendor MCP configs for trusted folders and loads.envrcfrom cwd); bounded tripwire over the operator's real~/.grokconfig/credential files (volatile paths excluded — grok rewrites logs/sessions/bin/docs every run) + a checkout guard that no.grok//.mcp.jsonappeared in the repo root. Venue: heavy-tests.yml (real-agent-e2e+grok-doorjobs); run directly viaGBRAIN_REAL_GROK_E2E=1 bun test test/e2e/install-real-grok.serial.test.ts.test/e2e/install-real-opencode.serial.test.ts— the opencode "door" (SST opencode; every asserted shape observed against the pin indocs/mcp/OPENCODE-CLI-PIN.md). SPLIT-GATED a step past the grok door: opencode's anonymous FREE TIER drives MCP tool calls keyless, so even the nonce SMOKE runs in the keyless tier — T1 bare-semver version pin (the SST-vs-claimant discriminator), T2 documented-shapeopencode mcp add gbrain --env … -- gbrain serve --surface verbs+ the honestopencode mcp listdiscriminator (it SPAWNS every server;✓/✗text is the assertion surface — exit code is 0 even on failure, andmcp debugis OAuth-only), T2b spawn-gate CANARY (a project-config decoy is spawn-attempted with NO trust prompt — if this ever gates, the bootstrap user-global scope default's rationale changed: re-observe), T3 writer parity (gbrain'sopencode-json.tsoutput handshakes through the real binary; cross-tool preservation both ways), T4 keyless SMOKE (per-run nonce + STRUCTURALgbrain_*tool_use proof viaparseOpencodeJsonl,--format json). The paid T5 anthropic leg additionally needs a non-emptyANTHROPIC_API_KEYand self-validates the pinned model id against the authedopencode modelslist BEFORE any spend. Hermetic HOME + both XDG dirs + tmp cwd on every spawn;--pureon every probe (mcp listautoloads plugins — a code-execution surface); bounded tripwire over the operator's real opencode configs/auth.json + a repo-root checkout guard. Venue: heavy-tests.yml (real-agent-e2e+opencode-doorjobs, plus the schedule-onlyopencode-door-canarylatest-version leg — continue-on-error, a pin-refresh signal, never a gate); run directly viaGBRAIN_REAL_OPENCODE_E2E=1 bun test test/e2e/install-real-opencode.serial.test.ts.
Door cadence policy (adopted with the 4th door agent): the NEWEST door agent runs at nightly/schedule cadence (currently opencode, whose canary leg also tracks latest); a door drops to label-only (real-agent-e2e) after 2 stable monthly cycles with unchanged pins. Rationale: churn concentrates in the newest integration; steady-state doors pay for themselves on demand, not nightly.
test/helpers/tty-harness.ts+test/tty-harness.test.ts— the DX real-PTY harness (Bun.spawn({terminal:})): pure text/timing helpers unit-tested with zero subprocesses, plus three live PTY smokes againstshguarded bydescribe.skipIf(!ptySupported()). The harness itself is a dev instrument surface — its consumerscripts/dx-explore.tsnever runs in CI (transcripts land in gitignored.context/dx-runs/); seedocs/guides/bootstrap.mdfor the scenario runbook.test/e2e/search-swamp.test.ts— reproduces the source-swamp case. Seeds a curatedoriginals/talks/article-outline-fat-codepage against two<fork>/chat/pages stuffed with the same multi-word phrase. Asserts the article wins keyword AND vector ranking, thatdetail=highlets the chat swamp re-surface, and thatsource_idpasses through the two-stage CTE intact. PGLite in-memory.test/e2e/search-exclude.test.ts—test/+archive/pages hidden by default,include_slug_prefixesopts back in, caller-suppliedexclude_slug_prefixesadds to defaults. Both keyword and vector search paths.test/e2e/engine-parity.test.ts— Postgres ↔ PGLite top-result and result-set parity forsearchKeyword+searchVector(Postgres ranks pages then picks best chunk while PGLite returns chunks directly, so the source-boost behavior needs parity coverage). Skips withoutDATABASE_URL.test/e2e/postgres-bootstrap.test.ts— exercisesPostgresEngine.initSchema()directly against a fresh real Postgres database. Asserts the bootstrap path is no-op on fresh installs and that SCHEMA_SQL replays cleanly through the engine path (not via the standalonedb.initSchemafromsrc/core/db.ts).test/e2e/http-transport.test.ts—gbrain serve --httpend-to-end against real Postgres: bearer auth round-trip,last_used_atSQL-level debounce,mcp_request_logrow insertion on success and auth_failed paths,/healthDB-down → 503 (DB-probing health check), and the dispatch round-trip with a real operation. Skips withoutDATABASE_URL.test/e2e/serve-http-oauth.test.ts— real-Postgres E2E againstgbrain serve --httpwith full OAuth 2.1. Spawns a subprocess server, registers a client via the CLI, mintsclient_credentialstokens, exercises the/mcpJSON-RPC pipeline. Real DCR/registerHTTP-level response-shape test (assertstypeof body.client_id_issued_at === 'number'over the wire, RFC 7591 §3.2.1); real CLI subprocess test forrevoke-client(registers → mints token → revokes viaexecSync→ asserts token rejected at/mcp→ asserts re-run exits 1); server fixture flips on--enable-dcrso/registeris reachable. bun execSync env-inheritance contract: bun'sexecSyncdoes NOT inherit env mutations done viaprocess.env.X = ..., only OS-level env from before bun started. helpers.ts loads.env.testingand setsDATABASE_URLviaprocess.envmutation, which is invisible to subprocesses unlessenv: { ...process.env }is passed explicitly — every subprocess call in this file passesenv: { ...process.env }. Reference fix for the same failure mode in sibling sync/cycle/dream/claw-test E2Es.afterAllcleanup is guarded onclientId(won't throw ifbeforeAllfailed before registration); cleanup errors surface to stderr without throwing so real test failures aren't masked. Also covers the trust-boundary fix: an HTTP MCPsubmit_jobforname: "shell"MUST reject with a permission error (request handler setsremote: trueandsubmit_job's protected-name guard fires), and the same guard rejects subagent submission. Skips withoutDATABASE_URL.test/e2e/sync-parallel.test.ts—DATABASE_URL-gated. 60-file Postgres sync at concurrency=4 imports all + no connection leak (probespg_stat_activitybefore/after to confirm worker engines disconnected). 120-file serial-vs-parallel benchmark printsSYNC_PARALLEL_BENCH N files | serial=Xms | parallel(4)=Yms | speedup=Zx. Asserts parallel ≤ serial × 1.5 (CI-noise tolerant; not a strict speedup gate).test/e2e/multi-source-bug-class.test.ts— PGLite in-memory regression suite pinning every multi-source bug site:listAllPageRefsordering by(source_id, slug),getPagewith sourceId picks the right(source, slug)row,extract-takesprocesses both overlappingpeople/alicerows independently,listPagesfilters correctly withPageFilters.sourceId,addLinksBatchwithfrom/to_source_idtargets the right rows,validateSourceIdrejects path traversal, reverse-write disk layout usesbrainDir/.sources/<id>/<slug>.mdfor non-default sources,copyMigrationSourceslands source metadata before overlapping-slug pages. NoDATABASE_URLneeded. Wired intoscripts/e2e-test-map.tsso changes to extract-takes / patterns / synthesize / embed / extract / migrate-engine auto-trigger it.test/e2e/migrate-engine-sources-postgres.test.ts—DATABASE_URL-gated companion forgbrain migrate --to: migrates a PGLite brain carrying two non-default sources with overlapping slugs into real Postgres and assertscopyMigrationSourcescreated everysourcesFK parent (config JSONB intact, not double-encoded) before any page write. Unit-level manifest identity (crash manifest resumes only against the SAME target; legacy engine-only manifests start fresh) istest/migrate-engine-resume.test.ts.test/e2e/facts-fence-reconcile-postgres.test.ts—DATABASE_URL-gated round-trip for the escape-aware fence parser: renders a## Factsfence whose cells carry literal pipes, backslashes (Windows paths), and empty cells viarenderFactsTable, runs the wipe-and-reinsert reconcile (runExtractFacts) on real Postgres, and asserts every cell survives byte-identically with no column shift.test/e2e/source-isolation-pglite.test.ts— PGLite in-memory regression suite pinning the source-isolation seal at two layers. Engine layer:searchKeyword/searchVector/searchKeywordChunks/listPages/getPage/traverseGraph/traversePathsapplysourceId(scalar fast path) andsourceIds(array path) correctly across both engines. Op-handler layer: routes throughsourceScopeOpts(ctx)so aread+write-scoped OAuth client bound to--source dept-xcannot see rows from neighboring sources viasearch,query,list_pages,get_page, orfind_experts. Covers bothctx.sourceId(single-source clients) andctx.auth.allowedSources(federated_read clients) precedence; federated array wins over scalar wins over nothing. NoDATABASE_URLneeded.test/e2e/think-source-isolation-pglite.test.ts— PGLite in-memory suite pinning thethinkgather stage's source scope: seeds three sources with cross-source links and embedded takes, then assertsrunGatherunder a federatedsourceIdsgrant (and under a scalarsourceId) keeps every stream — hybrid retrieval, takes keyword + vector (searchTakes/searchTakesVector), and thetraversePathsgraph walk — inside the grant while still reaching authorized neighboring sources. NoDATABASE_URLneeded.test/e2e/skill-brain-first.test.ts— doctor reportsskill_brain_firstcheck with structured issues;--fix --dry-runpreviews insertion without writing;--fixapplies the canonical Convention callout idempotently;brain_first: exemptfrontmatter resolves the warn;brain_first_typosurfaces a paste-ready hint; audit JSONL recordsdetected/resolved/fixedtransitions; stable brain emits 0 audit lines/run.- Tier 2 (
test/e2e/skills.test.ts) requires OpenClaw + API keys, runs nightly in CI. test/e2e/claw-test.test.tsalso covers live mode token-free via shim agents (OPENCLAW_BIN=<sh script>): the success-oracle break path (a do-nothing agent now FAILS), the E0 child-friction merge surviving tempdir cleanup, and the upgrade staging + schema-version-probe regression.- If
.env.testingdoesn't exist in this directory, check sibling worktrees:find ../ -maxdepth 2 -name .env.testing -print -quitand copy it here if found. - Run E2E tests without asking permission. When you want to verify behavior, there's a relevant E2E test, or you're shipping anything covered by an E2E suite — spin up the test DB, run the tests, tear down. Don't ask, don't propose it, don't defer. The lifecycle is short (~2-30s startup, sub-minute tests, instant teardown) and the gate value is high. Skipping with "DATABASE_URL unset" is silent regression, not caution.
API keys and running ALL tests
ALWAYS source the user's shell profile before running tests:
source ~/.zshrc 2>/dev/null || true
This loads OPENAI_API_KEY and ANTHROPIC_API_KEY. Without these, Tier 2 tests
skip silently. Do NOT skip Tier 2 tests just because they require API keys — load
the keys and run them.
When asked to "run all E2E tests" or "run tests", that means ALL tiers:
- Tier 1:
bun run test:e2e(mechanical, sync, upgrade — no API keys needed) - Tier 2:
test/e2e/skills.test.ts(requires OpenAI + Anthropic + openclaw CLI) - Always spin up the test DB, source zshrc, run everything, tear down.
E2E test DB lifecycle (ALWAYS follow this)
You are responsible for spinning up and tearing down the test Postgres container. Do not leave containers running after tests. Do not skip E2E tests, do not ask permission to run them — see the "run without asking" rule above.
- Check for
.env.testing— if missing, copy from sibling worktree. Read it to get the DATABASE_URL (it has the port number). - Check if the port is free:
docker ps --filter "publish=PORT"— if another container is on that port, pick a different port (try 5435, 5436, 5437) and start on that one instead. - Start the test DB:
Wait for ready:docker run -d --name gbrain-test-pg \ -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres \ -e POSTGRES_DB=gbrain_test \ -p PORT:5432 pgvector/pgvector:pg16docker exec gbrain-test-pg pg_isready -U postgres - Bootstrap the schema (required — fresh containers have no
oauth_clients,mcp_request_log,pagesetc.; tests likeserve-http-oauth.test.tswill fail withrelation "oauth_clients" does not existif you skip this):DATABASE_URL=postgresql://postgres:postgres@localhost:PORT/gbrain_test \ bun run src/cli.ts doctor --json > /dev/null 2>&1gbrain doctortriggersinitSchema()on first connect, which is the canonical way to bring a fresh DB to head.apply-migrations --yesalone does NOT seed the base schema — it runs ALTER-style migrations on top ofinitSchema. Tests that bypass the engine (rawexecSync-spawnedauth register-client) hit the schema directly and need this step to have run first. - Run E2E tests:
DATABASE_URL=postgresql://postgres:postgres@localhost:PORT/gbrain_test bun run test:e2e - Tear down immediately after tests finish (pass or fail):
docker stop gbrain-test-pg && docker rm gbrain-test-pg
Never leave gbrain-test-pg running. If you find a stale one from a previous run,
stop and remove it before starting a new one.