Documentation
¶
Overview ¶
Command coverage produces a markdown report linking parity scenarios to docs/parity/PORT_MAP.md entries.
Usage:
# 1. Run the suite with JSON output
go test -tags=parity ./test/parity/runner -v -args -pig-parity.results=/tmp/parity.json
# 2. Generate the report
go run ./test/parity/cmd/coverage \
-results /tmp/parity.json \
-port-map docs/parity/PORT_MAP.md \
-scenarios test/parity/scenarios -out /tmp/coverage.md
The report shows, for every upstream file in docs/parity/PORT_MAP.md:
- the port status as recorded in docs/parity/PORT_MAP.md
- how many scenarios reference it via `covers = [...]`
- whether the last run was green
A `cov:0` row means: file is ported but unverified by the parity suite. Orphan references are ordered by scenario name and then upstream path.
Click to show internal directories.
Click to hide internal directories.