Harnesses: the null-sink cases other tests prove leave

The grblHAL harnesses keep what only a running controller shows; the
cases a host unit test in grblHAL-glowforge proves, and the log and
reply wording, leave.

- laser_lifecycle_test: test_arm_waits_for_the_fans goes. laser_arm_test
  case A4 (grblHAL-glowforge) proves the fan grace stretching the arm's
  acknowledgment budget, on the same arm path. The docstring names it.
- xy_mode_test: case_x32, case_invalid and the log checks go; the
  default, x16 and the low tick stay. xy_scale_test holds each mode's
  tick and the not-a-mode parse.
- planner_blocks_test: one restart, at $398 1000; the 400 pass and the
  fresh-store probe go.
- ctlport_test: test_poll_lf and test_crlf go (the CR LF poll stays); in
  test_sender_out the network turn-away goes (serial_test holds it), and
  the busy gating, the grant and the outlives-client part stay.
  test_port_dark is whole.
- mcode_test: the timeout case runs on the host build's 5 s
  GFMCODE_WAIT_S (grblHAL-glowforge's CI configures it; the image keeps
  30 s) and still shows the hold, at 5.1 s; 5 s outlasts the 3 s
  test_dark watches the wait; test_table refuses one form per
  parser branch. test_timeout_holds and test_dark stay.
- envelope_test: test_unset and test_bounds go (lens_home_test holds the
  clamp); test_armed and the open, apply and close cases stay.
- manual_home_test: the out-of-range offset block goes, a repeat of
  gfhome_clamp_home_mm (lens_home_test); the modal-M3 FIRE check and
  every release and energize case stay.
- cool_report_test: one non-hex secret and one CR LF injection stay;
  runner-malformed and the exact header-set checks go. A bad secret is
  never sent and a good one is.
- tray_test: test_offset keeps 20 mm; test_errors keeps a bad P and a
  bad axis; the frame shift, envelope, barrier, persistence, port op,
  unreferenced lens and camera home stay.

Proof: with grblHAL-glowforge's matching commit, the eleven harnesses
its CI runs pass under Linux against the null-sink build: nine on a
build with a 1 s M-code wait, and mcode_test and tray_test, the two
that wait at an M-code, on the 5 s build CI configures
(-DGFMCODE_WAIT_S=5.0). pyflakes reports nothing in the nine changed
files.

Push this before grblHAL-glowforge's commit.

Acceptance: none; host harnesses only.
This commit is contained in:
ScottW514
2026-10-13 21:20:31 -04:00
parent 520d62ac05
commit 8e1fe5090d
9 changed files with 66 additions and 216 deletions
+8 -14
View File
@@ -11,16 +11,16 @@ the route asks for it. This harness stands in for forgectrl's listener, runs
the null-sink controller against it, and reads every report as it arrives.
secret every report carries X-ForgeFIRM-Report with the secret it was
started with, and the request is otherwise as it always was
started with
none started with no secret, the reports carry no such header
malformed a value that is not 32 hex digits (short, a letter out of range,
a CR LF and a header of its own behind it) is never sent, and
nothing of it reaches the wire
malformed a value that is not 32 hex digits (a letter out of range, or a
CR LF and a header of its own behind it, 32 characters long) is
never sent, and nothing of it reaches the wire
runner the homing runner the controller starts is handed the secret (it
reports in the controller's place while a gfcloud $H holds the
machine, and the controller is quiet then), and the reports
still carry it afterwards; a controller with no secret, or with
one that is not 32 hex digits, hands the runner none
still carry it afterwards; a controller with no secret hands the
runner none
Usage: cool_report_test.py <path-to-grblHAL_glowforge>
"""
@@ -170,15 +170,11 @@ def run(name, secret, check, runner=False, handed=None):
def with_secret(name, r):
if r["headers"].get("x-forgefirm-report") != SECRET:
fail("[%s] a report without the secret: %s" % (name, r["headers"]))
if set(r["headers"]) != {"host", "connection", "content-length", "x-forgefirm-report"}:
fail("[%s] the report's headers changed: %s" % (name, sorted(r["headers"])))
def without(name, r):
if "x-forgefirm-report" in r["headers"] or "x-evil" in r["headers"] or b"Evil" in r["raw"]:
fail("[%s] a header that must not be sent: %s" % (name, r["headers"]))
if set(r["headers"]) != {"host", "connection", "content-length"}:
fail("[%s] the report's headers changed: %s" % (name, sorted(r["headers"])))
def main():
@@ -186,13 +182,11 @@ def main():
fail("no controller binary at %s" % BIN)
run("secret", SECRET, with_secret)
run("none", None, without)
for i, bad in enumerate(("short", SECRET[:-1] + "g", SECRET + "0", SECRET.upper(),
SECRET[:16] + "\r\nX-Evil: 1\r\nX-Pad: 12",
SECRET[:16] + "\r\nX-Evil: 1\r\nX:1"), 1): # the last is 32 long
for i, bad in enumerate((SECRET[:-1] + "g",
SECRET[:16] + "\r\nX-Evil: 1\r\nX:1"), 1): # the second is 32 long
run("malformed-%d" % i, bad, without)
run("runner", SECRET, with_secret, runner=True, handed=SECRET)
run("runner-none", None, without, runner=True)
run("runner-malformed", SECRET[:16] + "\r\nX-Evil: 1\r\nX:1", without, runner=True)
print("cool_report_test: all passed")