mirror of
https://github.com/openglow-org/forgefirm.git
synced 2026-09-28 01:01:12 -07:00
ScottW514
c0f53a865f
A stdlib-only daemon on the dev image (HTTP :8090) that runs the acceptance catalog against the machine from a self-contained page, keeps the append-only result log under /data/forgetest, and exports the release artifact the gate reads. Tests declare kind (auto / operator / live), hardware (api / takeover), coverage globs, prerequisites, and core membership; a test's domain fingerprint is the hash of the manifest files its globs select plus the platform and its own implementation, so a PASS stays valid exactly while nothing it covers changed. Campaign rules: a FAIL ends the campaign, the core (image health, kernel latch and drills, one live emission witness) is never inherited, invalidate-all forces a full campaign, no SKIP. Live tests need the operator acknowledgment and the physical arm press through the controller; takeover tests stop forgectrl for the duration with a crash-recoverable marker; the tool never touches the laser latch. Catalog v1: 24 tests ported from the proven bench drills with their recorded pass criteria (image, kernel K1-K3 and fire A/B/U, forgectrl API and logs, motion incl. dead-man, cooling, live laser, camera, update, cloud). The bench tab lists every scripts/bench tool and runs the board-side ones as subprocesses (takeover tools wrapped). 44 host unit tests, including the gate verification fixtures. Installed only by forgefirm-image-dev, with the bench scripts under /usr/share/forgetest/bench.
45 lines
2.0 KiB
Markdown
45 lines
2.0 KiB
Markdown
# forgetest - the ForgeFIRM release acceptance tool
|
|
|
|
The daemon behind `http://<machine>:8090/` on the dev image: runs the
|
|
acceptance catalog against the machine, keeps the append-only result log,
|
|
decides which results still apply to the image that is running, exports
|
|
the release artifact `scripts/release.sh` gates on, and serves the bench
|
|
diagnostics page. The contract - catalog, campaigns, fingerprints,
|
|
inheritance, the gate, the coverage rule - is
|
|
[`docs/ACCEPTANCE.md`](../docs/ACCEPTANCE.md).
|
|
|
|
## Run the host tests
|
|
|
|
cd forgetest
|
|
python3 -m unittest discover -s tests -v
|
|
|
|
## Run the daemon on a workstation (against a mock or a manifest file)
|
|
|
|
FORGETEST_DATA=/tmp/ft FORGETEST_MANIFEST=../tree-manifest.json \
|
|
FORGECTRL_URL=http://<machine>:8080 python3 -m forgetest --port 8090
|
|
|
|
`scripts/manifest-from-tree.py` produces `tree-manifest.json` from the recipe
|
|
pins; the coverage lint is `python3 -m forgetest.coverage --manifest ...`.
|
|
|
|
## Environment
|
|
|
|
| Variable | Default | Purpose |
|
|
|---|---|---|
|
|
| `FORGETEST_DATA` | `/data/forgetest` | results.jsonl, bench.jsonl, token, export/ |
|
|
| `FORGETEST_MANIFEST` | `/etc/forgefirm-manifest.json` | the image manifest |
|
|
| `FORGETEST_PORT`, `FORGETEST_HOST` | 8090, 0.0.0.0 | listener |
|
|
| `FORGETEST_BENCH_DIR` | `/usr/share/forgetest/bench` | the installed bench scripts |
|
|
| `FORGETEST_MARKER` | `/run/forgetest.active` | takeover marker |
|
|
| `FORGECTRL_URL`, `FORGECTRL_TOKEN_FILE` | `http://127.0.0.1:8080`, `/data/forgefirm/panel.token` | forgectrl client |
|
|
| `GF_SYSFS_ROOT` | `/sys/glowforge/` | kernel module sysfs |
|
|
| `GRBL_HOST`, `GRBL_PORT` | 127.0.0.1, 23 | Grbl TCP |
|
|
|
|
## Adding a test
|
|
|
|
Register it in the subsystem module under `forgetest/suite/` with
|
|
`@test(...)`: id `subsystem.name`, kind, hardware, `covers`, `requires`,
|
|
`always`, steps. The body gets a `Context` (`log`, `check`, `fail`,
|
|
`prompt`, `confirm`, `instruct`, `sleep`, `evidence`, `forgectrl`, `sysfs`,
|
|
`grbl`, `takeover`). Return normally for PASS, raise `runner.Failed` for
|
|
FAIL. Then run the unit tests and the coverage lint.
|