Files
yellowjacket/backend/testctl/testctl.go
T
logan 5ca6cad45a
Build & publish Arch package / arch-package (push) Successful in 2m8s
CI / check (push) Failing after 1m56s
CI / e2e (push) Skipped
Search index maintenance / maintain-index (push) Successful in 13s
feat(harness): agent-drivable dev harness and CI that gates
A coding agent could develop this repo's Go packages and could not
develop the application: every path to running YellowJacket ended in a
blocking GTK window, so 265 bound methods, 46 events, 33 component
directories and 13 stores had exactly one form of verification
available — `tsc --noEmit`.

The unlock is that `wails dev`'s dev server on :34115 serves the real
frontend with the real generated bindings against the same Go backend a
desktop window attaches to, so a plain Chromium under Xvfb gets a fully
functional app. Four test tiers now exist, cheapest first:

- `make ui-test` — 313 Vitest tests in a real browser in ~2 s, no app,
  no backend, no display. Works because `frontend/wailsjs/` is a pure
  passthrough to `window.go`/`window.runtime`, so faking just those two
  globals runs the real bindings and the real store code.
- `make test` — services in-process, asserting on the payload the
  frontend would receive, via a new `events.Emit` wrapper.
- `make dev-headless` + `playwright-cli` — the real app, driven
  interactively, with an event bridge on `window.__yjEvents` and a
  dev-only control surface at `/__test/`.
- `make e2e` — 19 of those flows frozen as Playwright specs.

`events.Emit(ctx, …)` replaces all 35 direct `runtime.EventsEmit` call
sites: wails' `getEvents` `log.Fatalf`s on any context without its
runtime, so those paths could not run under test and a background
worker could take the app down. Four packages had each hand-rolled the
same guard; nine more guarded on `ctx != nil`, which does not help.
`TestNoDirectRuntimeEmits` fails the build on a new one.

Fixtures are generated, not committed (`make testdata`), and seeds are
built by *running the app* — never by hand-writing config and DB rows,
which would be a second description of a valid YJ_HOME.

`.gitea/workflows/ci.yml` is the first workflow here that tests
anything; the other three only package, so `gitea_ci` reported only
packaging jobs and misled anyone asking whether a push was healthy.
Both jobs were prototyped to green in a bare ubuntu:24.04 container
before the YAML was written, which immediately caught `make lint`
linting three configurations that nothing builds: all three passes
omitted `webkit2_41`, so wails resolved webkit2gtk-4.0 — which Arch
still ships and Ubuntu 24.04 dropped.

Operational instructions live in `.pi/skills/yellowjacket-dev/`,
measured discoveries in `.planning/NOTES.md`, and architecture in
`CLAUDE.md` — split by tense, not by topic, because a topical split
gives every new fact two plausible homes. `make skill-check` fails a
commit if the skill cites a make target that does not exist.
2026-08-10 23:20:42 -04:00

54 lines
2.1 KiB
Go

// Package testctl mounts a dev-only HTTP control surface at /__test/
// on the app's own asset server.
//
// It exists for the residue of what an end-to-end harness genuinely
// cannot reach from the browser. Everything the frontend can do is
// already reachable through the generated bindings on `window.go` —
// clicking, reading the DOM, calling a service — so this deliberately
// does *not* re-expose any of that. What is left is server-side state:
// snapshotting and restoring the SQLite database mid-run, forcing a
// backend event so a push-driven view can be rendered without staging
// hours of real work, and reading a single authoritative "is the
// backend actually ready" answer.
//
// It is gated twice. The implementation lives behind the `dev` build
// tag (the non-dev twin is an empty function, so nothing links into a
// release binary), and even in a dev build it refuses to register
// unless YJ_TESTCTL=1 — otherwise every `make dev` session a human runs
// would carry an arbitrary-SQL endpoint on a listening port.
package testctl
import (
"context"
"log/slog"
"net/http"
"yellowjacket/backend/database"
)
// EnvEnable must be set to "1" for the surface to register, even in a
// dev build. scripts/dev-headless.sh sets it; `make dev` does not.
const EnvEnable = "YJ_TESTCTL"
// Prefix is the single mount point. One pattern, one ServeMux entry.
const Prefix = "/__test/"
// Registrar is the slice of *assets.Handler this package needs, taken as
// an interface so testctl does not import the asset server (which would
// make the non-dev build's import graph differ from the dev one).
type Registrar interface {
RegisterHandler(pattern string, handler http.Handler)
}
// Deps is everything the control surface is allowed to touch. It is
// deliberately small: a database handle and a way to reach the Wails
// runtime context for event emission.
type Deps struct {
Logger *slog.Logger
DB *database.DB
// Context returns the live Wails application context. It is a
// function rather than a value because the context only exists
// after OnStartup, which is later than registration.
Context func() context.Context
}