b723e2bd7d
- Created skills/ directory - Moved 272 skills to skills/ subfolder - Kept agents/ at root level - Kept installation scripts and docs at root level Repository structure: - skills/ - All 272 skills from skills.sh - agents/ - Agent definitions - *.sh, *.ps1 - Installation scripts - README.md, etc. - Documentation Co-Authored-By: Claude <noreply@anthropic.com>
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# Testing Strategy
|
|
|
|
This project is small, runs in a terminal, and is mostly deterministic. The testing strategy focuses on fast, reliable checks that validate core behavior and provide a safe merge gate for PRs.
|
|
|
|
## Goals
|
|
|
|
- Validate core logic (parsing, aggregation, formatting) deterministically.
|
|
- Catch regressions in the HUD output without relying on manual review.
|
|
- Keep test execution fast (<5s) to support frequent contributor runs.
|
|
|
|
## Test Layers
|
|
|
|
1) Unit tests (fast, deterministic)
|
|
- Pure helpers: `getContextPercent`, `getModelName`, token/elapsed formatting.
|
|
- Render helpers: string assembly and truncation behavior.
|
|
- Transcript parsing: tool/agent/todo aggregation and session start detection.
|
|
|
|
2) Integration tests (CLI behavior)
|
|
- Run the CLI with a sample stdin JSON and a fixture transcript.
|
|
- Validate that the rendered output contains expected markers (model, percent, tool names).
|
|
- Keep assertions resilient to minor formatting changes (avoid strict full-line matching).
|
|
|
|
3) Golden-output tests (near-term)
|
|
- For known fixtures, compare the full output snapshot to catch subtle UI regressions.
|
|
- Update snapshots only when intentional output changes are made.
|
|
|
|
## What to Test First
|
|
|
|
- Transcript parsing (tool use/result mapping, todo extraction).
|
|
- Context percent calculation (including cache tokens).
|
|
- Truncation and aggregation (tools/todos/agents display logic).
|
|
- Malformed or partial input (bad JSON lines, missing fields).
|
|
|
|
## Fixtures
|
|
|
|
- Keep shared test data under `tests/fixtures/`.
|
|
- Use small JSONL files that capture one behavior each (e.g., basic tool flow, agent lifecycle, todo updates).
|
|
|
|
## Running Tests Locally
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
This runs `npm run build` and then executes Node's built-in test runner.
|
|
|
|
To generate coverage:
|
|
|
|
```bash
|
|
npm run test:coverage
|
|
```
|
|
|
|
To update snapshots:
|
|
|
|
```bash
|
|
npm run test:update-snapshots
|
|
```
|
|
|
|
## CI Gate (recommended)
|
|
|
|
- `npm ci`
|
|
- `npm run build`
|
|
- `npm test`
|
|
|
|
The provided GitHub Actions workflow runs `npm run test:coverage` on Node 18 and 20.
|
|
|
|
These steps should be required in PR checks to ensure new changes do not regress existing behavior.
|
|
|
|
## Contributing Expectations
|
|
|
|
- Add or update tests for behavior changes.
|
|
- Prefer unit tests for new helpers and integration tests for user-visible output changes.
|
|
- Keep tests deterministic and avoid time-dependent assertions unless controlled.
|