105 lines
5.5 KiB
Markdown
105 lines
5.5 KiB
Markdown
# Test Evidence: durable fix-branch documentation workflow
|
|
|
|
- **Test type:** Unit (documentation contract)
|
|
- **Requirement IDs:** `OPS-019`, `TST-009`, `TST-010`
|
|
- **Scenario IDs:** `AC-TST-001`
|
|
- **Test class/method:** Shell documentation contract: `fixBranchWorkflowRule`
|
|
- **Implementation commit:** `f013ad7707b36959ddca891fe0d52f81bba3ee80`
|
|
|
|
## Protected behavior
|
|
|
|
Targeted repairs use the realizable `work/fix/<feature>/<what-fix>` branch and
|
|
clean worktree from taskmaster-verified `main`. Contributor guidance must reject
|
|
the impossible `work/<feature>/fix/<what-fix>` form while persistent
|
|
`work/<feature>` refs exist.
|
|
|
|
## Test method
|
|
|
|
Use fixed-string repository searches rather than an artificial Java test. The
|
|
RED proves the required branch name was absent from the four contributor guides.
|
|
The GREEN checks every tracked guide and the design/plan records, then the
|
|
local requirements/SRS generator checks the unchanged requirement and use-case
|
|
counts.
|
|
|
|
## Hand-derived expected result
|
|
|
|
The required fix-branch spelling appears in all six tracked documentation
|
|
artifacts. The four contributor guides and design record identify the nested
|
|
form only as forbidden. The existing SRS generator must still report 260
|
|
requirements and 14 use cases.
|
|
|
|
## RED
|
|
|
|
**Command**
|
|
|
|
```text
|
|
rg -n -F 'work/fix/<feature>/<what-fix>' AGENTS.md README.md DEVELOPMENT.md TESTING.md
|
|
```
|
|
|
|
**Observed result**
|
|
|
|
```text
|
|
exit 1; no matching lines
|
|
```
|
|
|
|
The failure was expected: the required realizable repair-branch rule was absent
|
|
before this documentation change.
|
|
|
|
## GREEN
|
|
|
|
**Command**
|
|
|
|
```text
|
|
rg -n -F 'work/fix/<feature>/<what-fix>' AGENTS.md README.md DEVELOPMENT.md TESTING.md docs/superpowers/specs/2026-08-15-access-navigation-icon-intern-picker-design.md docs/superpowers/plans/2026-08-15-access-navigation-icon-intern-picker.md && rg -n -F 'work/<feature>/fix/<what-fix>' AGENTS.md README.md DEVELOPMENT.md TESTING.md docs/superpowers/specs/2026-08-15-access-navigation-icon-intern-picker-design.md docs/superpowers/plans/2026-08-15-access-navigation-icon-intern-picker.md
|
|
```
|
|
|
|
**Observed result**
|
|
|
|
```text
|
|
exit 0
|
|
AGENTS.md:123
|
|
README.md:131
|
|
DEVELOPMENT.md:68
|
|
TESTING.md:124
|
|
docs/superpowers/specs/2026-08-15-access-navigation-icon-intern-picker-design.md:17
|
|
docs/superpowers/plans/2026-08-15-access-navigation-icon-intern-picker.md:13
|
|
|
|
The nested form appears only in instructions that call it invalid, forbidden,
|
|
or a form not to use.
|
|
```
|
|
|
|
## Affected suite
|
|
|
|
**Command and result**
|
|
|
|
```text
|
|
node labtimesheet-docs-hub/ui-mockups/build-srs.cjs
|
|
node -e 'const fs=require("node:fs"); const checks=[["authoritative","labtimesheet-docs-hub/requirements-specification.md",/^\| ([A-Z]{2,4}-\d{3}) \|/gm],["explained","labtimesheet-docs-hub/explained/requirements-specification.md",/^\| ([A-Z]{2,4}-\d{3}) \|/gm],["simple","labtimesheet-docs-hub/explained/requirements-specification-simple.md",/^- \*\*([A-Z]{2,4}-\d{3}):\*\*/gm],["generated SRS","labtimesheet-docs-hub/software-requirements-specification.md",/^\| ([A-Z]{2,4}-\d{3}) \|/gm]]; for (const [name,file,pattern] of checks) { const ids=[...fs.readFileSync(file,"utf8").matchAll(pattern)].map(match=>match[1]); if (ids.length !== 260 || new Set(ids).size !== 260) throw new Error(`${name}: ${ids.length} rows, ${new Set(ids).size} unique`); console.log(`${name}: ${ids.length} rows, ${new Set(ids).size} unique IDs`); } const srs=fs.readFileSync("labtimesheet-docs-hub/software-requirements-specification.md","utf8"); const useCases=(srs.match(/^### 5\.\d+ UC-\d{2} —/gm)||[]).length; if (useCases !== 14) throw new Error(`SRS use cases: ${useCases}`); console.log(`generated SRS: ${useCases} use cases`);'
|
|
node -e 'const fs=require("node:fs"); const path=require("node:path"); let checked=0; const broken=[]; for (const file of process.argv.slice(1)) { const text=fs.readFileSync(file,"utf8"); for (const match of text.matchAll(/!?\[[^\]]*\]\(([^)]+)\)/g)) { const target=match[1].trim().replace(/^<|>$/g,"").split("#")[0].split("?")[0]; if (!target || /^[a-z][a-z0-9+.-]*:/i.test(target) || target.startsWith("//")) continue; checked += 1; if (!fs.existsSync(path.resolve(path.dirname(file), decodeURIComponent(target)))) broken.push(`${file}: ${target}`); } } if (broken.length) throw new Error(`Broken local Markdown links:\n${broken.join("\n")}`); console.log(`Local Markdown links: ${checked} resolved`);' AGENTS.md README.md DEVELOPMENT.md TESTING.md docs/superpowers/specs/2026-08-15-access-navigation-icon-intern-picker-design.md docs/superpowers/plans/2026-08-15-access-navigation-icon-intern-picker.md docs/tests/unit/fix-branch-workflow-documentation.md
|
|
git diff --check
|
|
```
|
|
|
|
The SRS regeneration and count assertion ran from the main root because the
|
|
ignored requirements hub is local authority there. The link assertion and
|
|
`git diff --check` ran from this fix worktree; the SRS generator also rejects a
|
|
broken local SRS target before it writes the generated file.
|
|
|
|
```text
|
|
Wrote labtimesheet-docs-hub/software-requirements-specification.md
|
|
Requirements: 260; use cases: 14; screens: 48; mockup embeds: 48
|
|
authoritative: 260 rows, 260 unique IDs
|
|
explained: 260 rows, 260 unique IDs
|
|
simple: 260 rows, 260 unique IDs
|
|
generated SRS: 260 rows, 260 unique IDs
|
|
generated SRS: 14 use cases
|
|
Local Markdown links: 7 resolved
|
|
git diff --check: exit 0
|
|
```
|
|
|
|
## External-test boundaries
|
|
|
|
This documentation contract does not create or manipulate Git branches, start
|
|
the application, or replace branch-owner review. It validates the durable rule
|
|
and SRS traceability only; a taskmaster still authorizes branch creation,
|
|
integration, and any push.
|