Tests Common
Testing & Qualitytests-commonTests Common is an Agent Skill for testing & quality published in the trezor/trezor-suite repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
TDD practices and test utilities for suite-common packages, including Red-Green-Refactor workflow and @suite-common/test-utils usage. Use when writing tests for suite-common packages.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/trezor/trezor-suite/blob/HEAD/skills/tests-common/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/tests-common, 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.
Writing Common Tests (TDD)
This skill enforces Test-Driven Development (TDD) practices for suite-common packages and ensures proper usage of the
@suite-common/test-utils package.
Core Principles
1. Test-First Development
- ALWAYS write tests before implementing features in suite-common packages.
- Follow the Red-Green-Refactor cycle:
- Red: Write a failing test that describes the desired behavior. Run test to confirm it fails for the right reason (e.g., "Expected value to be X but got Y").
- Green: Write the minimum code to make the test pass. Run test to confirm it passes.
- Refactor: Clean up the code while keeping tests green. Run test to confirm it still passes after refactoring.
2. Writing tests
- Focus on testing behavior and user interactions, not implementation details.
- Follow arrange-act-assert pattern for test structure.
3. Use @suite-common/test-utils Package
- REQUIRED: Use
@suite-common/test-utilsfor all suite-common testing that involves React hooks. - NEVER import directly from
@testing-library/reactwhen testing hooks. - The test-utils package provides all necessary utilities including
renderHookWithStoreProvider.
Checklist
Before submitting code, ensure:
- Tests were written BEFORE implementation
- Using
@suite-common/test-utilsfor hook tests (not direct@testing-library/react) - Correct render function used (
renderHookWithStoreProviderfor hooks needing store,renderHookotherwise) - Fixtures are properly typed
- Tests focus on behavior, not implementation
- Tests follow naming conventions (.hook.test.ts, .test.ts)
- All tests pass locally