Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ jobs:
restore-keys: |
${{ runner.os }}-template-provider-

- name: Check COVERAGE.md drift
run: cargo test --test coverage

- name: Test
run: RUST_BACKTRACE=1 cargo test --all-targets

Expand Down
2 changes: 1 addition & 1 deletion COVERAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ Reserved for a future Template Distribution Server suite. No scenarios yet.

## Suite Coverage

✅ = covered; ❌ = not covered. The short title next to each ID is informational; the [Scenario Catalog](#scenario-catalog) is authoritative.
✅ = covered; ❌ = not covered. The short title next to each ID is informational; the [Scenario Catalog](#scenario-catalog) is authoritative. This table is machine-checked against the scenario registry and each scenario's `/// Covers:` annotation by `tests/coverage.rs`; `cargo test --test coverage` fails on drift in either direction.

| Scenario IDs | Mining Protocol Server |
|---|---|
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ Set `SV2_TEST_ENDPOINT=host:port` (optionally `SV2_TEST_APP_TYPE`, `SV2_TEST_USE
One module per Sv2 message family under `src/scenarios/{common,mining,...}/`. Scenario IDs are the stable `Proto-MSG-N` references from `COVERAGE.md` (e.g. `"C-SCS-2 used-version-within-range"`). Each scenario is an async fn returning `ScenarioResult` with a `/// Covers: <ID>` doc comment.

Register it in the appropriate `entries()` fn in its submodule, then wire the submodule into the suite fn(s) in `src/scenarios/mod.rs`. Scenario fns are registered only once; suites compose them by inclusion, not duplication.

Finally, update `COVERAGE.md`: add a row to the Scenario Catalog if the ID is new, and mark the scenario ✅ in the Suite Coverage table. `cargo test --test coverage` fails when the registry, the `/// Covers:` annotations, and the documentation tables drift apart in either direction.
Loading
Loading