RocketPy Pytest Standards
Testing & QualityRocketPy Pytest Standards is an Agent Skill for testing & quality published in the RocketPy-Team/RocketPy repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use when creating or editing pytest files in tests/. Enforces AAA structure, naming conventions, fixture usage, parameterization, slow-test marking, and numerical assertion practices for RocketPy.
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/RocketPy-Team/RocketPy/blob/HEAD/.agents/skills/tests-python/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/rocketpy-pytest-standards, 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.
RocketPy Test Authoring Guidelines
- Unit tests are mandatory for new behavior.
- Follow AAA structure in each test: Arrange, Act, Assert.
- Use descriptive test names matching project convention:
test_methodnametest_methodname_stateundertesttest_methodname_expectedbehaviour
- Include docstrings that clearly state expected behavior and context.
- Prefer parameterization for scenario matrices instead of duplicated tests.
- Classify tests correctly:
tests/unit: fast, method-focused tests (sociable unit tests are acceptable in RocketPy).tests/integration: broad multi-method/component interactions and strongly I/O-oriented cases.tests/acceptance: realistic end-user/flight scenarios with threshold-based expectations.
- By RocketPy convention, tests centered on
all_info()behavior are integration tests. - Reuse fixtures from
tests/fixtureswhenever possible. - Keep fixture organization aligned with existing categories under
tests/fixtures(environment, flight, motor, rockets, surfaces, units, etc.). - If you add a new fixture module, update
tests/conftest.pyso fixtures are discoverable. - Keep tests deterministic: set seeds when randomness is involved and avoid unstable external dependencies unless integration behavior explicitly requires them.
- Use
pytest.approxfor floating-point comparisons with realistic tolerances. - Mark expensive tests with
@pytest.mark.slowand ensure they can run under the project slow-test workflow. - Include at least one negative or edge-case assertion for new behaviors.
- When adding a bug fix, include a regression test that fails before the fix and passes after it.
See:
docs/development/testing.rstdocs/development/style_guide.rstdocs/development/setting_up.rst