testing-guidelines
Pytest testing patterns, fixtures, mocking, and coverage for GMailArchiver. Use when writing unit tests, integration tests, creating fixtures, mocking Gmail API, or checking coverage. Triggers on: test, pytest, fixture, mock, coverage, conftest, assert, unit test, integration test.
When & Why to Use This Skill
This Claude skill provides comprehensive testing guidelines and automated patterns for the GMailArchiver project using Pytest. It streamlines the software quality assurance process by offering standardized practices for unit and integration testing, fixture management, and complex Gmail API mocking, ensuring the codebase maintains a high-quality standard with a 95%+ coverage target.
Use Cases
- Developing Unit and Integration Tests: Follow established naming conventions and structural patterns to create consistent and reliable tests for GMailArchiver modules.
- Mocking Gmail API Interactions: Implement robust mocking strategies to simulate Gmail API responses, allowing for isolated testing without requiring actual network calls or sensitive credentials.
- Managing Shared Test Fixtures: Utilize and configure shared fixtures within conftest.py to reduce code duplication and ensure a clean, reusable test environment.
- Optimizing Code Coverage: Execute coverage commands and analyze reports to identify untested logic and ensure the project meets its 95% coverage requirement.
| name | testing-guidelines |
|---|---|
| description | >- |
| Gmail API, or checking coverage. Triggers on | test, pytest, fixture, mock, |
Testing Guidelines for GMailArchiver
This skill provides guidance on testing practices and patterns.
Source Documentation
Always read the authoritative source:
docs/TESTING.md - The definitive testing guidelines document containing:
- Test organization and structure
- Naming conventions for tests
- Fixture patterns and usage
- Mocking strategies (especially for Gmail API)
- Coverage requirements and targets
- Integration vs unit test guidelines
- Test data management
Key Test Files
tests/conftest.py- Shared fixtures and configurationtests/test_*.py- Test modules (match source structure)
Test Commands
# Run all tests with coverage
uv run pytest
# Run specific test file
uv run pytest tests/test_module.py -v
# Run specific test function
uv run pytest tests/test_module.py::test_name -v
# Run without coverage (faster)
uv run pytest --no-cov
# Run with coverage report
uv run pytest --cov=src/gmailarchiver --cov-report=html
Coverage Requirements
- Overall: 95%+ coverage
- Core modules: Higher coverage expected
- See
docs/TESTING.mdfor specific targets
Usage
When writing tests:
- Read
docs/TESTING.mdfor current testing guidelines - Check
tests/conftest.pyfor available fixtures - Follow existing test patterns in similar test files
- If guidelines change, update
docs/TESTING.md(not this skill)
The source documentation is the single source of truth - this skill just points you there.