mirror of
https://github.com/Donchitos/Claude-Code-Game-Studios.git
synced 2026-10-16 10:17:06 +00:00
DonchitosandClaude Opus 5.5
b21fa0f7f2
Fix release for 1.1.1: the minimal path end to end, engine commands that run on Godot, Unity and Unreal, hook warnings you can see, and verdicts that say when they could not check. Details in CHANGELOG.md; upgrade steps in UPGRADING.md (v1.1.1 → v1.1.2). Fixes #67 Fixes #131 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WuJn2FdynEybfL5KC697nJ
195 lines
7.9 KiB
Markdown
195 lines
7.9 KiB
Markdown
# Skill Test Spec: /test-setup
|
|
|
|
## Skill Summary
|
|
|
|
`/test-setup [force]` scaffolds the test framework for the configured engine.
|
|
It reads `engine.name` from `project.yaml` (falling back to
|
|
`technical-preferences.md`) and stops with a `/setup-engine` redirect when
|
|
neither names an engine. It checks for existing infrastructure, presents a plan,
|
|
and asks "May I create these files? I will not overwrite any test files that
|
|
already exist at these paths." before writing.
|
|
|
|
It creates `tests/README.md`, `tests/smoke/critical-paths.md`,
|
|
`production/qa/evidence/`, `.github/workflows/tests.yml`, and the engine's test
|
|
root: for Godot `tests/unit/` and `tests/integration/` (placeholder files, and
|
|
no runner script — gdUnit4's `addons/gdUnit4/bin/GdUnitCmdTool.gd` is the
|
|
runner); for Unity `Assets/Tests/EditMode/` and `Assets/Tests/PlayMode/` with
|
|
their `.asmdef` files; for Unreal `Source/<Module>/Private/Tests/`. When the
|
|
infrastructure already exists it exits early unless `force` is passed, and
|
|
`force` only creates missing files — it never overwrites. No director gates
|
|
apply. The verdict is COMPLETE when the scaffold is in place.
|
|
|
|
---
|
|
|
|
## Static Assertions (Structural)
|
|
|
|
Checked against the SKILL.md by `/skill-test spec` — no fixture needed.
|
|
|
|
- [ ] Has required frontmatter fields: `name`, `description`, `argument-hint`, `user-invocable`, `allowed-tools`
|
|
- [ ] Has ≥2 phase headings
|
|
- [ ] Contains verdict keyword: COMPLETE
|
|
- [ ] Contains ask-before-write language before creating files ("May I create these files?")
|
|
- [ ] Has a next-step handoff (Phase 6 Next steps: `/qa-plan sprint`, `/smoke-check`)
|
|
|
|
---
|
|
|
|
## Director Gate Checks
|
|
|
|
None. `/test-setup` is a scaffolding utility. No director gates apply.
|
|
|
|
---
|
|
|
|
## Test Cases
|
|
|
|
### Case 1: Happy Path — Godot project, scaffolds GdUnit4 test structure
|
|
|
|
**Fixture:**
|
|
- `project.yaml` has `engine.name: Godot`
|
|
- `tests/` does not exist; `addons/gdUnit4/` is not installed; no CI workflow
|
|
- The user approves the plan
|
|
|
|
**Input:** `/test-setup`
|
|
|
|
**Expected behavior:**
|
|
1. Phase 1 reports "Engine: Godot. Test directory: not found. CI workflow: not found."
|
|
2. Phase 2 presents the plan: `tests/unit/`, `tests/integration/`, `tests/smoke/`,
|
|
`tests/README.md`, `production/qa/evidence/`, `.github/workflows/tests.yml` —
|
|
and no runner script
|
|
3. Skill asks "May I create these files? I will not overwrite any test files that
|
|
already exist at these paths."
|
|
4. On approval: `tests/unit/.gdignore_placeholder`,
|
|
`tests/integration/.gdignore_placeholder`, `tests/README.md` (with the
|
|
Installing GdUnit4 steps and the capital-U `addons/gdUnit4/` path),
|
|
`tests/smoke/critical-paths.md`, and a file under `production/qa/evidence/`
|
|
5. `.github/workflows/tests.yml` uses `godot-gdunit-labs/gdUnit4-action@v1`
|
|
with `version: 'installed'` and `checks: write`
|
|
6. The documented test command matches `coding-standards.md`'s CI command:
|
|
`godot --headless -s -d --remote-debug tcp://127.0.0.1:0 res://addons/gdUnit4/bin/GdUnitCmdTool.gd -a res://tests --ignoreHeadlessMode`
|
|
7. Phase 6 summary; verdict COMPLETE
|
|
|
|
**Assertions:**
|
|
- [ ] `tests/unit/`, `tests/integration/`, `tests/smoke/` and `production/qa/evidence/` all exist afterwards (each holds a written file)
|
|
- [ ] No custom runner script is written (the old hand-written runner loaded a file gdUnit4 never shipped and failed every run)
|
|
- [ ] The test command matches the coding-standards.md CI command
|
|
- [ ] Approval is asked before any file is created
|
|
- [ ] Verdict is COMPLETE
|
|
|
|
---
|
|
|
|
### Case 2: Unity Project — Scaffolds Unity Test Runner with asmdef
|
|
|
|
**Fixture:**
|
|
- `project.yaml` has `engine.name: Unity`
|
|
- `Packages/manifest.json` lists `com.unity.test-framework`
|
|
- No `Assets/Tests/`; the user approves the plan
|
|
|
|
**Input:** `/test-setup`
|
|
|
|
**Expected behavior:**
|
|
1. Skill reads engine → Unity; the Test Framework package check passes
|
|
2. The plan places unit and integration tests under `Assets/Tests/` — Unity
|
|
compiles only `Assets/` and `Packages/` — not under `tests/unit/`
|
|
3. Skill generates `Assets/Tests/EditMode/EditModeTests.asmdef` (Editor-only)
|
|
and `Assets/Tests/PlayMode/PlayModeTests.asmdef`
|
|
4. `.github/workflows/tests.yml` runs `game-ci/unity-test-runner@v4` for
|
|
`editmode` and `playmode`, and the `UNITY_LICENSE` secret is noted
|
|
5. The README's Running Unity tests note gives two runs — Edit Mode into
|
|
`test-results/editmode.xml`, Play Mode into `test-results/playmode.xml`
|
|
6. The Phase 6 gate note names Unity's test root (`Assets/Tests/EditMode/` and
|
|
`Assets/Tests/PlayMode/`), not `tests/unit/` and `tests/integration/`
|
|
7. Approval is asked before writing; verdict COMPLETE
|
|
|
|
**Assertions:**
|
|
- [ ] Tests are under `Assets/Tests/`, never `tests/` or a top-level `Tests/` (neither is compiled: 0 tests, "Passed")
|
|
- [ ] `.asmdef` files are generated
|
|
- [ ] EditMode and PlayMode runner config is present, in CI and as two local runs with separate results files
|
|
- [ ] The gate note names the Unity test root
|
|
- [ ] Verdict is COMPLETE
|
|
|
|
---
|
|
|
|
### Case 3: Infrastructure Already Exists — Early exit, nothing re-initialized
|
|
|
|
**Fixture:**
|
|
- Godot project; `tests/unit/`, `tests/integration/`, `.github/workflows/tests.yml`
|
|
and `addons/gdUnit4/bin/GdUnitCmdTool.gd` all exist
|
|
- No `force` argument
|
|
|
|
**Input:** `/test-setup`
|
|
|
|
**Expected behavior:**
|
|
1. Phase 1 reports "Engine: Godot. Test directory: found. CI workflow: found."
|
|
2. Skill says: "Test infrastructure appears to be in place. Re-run with
|
|
`/test-setup force` to regenerate. Proceeding will not overwrite existing test files."
|
|
3. No plan approval is requested and no file is written
|
|
|
|
**Assertions:**
|
|
- [ ] Skill does NOT re-initialize when the infrastructure exists
|
|
- [ ] The message points to `/test-setup force`
|
|
- [ ] No existing file is modified and no new file is written
|
|
|
|
---
|
|
|
|
### Case 4: No Engine Configured — Redirects to /setup-engine
|
|
|
|
**Fixture:**
|
|
- `project.yaml` has no `engine.name`; `technical-preferences.md` shows
|
|
`[TO BE CONFIGURED]` for Engine
|
|
|
|
**Input:** `/test-setup`
|
|
|
|
**Expected behavior:**
|
|
1. Skill checks `project.yaml`, then `technical-preferences.md` — no engine
|
|
2. Skill stops: "Engine not configured. Run `/setup-engine` first, then re-run `/test-setup`."
|
|
3. No directories or files are created
|
|
|
|
**Assertions:**
|
|
- [ ] Error message explicitly states engine is not configured
|
|
- [ ] `/setup-engine` is suggested as the next step
|
|
- [ ] No write tool is called
|
|
- [ ] Verdict is not COMPLETE (blocked state)
|
|
|
|
---
|
|
|
|
### Case 5: Director Gate Check — No gate; test-setup is a scaffolding utility
|
|
|
|
**Fixture:**
|
|
- Engine configured, tests/ does not exist
|
|
|
|
**Input:** `/test-setup`
|
|
|
|
**Expected behavior:**
|
|
1. Skill scaffolds and writes all test framework files
|
|
2. No director agents are spawned
|
|
3. No gate IDs appear in output
|
|
|
|
**Assertions:**
|
|
- [ ] No director gate is invoked
|
|
- [ ] No gate skip messages appear
|
|
- [ ] Verdict is COMPLETE without any gate check
|
|
|
|
---
|
|
|
|
## Protocol Compliance
|
|
|
|
- [ ] Reads the engine (`project.yaml`, then `technical-preferences.md`) before generating any scaffold
|
|
- [ ] Generates engine-appropriate test runner config and CI workflow (not generic)
|
|
- [ ] Puts unit and integration tests in the engine's test root (`tests/` for Godot, `Assets/Tests/` for Unity, `Source/<Module>/Private/Tests/` for Unreal)
|
|
- [ ] Creates `production/qa/evidence/` — the path the Phase 6 summary reports
|
|
- [ ] Asks approval before creating files
|
|
- [ ] Exits early when infrastructure exists; `force` creates only missing files and never overwrites
|
|
- [ ] Verdict is COMPLETE when scaffold is in place
|
|
|
|
---
|
|
|
|
## Coverage Notes
|
|
|
|
- Unreal Engine test scaffolding (`Source/<Module>/Private/Tests/README.md`, a
|
|
self-hosted Windows CI runner) is not separately fixture-tested.
|
|
- The `force` path on a partial scaffold (create only the missing files) is
|
|
covered by protocol compliance, not by its own case.
|
|
- The case where tests/ exists but is from a different engine (e.g., Unity tests
|
|
in a now-Godot project) is not tested.
|
|
- A Unity project without `com.unity.test-framework` (the skill asks to add the
|
|
version the installed editor bundles, never a copied number) is not tested.
|