plans: four labs teach four features, and nothing says which #2288

Merged
jaylouisw merged 1 commit from plan/1120-0937 into main 2026-11-20 10:08:31 +00:00
Owner

Forward plan only, no code. docs/plans/example-labs.md.

Four labs, 19 devices, 16 links. Across all four documents: one static route, two vlans maps,
four trunk ports, every protocol key null, no flows, no dhcp lease, and all 16 links
lengthM: null. Meanwhile the engine carries ten protocol modules, 6,464 lines, each with its own
suite - and no doc names a lab (grep -rn "examples/lab" docs/*.md README.md returns nothing).

Ranked weaknesses, with the two that matter first:

  1. Three of four labs assert no behaviour - test/examples-generated.test.js:42 says
    files.length >= 4, and the expect map at :96-98 names lab1 and lab2 only, so lab3
    and lab4 are covered by "the JSON round-trips".
  2. The generator's self-check cannot fail - examples/build-examples.js:147-157 resolves a probe
    by filename prefix, prints PING FAILED and exits 0; process.exitCode appears nowhere in the
    file, and CI runs it.

Nine steps: declared probe + exit code (S); suite reads the same table, with lab4's Fa0/8 Altn BLK as its fact (S); lab6 OSPF multi-area (M); lab7 eBGP (M); lab8 VRRP failover (M);
lab9 LAG/trunk (S); lab10 40 km fibre, the first lab where lengthM is not null (S); a
module-to-lab coverage gate (M, needs Jay's approval); examples/README.md + one README table (S).

Probed working today on generic-router: OSPF adjacency FULL/DR, eBGP 1 of 1 neighbour(s) established, channel-group 1 mode active bundling. lab5-dual-homed-edge.json is deliberately
left alone - docs/UPSTREAM-DESIGN.md:699 (P6) names that file and depends on P0-P5, none of
which exists outside the design doc, so numbering starts at lab6.

Closes no open issue: the queue is #130 and #803, both device requests.

Forward plan only, no code. `docs/plans/example-labs.md`. Four labs, 19 devices, 16 links. Across all four documents: one static route, two `vlans` maps, four trunk ports, every protocol key null, no `flows`, no `dhcp` lease, and all 16 links `lengthM: null`. Meanwhile the engine carries ten protocol modules, 6,464 lines, each with its own suite - and no doc names a lab (`grep -rn "examples/lab" docs/*.md README.md` returns nothing). Ranked weaknesses, with the two that matter first: 1. Three of four labs assert no behaviour - `test/examples-generated.test.js:42` says `files.length >= 4`, and the `expect` map at `:96-98` names `lab1` and `lab2` only, so `lab3` and `lab4` are covered by "the JSON round-trips". 2. The generator's self-check cannot fail - `examples/build-examples.js:147-157` resolves a probe by filename prefix, prints `PING FAILED` and exits 0; `process.exitCode` appears nowhere in the file, and CI runs it. Nine steps: declared probe + exit code (S); suite reads the same table, with `lab4`'s `Fa0/8 Altn BLK` as its fact (S); `lab6` OSPF multi-area (M); `lab7` eBGP (M); `lab8` VRRP failover (M); `lab9` LAG/trunk (S); `lab10` 40 km fibre, the first lab where `lengthM` is not null (S); a module-to-lab coverage gate (M, needs Jay's approval); `examples/README.md` + one README table (S). Probed working today on `generic-router`: OSPF adjacency `FULL/DR`, eBGP `1 of 1 neighbour(s) established`, `channel-group 1 mode active` bundling. `lab5-dual-homed-edge.json` is deliberately left alone - `docs/UPSTREAM-DESIGN.md:699` (P6) names that file and depends on P0-P5, none of which exists outside the design doc, so numbering starts at `lab6`. Closes no open issue: the queue is #130 and #803, both device requests.
plans: four labs teach four features, and nothing says which
All checks were successful
CI / Classify the change (pull_request) Successful in 14s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 11s
CI / Server smoke and Docker build (pull_request) Successful in 25s
CI / Test (Node 22) (pull_request) Successful in 56s
CI / Test (Node 20) (pull_request) Successful in 58s
CI / Test (Node 18) (pull_request) Successful in 1m3s
CI / Arm auto-merge (pull_request) Successful in 4s
b374a20fdf
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-20 09:44:33 +00:00
jaylouisw deleted branch plan/1120-0937 2026-11-20 10:08:33 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!2288
No description provided.