Skip to content

AGENTS: Add layout instructions for test subdirectories #244

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
llucax merged 1 commit into from
Jul 9, 2026
Merged

AGENTS: Add layout instructions for test subdirectories #244

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
23 changes: 19 additions & 4 deletions tests/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,34 @@ Tests verify that the idiomatic wrappers stay in lock-step with the generated

## LAYOUT

Tests mirror the package tree with the `src/frequenz/client/common/` prefix stripped, the
leading underscore dropped, and `test_` prepended:
Tests mirror the package tree with the `src/frequenz/client/common/` prefix stripped.
Normally a 1-1 file mapping with the leading underscore dropped, and `test_` prepended:

```
src/frequenz/client/common/<path>/_yyy.py -> tests/<path>/test_yyy.py
```

If a src file contains multiple types and the resulting test file will become large,
split in multiple files in a subdirectory:

```
src/frequenz/client/common/<path>/_yyy.py -> tests/<path>/_yyy/test_xxx.py
```

Where `xxx` is usually one type or one function in `_yyy.py`.

Examples:
- `src/.../types/_location.py` -> `tests/types/test_location.py`
- `src/.../metrics/proto/v1alpha8/_metric.py` -> `tests/metrics/proto/v1alpha8/test_metric.py`
- `src/.../types/_location.py`: `tests/types/_location/test_location.py`,
`tests/types/_location/test_invalid_latitude.py`, etc.
- `src/.../grid/_delivery_area.py`: `tests/grid/test_delivery_area.py`
- `src/.../metrics/proto/v1alpha8/_metric.py`: `tests/metrics/proto/v1alpha8/test_metric.py`

Keep the `proto/<namespace>/` nesting intact (currently only `v1alpha8`).

Avoid repeating prefixes in files and test names. For example:
- `src/.../types/_location/test_location.py`: `test_construction()`,
NOT `test_location_construction()`

## ENUM TESTS = ONE-LINE SUBCLASS

Never re-scaffold enum/proto checks. Subclass
Expand Down
Loading