Write framework usage guide #132

New Issue

2026-08-30T10:22:10+02:00

SirStone commented

2026-08-30 10:22:10 +02:00

Wayfinder child of: #126

Write a README.md in common_libs/test_framework/ documenting: how to add the framework to a garage's config.nims, how to write adversary bots, how to structure test folders, the runBattle() API, BattleResult fields, InitialPosition usage. Include the example from the example test ticket.

Blocked by: #131

Grilling Revisions

Document these architecture specifics:

External server mode (not embedded) — why, and what TANK_ROYALE_JAR env var is needed
tall.nim pattern for test discovery (nimble limitation)
outputFlags for debugging test failures
Stdout/stderr split — diagnostics on stderr, results on stdout
Bot directory auto-generation (no manual JSON/boot script needed)
Full BattleResult field reference with all score categories

**Wayfinder child of:** #126 Write a README.md in `common_libs/test_framework/` documenting: how to add the framework to a garage's config.nims, how to write adversary bots, how to structure test folders, the runBattle() API, BattleResult fields, InitialPosition usage. Include the example from the example test ticket. **Blocked by:** #131 ### Grilling Revisions **Document these architecture specifics:** - External server mode (not embedded) — why, and what `TANK_ROYALE_JAR` env var is needed - `tall.nim` pattern for test discovery (nimble limitation) - `outputFlags` for debugging test failures - Stdout/stderr split — diagnostics on stderr, results on stdout - Bot directory auto-generation (no manual JSON/boot script needed) - Full `BattleResult` field reference with all score categories

SirStone added the wayfinder:task label 2026-08-30 10:22:10 +02:00

SirStone referenced this issue

2026-08-30 11:46:07 +02:00

Wayfinder: Shared integration test framework for garages #126

SirStone commented

2026-08-30 11:46:14 +02:00

Spec additions from grilling

Document that this is a local development tool (no CI support planned).
Document nim c compilation requirement (not nimble build).
Include troubleshooting section for: zombie processes, timeout errors, missing Java/JRE.

## Spec additions from grilling - Document that this is a **local development tool** (no CI support planned). - Document `nim c` compilation requirement (not nimble build). - Include troubleshooting section for: zombie processes, timeout errors, missing Java/JRE.

SirStone commented

2026-08-30 12:05:56 +02:00