Files
meshcore-spec/versions/v0.1.0/corpus/companion/framing.json
T
swaitsandClaude Opus 4.7 9232c16f7c
mdBook / build (push) Canceled after 0s
mdBook / deploy (push) Canceled after 0s
feat(versioning): snapshot corpus per spec version
A frozen spec is only meaningful if it's paired with the corpus
that was current at release time — otherwise a v0.1.0 reader
follows "see corpus/payloads/ack/" and lands on a file whose
test vectors may have changed since v0.1.0 was cut.

Three changes:

1. `cut-version` now copies BOTH src/ AND corpus/ into the
   snapshot directory. A release is the pair, not just the text.

2. The corpus URL rewriting in cut-version now retargets
   /tree/main/corpus -> /tree/main/versions/<v>/corpus (and the
   blob variant). This lets the link resolve on GitHub from main
   alone — no git tag required, since the frozen copy is a real
   path under main. Downgrades the "tag is REQUIRED" message from
   last commit back to "optionally tag the commit".

3. The frozen corpus's spec_ref fields get rewritten too: from
   `src/04-payload-ack.md` to `versions/<v>/04-payload-ack.md`,
   so a reader following a test vector lands on the spec text the
   vector was paired with at release time.

versions/v0.1.0/ regenerated from scratch via `just cut-version v0.1.0`
to pick up the corpus snapshot + the new sed patterns. The release
is now self-consistent: v0.1.0 spec links go to v0.1.0 corpus, which
links back to v0.1.0 spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-12 10:38:02 -06:00

75 lines
1.8 KiB
JSON

{
"$schema": "../schema/test-vector.schema.json",
"name": "Companion Protocol - Framing",
"spec_ref": "versions/v0.1.0/18-companion-protocol.md",
"protocol_version": 0,
"description": "Tests companion protocol frame encoding: type byte followed by variable-length data.",
"vectors": [
{
"id": "comp-001",
"description": "CMD_APP_START (0x01) - no data",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "01"
}
},
"binary": "3D 00 01",
"notes": "Companion command type 0x01 = CMD_APP_START. No payload data."
},
{
"id": "comp-002",
"description": "CMD_DEVICE_QUERY (0x02) - no data",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "02"
}
},
"binary": "3D 00 02"
},
{
"id": "comp-003",
"description": "CMD_SET_TIME (0x08) with timestamp",
"type": "encode_decode",
"structured": {
"header": {
"version": 0,
"payload_type": "raw_custom",
"route_type": "flood"
},
"path": {
"hash_size": 1,
"hash_count": 0,
"hashes": []
},
"payload": {
"data": "08 00F15365"
}
},
"binary": "3D 00 08 00F15365",
"notes": "CMD_SET_TIME with timestamp 1700000000 = 0x6553F100 LE = 00F15365."
}
]
}