Skip to content

Commit 0ae181f

Browse files
committed
test: Stage 6
1 parent d8b9d7f commit 0ae181f

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ Basic workflow:
4545
- from codetracer_python_recorder import hello
4646
- hello()
4747

48+
#### Testing & Coverage
49+
50+
- Run the full split test suite (Rust nextest + Python pytest): `just test`
51+
- Run only Rust integration/unit tests: `just cargo-test`
52+
- Run only Python tests (including the pure-Python recorder to guard regressions): `just py-test`
53+
- Collect coverage artefacts locally (LCOV + Cobertura/JSON): `just coverage`
54+
55+
The CI workflow mirrors these commands. Pull requests get an automated comment with the latest Rust/Python coverage tables and downloadable artefacts (`lcov.info`, `coverage.xml`, `coverage.json`).
56+
4857
### Future directions
4958

5059
The current Python support is an unfinished prototype. We can finish it. In the future, it may be expanded to function in a way to similar to the more complete implementations, e.g. [Noir](https://github.com/blocksense-network/noir/tree/blocksense/tooling/tracer).

codetracer-python-recorder/tests/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ CI configuration:
3434
in `codetracer-python-recorder/target/coverage/python/`.
3535
- `just coverage` is a convenience wrapper that invokes both commands in sequence.
3636

37+
CI runs the same helper and posts a coverage summary comment on pull requests so
38+
reviewers can see the per-file breakdown without downloading artefacts.
39+
3740
All commands create their output directories on first run, so no manual setup is
3841
required beyond entering the Nix shell (`nix develop`) or syncing the UV virtual
3942
environment (`just venv`).

design-docs/adr/0003-test-suite-governance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ADR 0003: Test Suite Governance for codetracer-python-recorder
22

3-
- **Status:** Proposed
3+
- **Status:** Accepted
44
- **Date:** 2025-10-02
55
- **Deciders:** Platform / Runtime Tracing Team
66
- **Consulted:** Python Tooling WG, Developer Experience WG
@@ -67,7 +67,7 @@ We will adopt a tiered test governance model and reorganise the repository to ma
6767

6868
## Status Tracking
6969

70-
- This ADR is **Proposed**. It becomes **Accepted** once the restructuring PR and the initial coverage additions (TraceSessionBootstrap, TraceOutputPaths, ActivationController, Python facade helpers) are merged and `just test` runs green with the new layout.
70+
- This ADR is **Accepted**. Directory restructuring, unit/integration coverage for the targeted modules, and the split CI/coverage jobs have landed; future adjustments will be tracked in follow-up ADRs if required.
7171

7272
## Alternatives Considered
7373

design-docs/test-suite-improvement-plan.status.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@
1717
- ✅ Stage 5 – CI & Coverage Instrumentation: CI now runs the split Rust/Python
1818
test jobs plus a non-blocking coverage job that reuses `just coverage`, uploads
1919
LCOV/XML/JSON artefacts, and posts a per-PR summary comment.
20-
- ⏳ Stage 6 – Cleanup & Documentation: not started.
20+
- ✅ Stage 6 – Cleanup & Documentation: ADR 0003 is now Accepted, top-level
21+
docs describe the testing/coverage workflow, and the tests README references
22+
the CI coverage comment for contributors.
2123

2224
## Next Actions
23-
1. Evaluate coverage report stability and prepare enforcement thresholds before
24-
Stage 6.
25+
Plan complete; monitor coverage baselines and propose enforcement thresholds in
26+
a follow-up task.

0 commit comments

Comments
 (0)