mirror of
https://github.com/openglow-org/forgefirm.git
synced 2026-09-27 16:51:12 -07:00
ScottW514
54e1689889
The cloud job tests enter cloud mode and stay there, by design, so a queue (or an operator) that goes on to a motion test reaches it with gfcloud as the controller and no grblHAL process to find: motion.step-timing-under-load failed on exactly that, before it touched the machine. Nothing in the runner put the machine into the mode a test needed; the baseline only preserved the mode it found. A test now declares `mode="grbl"` (or "cloud") in @test. The runner's pre pass, after the leftovers are handled and before the preserved state is captured, switches through POST /mode, waits for the supervisor to settle (controller running, motion verified) and for the Grbl port to answer, and fails the test with the reason when the mode cannot be established. Capturing after the switch means the post pass keeps the mode the test asked for, so the machine changes mode only where the next test asks for it and never between tests of the same mode. The cloud job tests keep managing their own entry (enter_cloud also waits for the service session) and declare nothing. Tagged: every motion.* test but the mode-agnostic liveness probe, the six laser.* tests, cooling.fans-quiet-after-motion, cloud.mode-switch and cloud.gfhome-homing (both start in GRBL mode). controller_pid() now says what mode forgectrl reports when the process is missing. The page shows the declared mode as a badge; the Grbl port probe moved to hw. Proof: tests/test_mode.py (switch_mode against the fake forgectrl, including a refused switch, a controller that never comes up and a port that never opens; the runner end to end from cloud mode, from grbl mode, an undeclared test, and a failed switch). 151 unit tests pass; the coverage lint is clean. No catalog consequence beyond the suite modules' own source hashes: the change is to how a test is started, not to what it proves.
47 lines
2.3 KiB
Markdown
47 lines
2.3 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_BENCH_DATA` | `<FORGETEST_DATA>/bench` | passed to bench tools: where they keep their data files (with `GF_HOST=127.0.0.1` and the panel token in `GF_TOKEN`) |
|
|
| `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, `mode` (the controller
|
|
mode the test needs; the runner switches to it first), `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.
|