beads/engdocs/TESTING.md
Jim Wordelman da89d21813
docs(testutil): document migration-0032 hang and Ryuk-disabled container-leak caveats (#6001)
* docs(testutil): document migration-0032 hang and container-leak caveats (refs be-r7j5x)

Adds a comment near DoltDockerImage documenting two known limitations
of the podman-rootless + testcontainers-go real-server test harness:

- Schema migration 0032 hangs indefinitely over the sql-server wire
  protocol in this harness only; not reachable on real GitHub Actions
  CI or a bare-host-process dolt sql-server (be-j3szz).
- Containers can leak because Ryuk is disabled for this harness, so
  there is no reap safety net if a test process skips its cleanup
  (be-5kkk6).

No production code changes.

* docs(testutil): fix Ryuk-disabled citation and causal claim (refs be-ohrc0)

Round-1 review (be-ohrc0) flagged that the container-leak bullet cited
be-hsa9t for the TESTCONTAINERS_RYUK_DISABLED=true rationale and claimed
it was a workaround for this host's broken dockerd/containerd. Neither
is accurate: be-hsa9t is an unrelated git-remote E2BIG fix that never
mentions Ryuk or dockerd/containerd.

Corrects the citation to be-w3n2m (open, undecided) and the causal claim
to match its actual finding: under rootless podman, Ryuk frequently
cannot start because it wants the runtime socket.

No production code changes.

* docs(testing): move the Dolt container caveats out of DoltDockerImage

Review #6001 asked for this to leave the source file, on three grounds
that all check out.

CONTRIBUTING_PR_GUIDELINES.md line 33 is explicit — "Minimize inline code
comments … let the commit message and PR description carry the why" — and
a 23-line comment-only diff is the shape it names. DoltDockerImage is also
the wrong hook: it is the image pin guarded by test/docsync/doltpin_test.go
and read by container_provider.go and testdoltserver.go, so harness
lifecycle lore attached to it reaches every caller including CI.

The Ryuk sentence was also wrong as written. It claimed Ryuk "is disabled
for this harness (TESTCONTAINERS_RYUK_DISABLED=true)". This repository sets
that variable nowhere — not in Go, scripts/, the Makefile, or
.github/workflows/; the only tracked occurrences are release-gates/*.md,
which are records of operators' local podman runs. CI therefore runs with
Ryuk enabled, and the original text described a local shell as if it were
the repo's harness. Reworded to say what is true: the podman-rootless flow
generally requires disabling Ryuk by hand, and doing so is what removes the
safety net.

Both caveats now live in engdocs/TESTING.md as a sibling of "Test
Environment and Readiness", the section that already covers
BEADS_TEST_SKIP=dolt and BEADS_TEST_ENV_RUN_DOLT. Content is otherwise
preserved, including the be-j3szz / be-w3n2m / be-5kkk6 evidence chain, plus
a stray-container check and a pointer to testMainInner in beads_test.go.
engdocs/TESTING.md is not in check-doc-freshness.sh's DOCS list, so this
needs no inventory or freshness marker.

internal/testutil/testdoltcommon.go is now byte-identical to main.

Addresses the doc half of #6171. Refs be-8n9ns.

* docs(testing): scope the Dolt caveats to podman-rootless and fix the repro

Maintainer review fixes for PR #6001 (adopt-pr review iterations 1 and 2).
All edits are phrase-level and confined to engdocs/TESTING.md.

- Scope the causal claim to the podman-rootless path. CI runs the same
  containerized wire path green on every risk-tier PR -- pr-risk.yml's
  test-server-storage* jobs pull the pinned image precisely to defeat the
  self-skip and run with no BEADS_TEST_SKIP=dolt -- so "the container
  port-forwarding path" as a general cause is refuted by the repo's own CI,
  and as written invited a Docker developer to dismiss a real 0032/initSchema
  hang as a known harness limitation. Softened "Neither is reachable ... on
  GitHub Actions" to "Neither failure mode manifests ...", which is what is
  actually true.

- State every way a suite reaches a real dolt sql-server. The entry condition
  named one mechanism (testcontainers-go) and one fallback (self-skip), but
  the uow package the section uses as its repro also has suites that call
  testutil.RequireDoltBinary and start a server from the local dolt CLI
  (proxy.BackendLocalServer) with no container involved, and lanes that set
  BEADS_TEST_REQUIRE_DOLT_CONTAINER=1 fail rather than skip. The sentence now
  covers all three and scopes the two limitations to the containerized path.
  The testcontainers leg says "by default" so it stays true once main's
  BEADS_TEST_DOLT_SERVER=local backend section merges above it, without
  forward-referencing a section this branch does not have.

- Attribute the two failure shapes separately. The fenced banner could not be
  produced by the repro printed beside it: the uow entry points pass
  context.Background(), so context deadline exceeded has no producer there;
  the only 60s in the uow package is bo.MaxElapsedTime, a backoff budget that
  backoff.Retry consults only between attempts and which therefore cannot
  bound a hang inside one. The banner's only producer is store.go's
  "failed to initialize schema: %w" inside newServerMode, the server-mode
  store open, which runs initSchema with the caller's context -- so the doc
  names that path. (Iteration 1 labelled it the embedded-store open, which
  contradicted the section's own statement that the embedded/CLI engine does
  not hang.) Kept the uow "sits until the package timeout" sentence (the
  accurate half), dropped the unverifiable ~60s figure, and dropped the
  "failed to create embedded DoltStore: " prefix, which has zero occurrences
  in the tree, so the quoted line is greppable.

- Make the stray-container check runnable under the flow the section is about.
  A bare docker ps talks to the CLI's default endpoint and returns a false
  all-clear on exactly the leaked-container incident the paragraph cites; it
  now carries DOCKER_HOST=unix:///run/user/$(id -u)/podman/podman.sock, the
  form all six in-repo records of this flow use.

- Close the image-pin duplication without touching the guard, and make the
  read fail loudly. The command read the tag from a hand-copy outside
  test/docsync/doltpin_test.go's reach; it now reads it from
  internal/testutil/testdoltcommon.go, resolved from the repository root with
  git rev-parse --show-toplevel so it works from any directory in the tree.
  An empty read would reproduce the false all-clear (docker ps --filter
  ancestor= exits 0 listing nothing), so the tag is expanded as
  ${dolt_image:?...}, which refuses to run docker without it. A trailing
  "[ -n ... ] || { ...; return 1; }" guard does not do that when pasted at an
  interactive prompt: a top-level return stops neither bash nor zsh, and the
  next line still runs docker with an empty filter. Deliberately NOT added to
  doltpin_test.go's scanned set: doltPinImageRE requires the assignment form
  DoltDockerImage = "..." which cannot appear in prose, and find() t.Fatalf's
  on a miss, so that would red a currently green test.

Validation: git diff --check clean; go test ./test/docsync/ 8 PASS / 0 FAIL /
0 SKIP with TestDoltVersionPinsAgree green; scripts/check-doc-freshness.sh
exit 0; the snippet extracted from the doc passes bash -n and zsh -n, resolves
dolthub/dolt-sql-server:2.2.0 from the repository root and from a
subdirectory in interactive bash and zsh, and outside a repository prints the
error without running docker (checked against a stub docker).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Gas City Adopt-PR <adopt-pr@gascity.local>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-30 20:17:56 -07:00

295 lines
15 KiB
Markdown

# Testing Guide
`TESTING.md` is the single authority for test commands, test selection, and
test design in this repository. Use the commands here for local work. For the
exact command behind a current CI check, inspect its workflow and corresponding
`Makefile` target; the CI audit and cleanup plan are dated maintainer context.
## Choose the Smallest Useful Test
Test at the lowest seam that can fail for the user-visible reason. Add a
higher tier only when it covers a distinct risk that the lower tier cannot
show: integration wiring, a real persistence property, a process boundary, or
an external contract.
This keeps feedback fast and failures readable. It does not mean every test is
a unit test: use the real boundary when the defect could live there.
| Need | Run | When |
|---|---|---|
| Docs-only validation | `git diff --check`, `go test -tags=gms_pure_go ./test/docsync`, and `./scripts/check-doc-freshness.sh` | For prose-only changes; add any generated-doc or surface-specific link check the changed paths require. Do not run the full Go suite merely because a Markdown file changed. |
| Focused red/green loop | `./scripts/test.sh -run '^TestExactName$' ./path/to/package/...` | While writing or fixing one behavior. |
| Affected-package confidence | `./scripts/test.sh ./path/to/package/...` | After the focused test passes; include directly affected neighbors when their contract changed. |
| Final Go baseline | `make test` | Once after focused work on Go code is green. It applies the normal local build flags, coverage, and local skip handling. |
| Named CI wrapper | `make ci-pr-core`, `make ci-pr-policy`, or `make ci-pr-lint` | Run the wrapper whose risk or surface is affected, or use it to reproduce that CI check. Do not run all three routinely for every edit. |
| Hook shims against real timeout implementations | `nix flake check -L` (or `nix build .#checks.<system>.hook-timeout-backends -L`) | After changing the hook generator in `cmd/bd/hooks.go` (then `make githooks-regen`) or anything under `.githooks/`. Runs the tracked managed sections against GNU coreutils, uutils, busybox and toybox `timeout` — the multicalls also installed as `gtimeout` alone — with and without Perl, under dash, bash and busybox ash. About one deadline of wall time; needs no Go build. |
Do not replace the focused loop with repeated full-suite runs. Run the final
`make test` once the affected Go tests are green. For docs-only changes, use
the docs, link, and diff checks instead.
## Commands and Local Environment
`./scripts/test.sh` is the normal runner. It sources `.buildflags`, creates an
isolated test environment, applies `.test-skip`, and defaults to a **25m
per-package** Go-test timeout. The timeout is a hang backstop, not a target
runtime. Override it only when diagnosing a legitimate slow path:
```bash
TEST_TIMEOUT=30m ./scripts/test.sh ./cmd/bd/...
TEST_VERBOSE=1 ./scripts/test.sh ./cmd/bd/...
TEST_RUN='^TestExactName$' ./scripts/test.sh ./cmd/bd/...
# Equivalent command-line options.
./scripts/test.sh -v -run '^TestExactName$' ./cmd/bd/...
./scripts/test.sh -timeout 30m ./cmd/bd/...
```
Use the opt-in ICU regex path only when the change requires it:
```bash
make test-icu-path
```
It is maintainer-only and not part of normal validation. `make test-full-cgo`
and `./scripts/test-cgo.sh` remain deprecated compatibility aliases.
Use a named specialized target only when its risk is in scope:
```bash
make test-regression
make test-upgrade
make test-cross-version
make test-migration
```
For a failing GitHub Actions check, follow the current workflow and its
`Makefile` target when exact reproduction matters. The local runner and CI
intentionally have different contracts in some cases.
### Test Environment and Readiness
The runner isolates `HOME`, Git configuration, and Dolt state. By default its
test environment adds `dolt` to `BEADS_TEST_SKIP`; set
`BEADS_TEST_ENV_RUN_DOLT=1` only when deliberately exercising the Dolt path
and its prerequisites are available. Do not make ordinary tests depend on a
developer's database, daemon, global Git configuration, or filesystem state.
To skip an optional service explicitly, use the existing skip mechanism:
```bash
BEADS_TEST_SKIP=dolt ./scripts/test.sh ./...
```
Tests that need a Dolt SQL server get one from `internal/testutil`
(`EnsureDoltContainerForTestMain`, `RequireDoltContainer`,
`StartIsolatedDoltContainer[Handle]`, `NewContainerProvider`). Two backends
sit behind that API, selected by `BEADS_TEST_DOLT_SERVER`:
- `container`: the `dolthub/dolt-sql-server` image through testcontainers
(needs docker and the pulled image). The default under plain `go test`.
- `local`: a `dolt sql-server` started by the test process from the pinned
dolt CLI (`BEADS_TEST_DOLT_BINARY`, else `dolt` on `PATH`; it must be the
image's version). No docker. Used only when explicitly selected, under
`go test` and `bazel test` alike (a Bazel target's `env`, or
`--test_env=BEADS_TEST_DOLT_SERVER=local`); unset means `container`, which
in a Bazel action without docker keeps the usual skip.
`BEADS_TEST_REQUIRE_DOLT_CONTAINER=1` turns an unavailable backend into a
failure (per test and in every `TestMain`) instead of a skip; lanes that
exist to run the Dolt suites set it.
Under Bazel, `bazel test //... --config=doltserver` runs the Dolt-backed
suites of pr.yml's "Test (storage domain + uow)" and "Contract corpus" jobs
on the `local` backend (the `dolt-server` targets); they need no docker and
execute remotely with `--config=remote-exec`. `--config=docker` runs the same
suites on the `container` backend (host docker) as the A/B control.
PR Risk's heavier server tiers have configs of their own, run by bazel.yml
only with remote execution, each in a job of its own (`bazel-proxied`,
`bazel-server-storage`): `--config=doltserver-proxied` is the
proxied-server cmd/bd tier ("Test (Proxied Dolt Cmd N/15)",
`//cmd/bd:bd_proxied_test`), and `--config=doltserver-integration` the
server-Dolt storage tier ("Test (Server Dolt Conformance)", "Test (Server
Dolt Full Suite N/16)", `//internal/storage/dolt:dolt_server_*_test`), which
builds with the integration tag like `--config=integration`. Each shard
runs its CI job's shard script, so Bazel shard k runs the tests of job k+1.
Tests that need a temporary repository or store should use `t.TempDir()` and
`t.Cleanup()`. Temporary repositories must set a repository-local hooks path;
do not inherit the developer's global hooks configuration.
In `cmd/bd`, fresh-workspace command fixtures should call
`isolateBeadsDirForTest(t)` before setup or dispatch. It clears inherited
`BEADS_DIR` and restores that variable exactly at cleanup, even after raw
command-dispatch mutations. The `TestMain` reset only isolates startup.
These fixtures must not use `t.Parallel()`. Tests intentionally selecting a
workspace should use `t.Setenv("BEADS_DIR", ...)`; `initConfigForTest` and
`ensureCleanGlobalState` preserve that selection.
For manual CLI experiments, run both initialization and subsequent commands
from a disposable working directory:
```bash
beads_manual_dir="$(mktemp -d)"
(
set -e
cd "$beads_manual_dir"
bd init --quiet --prefix test --skip-hooks --skip-agents
bd create "Test issue" -p 1
)
rm -rf -- "$beads_manual_dir"
```
`BEADS_DB` selects a database for database-opening commands, but it does not by
itself redirect `bd init` workspace setup. Never run a manual `bd init` from a
production workspace merely because `BEADS_DB` points elsewhere.
`testing.Short()` is for genuine runtime, stress, or large-fixture skips. It
is not a substitute for declaring an integration, end-to-end, API, Docker, or
external-dependency boundary. Keep new uses within the repository policy:
```bash
make check-testing-short
```
### Dolt Container Tests (podman-rootless)
Anything that does not carry `BEADS_TEST_SKIP=dolt` — including
`BEADS_TEST_ENV_RUN_DOLT=1` and a bare `go test` — reaches a real
`dolt sql-server`: by default through testcontainers-go where a container
runtime and the pinned image are present (otherwise those suites self-skip),
and from the local `dolt` CLI in the suites that use
`testutil.RequireDoltBinary`. Lanes that set
`BEADS_TEST_REQUIRE_DOLT_CONTAINER=1` fail instead of skipping. Two limitations
of the containerized path are worth recognizing before reading a failure as a
product bug. Neither failure mode manifests in production or on GitHub Actions:
CI exercises this same containerized path green on every risk-tier PR, and
`.github/workflows/pr-risk.yml` pulls the pinned image precisely to defeat the
self-skip. A hang there is a real bug, not this section's subject.
**Migration 0032 hangs over the wire protocol.** Migration `0032`
(`drop_schema_migrations_applied_at`) hangs indefinitely when applied through
the containerized sql-server. How it surfaces depends on the caller's context.
A `go test ./internal/storage/uow/... -count=1` with no `BEADS_TEST_SKIP`
passes `context.Background()`, so it sits in `initSchema` until the package
timeout rather than failing — that is the shape you will normally see, with no
deadline to cut it short. A caller that does supply one gets the hang reported
by the server-mode store open (`newServerMode` in
`internal/storage/dolt/store.go`) instead:
```
failed to initialize schema: context deadline exceeded
```
The cause is the podman-rootless container port-forwarding path, not migration
0032's SQL: the identical statement completes normally through the embedded/CLI
engine, and against a bare-host-process `dolt sql-server` matching the deployed
shape. Evidence chain in `be-j3szz`. Use `BEADS_TEST_SKIP=dolt` unless the
container path is what you are testing.
**Disabling Ryuk removes the container safety net.** This repository sets no
`TESTCONTAINERS_RYUK_DISABLED`, so CI runs with Ryuk — testcontainers-go's
orphan-reaper sidecar — enabled. The podman-rootless flow generally requires
turning it off by hand (`TESTCONTAINERS_RYUK_DISABLED=true`), because under
rootless podman Ryuk frequently cannot start: it wants the runtime socket. See
`be-w3n2m`. With Ryuk off, nothing reaps a container whose test process exited
without running its cleanup — `os.Exit` reached before a deferred
`TerminateDoltContainer`, for instance. `be-5kkk6` records the cost: 101 leaked
containers, and an exhausted swap. When running with Ryuk disabled, keep
teardown on the normal return path using the `testMainInner` pattern
(`beads_test.go`), and check for strays afterwards. Carry the rootless socket
this flow runs on — a bare `docker ps` talks to the CLI's default endpoint and
reports a false all-clear — and read the tag from the pin rather than copying
it, so the command cannot drift when the pin moves. An empty read would be the
same false all-clear (`ancestor=` matches nothing), so the command refuses to
run without a tag:
```bash
dolt_image=$(sed -n 's/.*DoltDockerImage = "\(.*\)".*/\1/p' \
"$(git rev-parse --show-toplevel)/internal/testutil/testdoltcommon.go")
DOCKER_HOST=unix:///run/user/$(id -u)/podman/podman.sock \
docker ps -a --filter "ancestor=${dolt_image:?could not read the Dolt image pin}"
```
## Test Design
### Seams, Scenarios, and Doubles
Write one scenario at the smallest seam that demonstrates the behavior. Cover
the boundary or failure mode that changes the user result; use table-driven
subtests when examples share setup. Do not repeat the same scenario through a
helper, every caller, and the CLI merely because all are available.
A recording double or fake should be narrow: model only the calls, inputs,
outputs, and failures the test needs. It should not recreate a storage engine,
process manager, or another subsystem just to make a unit test look realistic.
A behavioral fake is different. If it stands in for a contract shared by
multiple production implementations, give it the same semantic-conformance
suite as those implementations. That shared suite defines observable behavior;
it prevents the fake from teaching callers a contract production code does not
honor.
Semantic conformance asks whether an implementation produces the promised
results, errors, and state transitions for the same operation. Persistence
conformance asks whether the real persistence boundary preserves its required
durability, transaction, migration, and recovery properties. They answer
different questions. Do not claim backend parity unless a stated contract and
its conformance suite establish it.
### Tier Admission
An integration test belongs above the unit seam only when it covers a distinct
boundary that a narrow double cannot prove, such as configuration wiring, a
real filesystem or Git interaction, a subprocess protocol, or persistence
behavior.
An end-to-end test is admitted only when all of these are true:
1. The failure would be user-visible.
2. A real process, setup, or wiring boundary owns a distinct failure risk that
no lower seam can prove.
3. Lower-tier tests cover the underlying behavior where practical, leaving the
end-to-end test focused on that boundary.
4. No existing end-to-end test already covers the same boundary risk.
Lower-tier coverage of the same user journey does not disqualify the
end-to-end test; duplicate coverage of the same boundary risk does. State that
risk in the test name or nearby documentation.
### Avoid Incidental Complexity
Avoid these patterns unless they are the behavior under test:
- Duplicate scenarios at several layers.
- Global-state reset choreography. Prefer per-test state and cleanup.
- Subprocesses, listeners, sleeps, or real-store setup for a unit-level claim.
- Assertions on private implementation shape when observable behavior is the
contract.
- Performance claims without a repeatable measurement and stated workload.
Sleeps, listeners, and real stores are appropriate when the test is specifically
about timing, lifecycle, protocol, or persistence. Keep the setup scoped and
make that reason apparent.
## Failures, Skips, and Review
`.test-skip` is a local, temporary exception list. If an unrelated failure is
already listed, report it rather than silently broadening the skip. Before
adding a new skip, record the issue it tracks and remove the skip when the
underlying failure is fixed.
Before opening a PR:
1. For docs-only changes, run the applicable docs, link, freshness, and diff
checks; do not run the full Go suite by default.
2. For Go code, keep the focused and affected-package tests green, then run one
final `make test`.
3. Run only the named CI wrapper, specialized target, or risk gate required by
the changed surface, or the one needed to reproduce a CI result.
For historical CI inventory and maintainer planning context, consult
[CI_TEST_SURFACE_AUDIT.md](CI_TEST_SURFACE_AUDIT.md) and
[CI_CLEANUP_PLAN.md](CI_CLEANUP_PLAN.md). For current commands, use the
workflow files and `Makefile`; these context documents are not a second testing
guide or a live CI inventory.