Stop the README advertising DHCP and VRRP that the simulator never calls #1054

Merged
jaylouisw merged 1 commit from fix/readme-protocols into main 2026-11-08 08:23:42 +00:00
Owner

The most-read file in the repository was the least accurate one.

Claim Reality
Protocols: "DHCP client + server" grep -c dhcp engine/simulator.js → 0. ip address dhcp sets a flag; no lease ever arrives.
Protocols: "VRRP" same grep → 0. No device answers for a virtual IP.
CLI: "ip dhcp pool" does not exist in engine/cli.js.
CLI: "vrrp" grep -c vrrp engine/cli.js → 0. There is no such command.

docs/SIMULATION.md §5.1 has documented DHCP as absent from the data path the whole time, with the
grep that proves it. The README was the only document claiming otherwise — and the only one a
newcomer reads first.

This is the same defect class as a switch whose description promises 10G SFP+ uplinks it lacks: a
document disagreeing with the hardware is a bug, not a preference. The cost is different — a wrong
README wastes a person's afternoon rather than a lab's cable.

What changed

  • The protocol list now names only what engine/simulator.js actually requires: ARP, IPv4, ICMP
    (echo + errors), traceroute, DNS, NAT, ACLs, OSPF, BGP, SCION, IPv6 SLAAC/RA, LLDP, STP, 802.1Q,
    LACP.
  • The CLI row lists only real commands, including the new ping ... at <ms> and converge.
  • A What this does not model yet section, with an issue number for each gap (#1051 DHCP,
    #1052 VRRP), so the honesty is maintained by the same rule as every other exemption here: no gap
    survives without a tracker.

The two gaps are filed as the wiring work they are, not as wishes. DHCP in particular is a complete,
tested library sitting one require away from the data path.

97 suites, 4740 assertions, all passing.

Closes #1053.

The most-read file in the repository was the least accurate one. | Claim | Reality | |---|---| | Protocols: "DHCP client + server" | `grep -c dhcp engine/simulator.js` → **0**. `ip address dhcp` sets a flag; no lease ever arrives. | | Protocols: "VRRP" | same grep → **0**. No device answers for a virtual IP. | | CLI: "`ip dhcp pool`" | does not exist in `engine/cli.js`. | | CLI: "`vrrp`" | `grep -c vrrp engine/cli.js` → **0**. There is no such command. | `docs/SIMULATION.md` §5.1 has documented DHCP as absent from the data path the whole time, with the grep that proves it. The README was the only document claiming otherwise — and the only one a newcomer reads first. This is the same defect class as a switch whose description promises 10G SFP+ uplinks it lacks: a document disagreeing with the hardware is a bug, not a preference. The cost is different — a wrong README wastes a person's afternoon rather than a lab's cable. ## What changed - The protocol list now names only what `engine/simulator.js` actually requires: ARP, IPv4, ICMP (echo + errors), traceroute, DNS, NAT, ACLs, OSPF, BGP, SCION, IPv6 SLAAC/RA, LLDP, STP, 802.1Q, LACP. - The CLI row lists only real commands, including the new `ping ... at <ms>` and `converge`. - A **What this does not model yet** section, with an issue number for each gap (#1051 DHCP, #1052 VRRP), so the honesty is maintained by the same rule as every other exemption here: no gap survives without a tracker. The two gaps are filed as the wiring work they are, not as wishes. DHCP in particular is a complete, tested library sitting one `require` away from the data path. **97 suites, 4740 assertions, all passing.** Closes #1053.
Stop the README advertising DHCP and VRRP that the simulator never calls
Some checks are pending
CI / Test (Node 22) (pull_request) Has started running
CI / Docker build (pull_request) Has started running
CI / Test (Node 20) (pull_request) Successful in 2m39s
CI / Test (Node 18) (pull_request) Has started running
CI / Server smoke test (pull_request) Has started running
175da8894f
The protocol table listed DHCP client + server and VRRP, and the CLI row listed ip dhcp pool and
vrrp. engine/simulator.js requires neither library:

  grep -c 'dhcp' engine/simulator.js              -> 0
  grep -c 'vrrp' engine/simulator.js engine/cli.js -> 0 and 0

A host configured with 'ip address dhcp' sets a flag and stays unaddressed forever, and there is no
vrrp command in the CLI at all. docs/SIMULATION.md 5.1 has documented DHCP as absent from the data
path the whole time - the README was the only thing claiming otherwise, which is the worst place for
it to be wrong because it is the first thing anyone reads.

The protocol list now names only what engine/simulator.js actually requires, and a new 'What this
does not model yet' section names DHCP (#1051) and VRRP (#1052) with their issues, alongside the
remaining timing and application-layer gaps.

Closes #1053.
jaylouisw deleted branch fix/readme-protocols 2026-11-08 08:23:43 +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!1054
No description provided.