Install
openclaw skills install compound-eng-writing-testsGeneric test writing discipline: test quality, real assertions, anti-patterns, and rationalization resistance. Use when writing tests, adding test coverage, or fixing failing tests for any language or framework. Complements language-specific skills.
openclaw skills install compound-eng-writing-testsTests prove behavior works. A test that can't fail is worthless. A test that tests mocks instead of real code is theater.
Each test should verify exactly one thing. If the test name needs "and" in it, split it into two tests.
Good: "creates user with valid email"
Good: "rejects user with duplicate email"
Bad: "creates user and sends welcome email and updates counter"
Build test coverage from three independent sources and verify every item maps to at least one test:
Anything that appears in any source but has no corresponding test is a coverage gap. This catches the common failure mode where implemented features work but aren't tested, or where claimed behavior isn't verified.
For each source, enumerate user journeys: "As a [role], I want to [action], so that [benefit]." Generate test cases from each journey -- this ensures tests cover user-visible behavior, not implementation details.
Each test should be independently readable without chasing shared setup through helper functions. Duplication in tests is acceptable -- even desirable -- when it makes the test's intent obvious at a glance. Extract shared setup only when it genuinely reduces noise without hiding what the test does.
For API/web projects, aim for ~80% unit, ~15% integration, ~5% E2E. Adjust ratios based on project risk profile -- data pipelines may need heavier integration coverage, CLI tools may need minimal E2E.
The test name should describe what happens, not what's being called.
Good: "returns 404 when user does not exist"
Bad: "test getUserById"
Good: "sends notification after order is placed"
Bad: "test processOrder"
Mocks should be a last resort, not a first choice. Every mock is an assumption about behavior that may drift from reality.
| Use real objects for | Use mocks/fakes for |
|---|---|
| Database queries (use test DB) | External HTTP APIs |
| Internal services and classes | Payment gateways |
| File system operations (use temp dirs) | Email/SMS delivery |
| Business logic and transformations | Third-party SDKs with rate limits |
Exception: framework-provided test doubles. When a framework offers dedicated faking mechanisms (Laravel Queue::fake(), Event::fake(); React test providers and vi.mock for API layers), use them -- they are the idiomatic approach and maintained alongside the framework. The principle is: avoid hand-rolled mocks that drift, not framework-blessed test utilities.
If a test uncovers broken or buggy behavior, fix the source code -- never adjust the test to match incorrect behavior. A test that passes against a bug is worse than no test at all.
Good: assert user exists in database after create
Bad: assert repository.save() was called once
Good: assert response body contains expected fields
Bad: assert serializer.serialize() was called with user
For every feature, consider:
Tests must detect silent failures, not just happy paths. For every code path that catches, logs, or short-circuits on error, add an assertion that proves the failure was observable. Hunt targets during test writing:
try { ... } catch {}) — add a test that triggers the error and asserts the logger (or equivalent signal) was called with the original exception..catch(() => []), .catch(() => null)) — add a test that triggers the rejection and asserts the caller sees a distinguishable signal (specific return value, logged error, re-thrown).catch (e) { return defaultValue; }) — assert both the return value AND that the error was recorded somewhere the operator can find it.Assertion pattern: instead of expect(result).toBe(null) (which passes for both "handled gracefully" and "silent drop"), prefer expect(logger.error).toHaveBeenCalledWith(expect.any(DatabaseError)) — make the observable signal part of the contract.
Tests-first answer "what should this do?" Tests-after answer "what does this do?" The distinction matters: tests written after implementation are biased toward verifying what you built, not what's required.
For bug fixes, writing the failing test first is genuinely valuable -- it proves the bug exists and proves the fix works. For new features, the order is less critical than the quality.
The failing test is proof the bug exists. The passing test is proof the fix works. Without both halves, there is no proof -- just coincidence.
This is non-negotiable for bugs -- a fix without a regression test is a fix that will break again. The two-run sequence (fail then pass) is the proof. Skipping the first run means the test might pass for reasons unrelated to the fix.
Write tests as you build, not after. "I'll add tests later" means "I won't add tests."
The goal: by the time the feature is done, tests exist and pass. Whether you wrote the test 5 minutes before or 5 minutes after the code matters less than whether the test exists and is good.
Minimum viability during green phase: When making a test pass, write the simplest code that satisfies it. Not the abstraction you think is "right," not the feature you imagine you'll need next. The simplest thing. Refactor only after the test is green.
Symptom: Test passes but production breaks. Tests assert that mocks were called correctly, not that the actual system works.
Fix: Replace mocks with real objects for internal code. Only mock at system boundaries (external APIs, email, payment).
Symptom: Methods like reset(), clearState(), setTestMode() that exist only because tests need them.
Fix: If tests need to reset state, the code has a design problem. Refactor to make state explicit and injectable.
Symptom: All tests are snapshots that get bulk-updated whenever anything changes.
Fix: Snapshots catch unintended changes but don't verify correctness. Add behavioral assertions alongside snapshots.
Symptom: Tests verify that the ORM saves records, the router routes requests, or the framework does what its docs say.
Fix: Trust the framework. Test YOUR logic -- the business rules, transformations, and decisions your code makes.
Symptom: Mock only includes the fields the test author knows about. Downstream code consumes other fields and gets undefined.
Fix: Mock the COMPLETE data structure as it exists in reality, not just the fields the immediate test uses. Before creating a mock response, check what fields the real API/type contains -- include ALL fields the system might consume downstream. Use real objects or factory-generated fixtures with all fields populated. If you must mock, generate from the real type/schema.
Before mocking any method, ask: (1) What side effects does the real method have? (2) Does this test depend on any of those side effects? (3) Mock at the lowest level that removes the slow/external part -- not higher.
Tests written by LLMs (including self-written) tend to produce a specific class of failures. Scan for these before committing:
expect(sum(a,b)).toBe(a+b)). The test passes even when both are wrong. Replace with a hand-computed expected value or a known fixture.expect(...) / assert ... tied to the behavior under test.expect(result).toBeTruthy() on a function that returns an object. Passes for {}, true, "anything", all equally. Pin to the specific shape.expect(repo.save).toHaveBeenCalledTimes(1) when the real contract is "the user exists in the database afterward." Assert on outcomes, not call counts.Symptom: Integration tests fail with row-count multipliers — expected 2 rows, got 8; expected 3 jobs dispatched, got 12. The numbers look like a code bug ("the loop runs N times instead of once"), but they're clean integer multiples of the expected value, and the same test passes in CI on a fresh container.
Root cause: Persistent test infrastructure (long-running docker compose up, a shared local database, a volume left between iterations) accumulates state across test runs. The current run's data sits on top of the previous run's data; assertions counting rows or jobs see the sum.
Diagnostic shortcut: if expected vs. actual differs by a clean integer multiple (2x, 3x, 4x...), state contamination is more likely than a logic bug. Real logic bugs rarely produce uniform multipliers across unrelated assertions.
Fix: reset infrastructure state between runs. In order of preference:
testcontainers, pytest-postgresql, or docker compose run --rm <service> for one-shot runs) — slowest to start, strongest isolation. Default for CI.TRUNCATE / DROP DATABASE in a session-scoped or per-test fixture — fast, requires careful coverage of every stateful table.docker compose down -v before each run) when running locally — manual but reliable.Never rely on tests "cleaning up after themselves." If a previous run errored mid-test, the cleanup didn't run, and the next run inherits the partial state.
| Stuck on... | Do this |
|---|---|
| Don't know how to test | Write the assertion first (desired outcome), then build the test around it |
| Test too complicated | Simplify the interface being tested |
| Must mock everything | Code is too coupled -- use dependency injection |
| Test setup too large | Extract helpers that reduce noise without hiding test intent (see DAMP). Still complex? Simplify the design |
When you catch yourself thinking "this is too simple to need tests", "I'll add tests later", "the deadline is too tight", or similar — stop and load rationalization-table.md. Thirteen common excuses with their counter-truths. If you're arguing against writing a test, you're probably losing that argument.
Before considering tests complete:
This skill is referenced by:
/ia-work -- when adding tests for new functionality (Phase 2)ia-debugging -- when creating failing tests to reproduce bugsia-verification-before-completion -- tests as primary verification evidenceThis skill provides generic test discipline. For framework-specific patterns, conventions, and tooling:
ia-php-laravel (PHPUnit, factories, feature/unit split, facade faking, data providers)ia-react-frontend (Vitest, RTL, component/hook patterns, Playwright E2E, mocking patterns)Both skills are complementary -- this skill covers principles (why and what to test), tech-specific skills cover implementation (how to test in that framework). When both are active, framework-specific guidance takes precedence for tooling and conventions.