Add docs/verification/test-strategy.md documenting Section 12 methodology #123

Open
opened 2026-05-28 09:06:48 -03:00 by navigator · 3 comments
Owner

Goal

Write a single concise document at docs/verification/test-strategy.md capturing the verification methodology from PLAN.md Section 12 in a contributor-facing format. This becomes the canonical reference for area:verification work and gives per-module SPEC.md files a single coverage/test policy to point at.

Sections to include:

  • Test pyramid (system 10% / integration 25% / unit 50% / formal 15%)
  • Tooling matrix (chiseltest, Cocotb, Verilator, Spike, Yosys-SBY)
  • Per-module requirements checklist (SPEC.md, unit bench, golden model, coverage targets)
  • PopLink-specific verification expectations (single-link, multi-VC, torus, formal, BER)
  • CI lane summary referencing the four-tier CI (fast / standard / nightly / weekly) with time budgets
  • Sign-off criteria before tapeout

Acceptance criteria

  • docs/verification/test-strategy.md exists
  • Document mirrors PLAN.md Section 12 structure but in contributor-facing language
  • Coverage targets stated: >=85% line / >=70% condition per module; >=95% line / >=85% condition for tapeout sign-off
  • CI lane table includes time budgets (5min / 30min / 4h / 24h) WITHOUT touching .forgejo/workflows/**
  • Cross-references PLAN.md Section 12 explicitly
  • docs/verification/README.md created or updated to list this document
  • No fabricated tool versions or commands — describe intent, not specific runner invocations

Plan refs

Section 12 (all subsections); Section 8.3 (testbench plan acceptance criteria)

Notes

Documentation only — does NOT modify CI workflows (off-limits per ADR-017). The doc describes what CI should run; actual workflow YAML stays for Marcos to wire up. Keep it tight (single readable page) so contributors actually read it.

## Goal Write a single concise document at `docs/verification/test-strategy.md` capturing the verification methodology from PLAN.md Section 12 in a contributor-facing format. This becomes the canonical reference for `area:verification` work and gives per-module SPEC.md files a single coverage/test policy to point at. Sections to include: - Test pyramid (system 10% / integration 25% / unit 50% / formal 15%) - Tooling matrix (chiseltest, Cocotb, Verilator, Spike, Yosys-SBY) - Per-module requirements checklist (SPEC.md, unit bench, golden model, coverage targets) - PopLink-specific verification expectations (single-link, multi-VC, torus, formal, BER) - CI lane summary referencing the four-tier CI (fast / standard / nightly / weekly) with time budgets - Sign-off criteria before tapeout ## Acceptance criteria - [ ] `docs/verification/test-strategy.md` exists - [ ] Document mirrors PLAN.md Section 12 structure but in contributor-facing language - [ ] Coverage targets stated: >=85% line / >=70% condition per module; >=95% line / >=85% condition for tapeout sign-off - [ ] CI lane table includes time budgets (5min / 30min / 4h / 24h) WITHOUT touching `.forgejo/workflows/**` - [ ] Cross-references PLAN.md Section 12 explicitly - [ ] `docs/verification/README.md` created or updated to list this document - [ ] No fabricated tool versions or commands — describe intent, not specific runner invocations ## Plan refs Section 12 (all subsections); Section 8.3 (testbench plan acceptance criteria) ## Notes Documentation only — does NOT modify CI workflows (off-limits per ADR-017). The doc describes what CI should run; actual workflow YAML stays for Marcos to wire up. Keep it tight (single readable page) so contributors actually read it.
Author
Owner
No description provided.
<!-- agent:claim by=dispatcher run=20260528T120846Z_issue123 ts=1779970127 -->
Author
Owner

All acceptance criteria for this issue are already satisfied on main by merged PR #36 (586a79d, 2026-05-24):

  • docs/verification/test-strategy.md — present, 109 lines, mirrors PLAN.md Section 12.1–12.7 in contributor-facing language.
  • Coverage targets stated: ≥85% line / ≥70% condition per module (§4); ≥95% line / ≥85% condition for tapeout sign-off (§8).
  • CI lane table with the exact required time budgets — 5 min / 30 min / 4 h / 24 h (§7) — and no touch to .forgejo/workflows/**.
  • Cross-references to PLAN.md Section 12 in the header and at each major section.
  • docs/verification/README.md — present, indexes test-strategy.md.
  • No fabricated tool versions or runner-specific invocations.

Delta against the issue body checklist: every box is already green. Recommended resolution: close as duplicate of PR #36 / its tracking issue, or — if Marcos wants to extend the doc beyond the current acceptance list (e.g. per-tier owner table, coverage exemption registry, formal-proof catalog) — re-scope the issue with the new criteria so a non-empty PR can be produced.

No PR pushed; no changes staged in this worktree.

<!-- agent:fail reason=blocker:already-merged --> All acceptance criteria for this issue are already satisfied on `main` by merged PR #36 (`586a79d`, 2026-05-24): - `docs/verification/test-strategy.md` — present, 109 lines, mirrors PLAN.md Section 12.1–12.7 in contributor-facing language. - Coverage targets stated: ≥85% line / ≥70% condition per module (§4); ≥95% line / ≥85% condition for tapeout sign-off (§8). - CI lane table with the exact required time budgets — 5 min / 30 min / 4 h / 24 h (§7) — and no touch to `.forgejo/workflows/**`. - Cross-references to PLAN.md Section 12 in the header and at each major section. - `docs/verification/README.md` — present, indexes `test-strategy.md`. - No fabricated tool versions or runner-specific invocations. Delta against the issue body checklist: every box is already green. Recommended resolution: close as duplicate of PR #36 / its tracking issue, or — if Marcos wants to extend the doc beyond the current acceptance list (e.g. per-tier owner table, coverage exemption registry, formal-proof catalog) — re-scope the issue with the new criteria so a non-empty PR can be produced. No PR pushed; no changes staged in this worktree.
Author
Owner
No description provided.
<!-- agent:fail reason=no-pr-marker run=20260528T120846Z_issue123 -->
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Fluid/fluidpop-v1#123
No description provided.