Test writing guide
Skill nowsprinting/unity-coding-skills/skills/test-writing-guide
Provides guidelines for writing test code for Unity projects. Make sure to use this skill whenever writing, creating, editing, or modifying test code files (files under Tests/). This includes implementing new tests, fixing test failures, adding test cases, or any task that results in test code changes. Even for small edits or one-line fixes, load this skill to ensure test conventions are followed.From its SKILL.md
npx -y skills add nowsprinting/unity-coding-skills --skill test-writing-guideAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 20 stars20 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its file declares
Copied from the file, not written here
The file declares its own license as Unlicense. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
9.8 KB, as published. Nobody here has run it
Guide for writing test code for Unity projects.
Rules
- Before modifying any test file, check if the editor is in Play Mode. If it is, stop it using the
unity_play_controltool first. - Never create
.metafiles. Unity editor creates them automatically. - When a test creates a
GameObjector instantiates a prefab, add[CreateScene]to the test method (not required if[LoadScene]is already present). - When adding a test seam to production code (e.g., an
internalaccessor or a virtual override point to support injection), always wrap it with#if UNITY_INCLUDE_TESTS…#endifso it is excluded from non-test builds:#if UNITY_INCLUDE_TESTS internal void SetStateForTest(State state) => _state = state; #endif
Categories
- When implementing tests designed as integration tests, add
[Category("Integration")]to the test method. - When implementing tests designed as visual verification tests, add
[Category("VisualVerification")]to the test method. - When implementing tests designed as acceptance tests (marked
(acceptance test)in the test case design), add[Category("Acceptance")]to the test method. - For test methods that test the
internalvisibility method, add[Category("Internal")]. - For test methods that depend on animation timing or other timing-sensitive conditions that may cause instability on slow CPUs, add
[Category("IgnoreCI")]. - For test methods that specify the
GameViewResolutionattribute, add[Category("IgnoreCI")].
Multi-frame tests
When a game mechanic across frames (e.g., playing a card and waiting for its resolution), wait for the step to finish before asserting — not at a fixed frame count.
await DragCard(Cards[1], Enemies[0]);
while (battleDirector.IsPlaying) // wait until the played action fully resolves
await Awaitable.NextFrameAsync();
Assert.That(battleState.Enemies[0].Hp, Is.LessThan(hpBefore));
- To confirm step completion, use a production-side state machine or a "busy" signal (
IsPlaying, coroutine flag, etc.). Do not use a fixed number of frames orWaitForSeconds. - When UniTask is available,
UniTask.WaitUntilandUniTask.WaitUntilValueChangedare alternatives to thewhileloop:await UniTask.WaitUntil(() => isActive == false); await UniTask.WaitUntilValueChanged(this, x => x.isActive); - When an operation triggers a deferred
Destroyor UI rebuild, advance one extraawait Awaitable.NextFrameAsync()before asserting on the new hierarchy.
UI Tests
Layout assertion tests: verify UI layout with deterministic assertions
When a layout requirement is expressible as a deterministic assertion (the element is within the screen, elements do not overlap, text does not overflow its container), write it as a layout assertion test (an integration test), not a visual verification test. Displayed content (card data, text length, item count) is a test input: the pass criterion never varies with it. Leave to visual verification what does not suit a strict assertion: color, positional relationships like "A is to the right of B", on-screen position, and typography (font size, font style, font family) are design intent likely to change, and legibility (text/background contrast) is impractical to assert. Reasons:
- Deterministic pass/fail: boolean assertions run unattended in CI without a human reading screenshots.
- Pins the specific bug: an overlap assertion names the two elements; a screenshot cannot.
- Do NOT add a visual verification test for the same property — verify each layout property in exactly one layer.
Choose the implementation means by what the condition is about:
- Rect comparison —
Is.WithinScreen(within-screen bounds),Is.FullyWithin(container)(containment in a parent),Is.Not.Overlapping(overlap between elements) - Text overflow —
Is.Not.TextOverflowing(preferred/rendered size exceeds the rect, or characters are truncated) - Raycast reachability —
GameObjectFinderwithreachable: true(optionally with a paginator) proves the element is on screen and not covered by another element; use it when the condition is "the user can actually reach this element"
Before asserting, settle layout with Canvas.ForceUpdateCanvases() then await Awaitable.NextFrameAsync() — the former rebuilds pending layout/graphic geometry (rect sizes, text metrics); the latter waits for a real render pass, which is what a raycast reachability check needs, since a newly activated/deactivated Graphic's CanvasRenderer.depth stays unset until then and GraphicRaycaster silently skips any candidate whose depth == -1 — ForceUpdateCanvases() alone does not assign it.
See test-helper.md → Layout constraints for the constraint API (Is.WithinScreen / Is.FullyWithin / Is.Not.Overlapping / Is.Not.TextOverflowing).
Use GameObjectFinder instead of GameObject.Find
When finding a GameObject that the user interacts with, always use TestHelper.UI.GameObjectFinder instead of UnityEngine.GameObject.Find, Object.FindFirstObjectByType, Object.FindAnyObjectByType, and Object.FindObjectOfType.
Reasons:
- Timing safety: polls until the object appears, so tests pass even when GameObjects are instantiated asynchronously or on the next frame
- Reachability and interactability: verifies the object is actually reachable by the user and (optionally) interactable — matching real user experience
- Blocking check:
reachable: true(default) naturally catches elements hidden behind a modal or overlay — which is often the bug being caught - Actionable failures: throws
TimeoutExceptionwith a clear message;GameObject.Findsilently returnsnulland causes a confusingNullReferenceExceptionlater
Use Operators instead of direct event invocation
When reproducing user actions, always use uGUI operators (e.g., UguiClickOperator, UguiTextInputOperator in TestHelper.UI.Operators namespace) instead of directly calling button events or setting field values.
Reasons:
- Correct event simulation: operators go through Unity's
EventSystemand input pipeline, exercising the same code path as a real user interaction - Reachability-gated: test fails if a UI element is disabled or hidden
- Simpler test code: no need to look up components or call internal methods; just find the GameObject and operate it
// NG — bypasses Unity's event pipeline
button.GetComponent<Button>().onClick.Invoke();
inputField.GetComponent<InputField>().text = "12345";
scene.OnConfirmClicked();
// OK — goes through the proper UI event path
await new UguiClickOperator().OperateAsync(button);
await new UguiTextInputOperator().OperateAsync(inputField, "12345");
Verify modal/overlay blocking
A modal or overlay must block interaction with elements behind it. Test from two angles:
- Behavioural (preferred): attempt to reach a background element via
GameObjectFinderwithreachable: true(default) while the overlay is open — the finder throwsTimeoutException, confirming blockage. Repeat with the overlay dismissed to confirm reachability restores. - Structural: assert the backdrop intercepts raycasts:
Assert.That(background.GetComponent<Image>().raycastTarget, Is.True)(orcanvasGroup.blocksRaycasts).
When a decorative full-screen element should not block (e.g., a background image), annotate it with NonBlockingAnnotation so GameObjectFinder skips it (see test-helper-ui.md).
Visual verification tests
When implementing a visual verification test (a test designed to verify on-screen rendering via screenshot and image analysis):
- Take a screenshot using
[TakeScreenshot]orScreenshotHelper.TakeScreenshotAsync()(seetest-helper.md). - Add
[Description("After running this test, verify the screenshots from the following perspectives: <verification aspects>")]to the test method. The verification aspects are taken directly from the Image analysis by saved screenshot column in the test case design. List only aspects suited to visual verification (legibility, contrast, positional relationships, typography, visual state representation, rendering quality) — do NOT list mechanically assertable facts such as a panel'sactiveSelfor exact text content; assert those in integration tests instead. - Add
[Category("VisualVerification")]to the test method. - You can omit writing
Assertstatements.
When a designed visual verification test shares its test condition with a designed layout assertion test, you may implement both as a single test method: take the screenshot in the layout assertion test, apply steps 2–3 to it, and keep the layout assertions (step 4 does not apply).
Resources
Read the appropriate resource file based on the situation:
- Before writing or modifying any test code file: Read
${CLAUDE_SKILL_DIR}/resources/unity-test-framework.md - Before writing or modifying any test code file: Read
${CLAUDE_SKILL_DIR}/resources/test-helper.md - Before writing or modifying UI tests with
TestHelper.UInamespace API (e.g.,GameObjectFinder,Monkey): Read${CLAUDE_SKILL_DIR}/resources/test-helper-ui.md - Before writing or modifying performance tests (
com.unity.test-framework.performance,[Performance],Measure.*): Read${CLAUDE_SKILL_DIR}/resources/unity-test-framework-performance.md
What ships with it: 4 files
61.9 KB alongside SKILL.md, 1 of them executable
resources/
- test-helper.md7.1 KB
- test-helper-ui.md12.1 KB
- unity-test-framework.md39.7 KB
scripts/
- create-test-asmdef.shruns3.0 KB
Gives 0 of the 12 instructions most docs writing skills give
Counted across 1,951 of the 3,904 authors here whose files we hold, read 2026-09-06
- Use third-person for skill descriptionsin 54 of 1951, across 35 files
- Start descriptions with Use whenin 43 of 1951, across 29 files
- Run baseline scenarios before writing any skillin 40 of 1951, across 26 files
- Use active voicein 40 of 1951, across 36 files
- Map file responsibilities before defining tasksin 36 of 1951, across 29 files
- Use checkbox syntax for tracking stepsin 35 of 1951, across 27 files
- Ask one question at a timein 35 of 1951
- Offer execution options after saving the planin 33 of 1951, across 24 files
- Include complete code in every stepin 33 of 1951, across 27 files
- Design units with clear boundaries and interfacesin 31 of 1951, across 23 files
- Announce the skill usage at the startin 30 of 1951
- Verify agent compliance after adding the skillin 29 of 1951, across 17 files
Said here and by no other author read
- Stop Play Mode before modifying test files
- Add [CreateScene] when instantiating GameObjects or prefabs
- Wrap test seams in #if UNITY_INCLUDE_TESTS blocks
- Add [Category] attributes based on test type
- Wait for state completion instead of fixed frame counts
- Advance one frame after deferred Destroy or UI rebuilds
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once.