mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
kevinveenbirkenbachandClaude Sonnet 4.6
2457d0e13c
- Add Recording Tests section: Playwright codegen (built-in) and playwright-recorder (Docker/X11-based) with usage examples - Replace duplicated spec/env requirement blocks with links to their SPOT pages in docs/agents/files/role/ - Extend Development Procedure to include optional recording step Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.4 KiB
1.4 KiB
Unit Tests
This page is the SPOT for unit testing requirements, framework, and structure.
Run unit tests with make test-unit.
Framework
- You MUST use Python
unittestas the test framework. - Tests MUST live under
tests/unit/. - Mirror the source tree: a file at
plugins/lookup/service.pygets its tests attests/unit/plugins/lookup/test_service.py.
Requirements
- You MUST add or update unit tests for every
*.pyfile you touch. - Each test MUST cover one isolated behavior. Do not test multiple concerns in a single test method.
- You MUST NOT write tests that only assert a file contains a string.
- You MUST NOT write tests for non-executable files such as
.ymlor.j2. Test the code that consumes them instead. - You SHOULD name test methods after the behavior they verify, not the function name alone (e.g.
test_needed_false_when_disabled). - You SHOULD cover edge cases — empty inputs, missing keys, boundary values — not only the happy path.
- You MAY use
unittest.mockto isolate the unit under test from Ansible internals or external state.
How to Create
- Identify the module under test (e.g.
plugins/lookup/service.py). - Create the matching test file under
tests/unit/if it does not exist. - Subclass
unittest.TestCase. - Write one method per behavior. Build hypotheses before writing assertions.
- Run
make test-unitand verify all tests pass.