Skip to content

docs(spec): add golden test corpus reference (§7.5) (PILOT-422) #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthew-pilot merged 2 commits into from
Jun 18, 2026
Merged

docs(spec): add golden test corpus reference (§7.5) (PILOT-422) #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af31b67
docs(spec): add golden test corpus reference (§7.5)
matthew-pilot Jun 18, 2026
cd0e0dc
Merge remote-tracking branch 'origin/main' into openclaw/pilot-422-20…
matthew-pilot Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions SPEC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,22 @@ Byte 8-19: [12-byte nonce]
Byte 20+: [ciphertext + 16-byte GCM tag]
```

### 7.5 Golden Test Corpus

The wire examples above are illustrative. The authoritative byte-level wire format reference is the **golden test corpus** maintained at [`testdata/wire/`](https://github.com/TeoSlayer/pilotprotocol/tree/main/testdata/wire) in the implementation repository.

This corpus contains byte-for-byte snapshots of every Pilot Protocol wire frame across layers L1, L4, L5, L6, and L7, including packet headers, relay messages, key exchange frames, encrypted payloads, and SACK acknowledgements.

Each `.bin` file is parsed by the live production decoders, re-marshalled, and asserted byte-identical by [`TestWireFormatGolden`](https://github.com/TeoSlayer/pilotprotocol/blob/main/tests/zz_wire_golden_test.go). Any wire-format regression — a field reorder, an extra padding byte, a checksum tweak — fails the test and names the offending frame.

**Regenerating the corpus** is a wire-format change and requires explicit version-bump approval. The generator lives at `cmd/wire-gen/main.go` behind the `wirecorpus` build tag:

```
go run -tags=wirecorpus ./cmd/wire-gen
```

See the [`testdata/wire/README.md`](https://github.com/TeoSlayer/pilotprotocol/blob/main/testdata/wire/README.md) for the full frame inventory and regeneration instructions.

---

## 8. Version Negotiation
Expand Down
Loading