OpenParable
Skip to content
← Back to skills

Write Unit Tests

Testing & Quality
write-unit-tests

Write Unit Tests is an Agent Skill for testing & quality published in the igorescodro/alkaa repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when writing or modifying unit tests in the Alkaa project — triggers on tasks like "add a test", "write tests for X", "test this ViewModel", "cover this use case with tests", or "add unit test coverage".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/igorescodro/alkaa/blob/HEAD/.claude/skills/write-unit-tests/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/write-unit-tests, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Write Unit Tests

Overview

Unit tests in Alkaa are multiplatform-first, fake-based, and structured around a single scenario per test. Tests live in commonTest and run fastest via ./gradlew desktopTest.

Structure

  • Given / When / Then — Use comments to separate the three blocks in every test → see references/TEST_EXAMPLES.md
  • Backtick names — Start with test if or check if, describe the specific condition and expected outcome
  • One scenario per test — Split side effects, error paths, and edge cases into separate tests
  • Fakes only — Never mocks for domain interfaces → see references/FAKE_PATTERNS.md for all three fake patterns
  • CoroutinesTestDispatcher — Delegate by CoroutinesTestDispatcherImpl() for any coroutine-using test class → see references/TEST_EXAMPLES.md
  • ViewModel test setup → see references/TEST_EXAMPLES.md
  • Use case / repository test setup → see references/TEST_EXAMPLES.md

Naming

✅ `test if when load tasks fails the error state is returned`
✅ `test if task is updated as completed`
✅ `test if category without name is not added`
❌ testUpdateTask()
❌ test1()

Rules

RuleDetails
Fakes over mocksOnly use mocks for Android/Framework types you cannot interface (e.g., Context)
CoroutinesTestDispatcherDelegate by CoroutinesTestDispatcherImpl() for any coroutine-using test class
ViewModel at field levelConstruct ViewModel at field level, not inside @BeforeTest
runTest for suspendUse = runTest { } for all suspend test bodies
flow.first()Collect current state with flow.first()
require() for narrowingUse require(state is X) before accessing state-specific properties
@BeforeTest cleanupCall clean() on every fake to reset state between tests

Common Mistakes

MistakeFix
Using mocks for domain interfacesCreate a fake implementing the interface
Forgetting CoroutinesTestDispatcher delegationAdd by CoroutinesTestDispatcherImpl()
Testing multiple scenarios in one testSplit into separate @Test functions
Skipping @BeforeTest cleanupAdd setup() calling clean() on every fake
Constructing ViewModel in @BeforeTestConstruct at field level so it shares dispatcher context
Omitting Given/When/Then commentsAlways add the three comment blocks
Vague test names like testUpdate()Rename to describe the scenario and expected outcome

Related Skills

  • ViewModel tests → use write-viewmodel skill for ViewModel construction patterns
  • UI behavior tests → use write-ui-tests skill
  • Full user flow tests → use write-e2e-tests skill