Skip to content

docs: prohibit unit tests for E2E code #3763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkoura merged 1 commit into from
Oct 15, 2026
Merged

docs: prohibit unit tests for E2E code #3763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions agent_docs/e2e_tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This document applies only to E2E functional tests under `cardano_node_tests/tests/`. Unit tests for the framework itself live under `framework_tests/` and are plain pytest tests.

Never add unit tests for code under `cardano_node_tests/tests/`, including test-specific helpers and fixtures. Validate changes to that code through E2E functional tests instead.

The guidelines apply to writing new tests and also to larger changes of existing tests (refactoring, extending, moving tests or fixtures). When changing an existing test, bring the parts you touch in line with these guidelines, but don't rewrite unrelated code just to comply.

Organize tests in classes that group related functionality.
Expand Down
2 changes: 2 additions & 0 deletions agent_docs/running_tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Unit tests cover the testing framework itself (`framework_tests/` plus doctests
./.venv/bin/pytest --doctest-modules framework_tests cardano_node_tests/utils/
```

Never add unit tests for code under `cardano_node_tests/tests/`, including test-specific helpers and fixtures, even if the unit tests would live in `framework_tests/`. Validate that code through E2E functional tests instead.

## E2E Functional Tests

E2E functional tests (everything under `cardano_node_tests/tests/`) run against a local testnet cluster. The tests are using pytest. Always use the `ai_run.sh` wrapper script to run the `pytest` command.
Expand Down
Loading