Skip to content

docs: add one-suite-method-per-function test rule #224

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

Closed
retr0h wants to merge 1 commit into from
Closed

docs: add one-suite-method-per-function test rule #224

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
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,7 @@ Conventions:
- Suite naming: `*_public_test.go` → `{Name}PublicTestSuite`,
`*_test.go` → `{Name}TestSuite`
- Table-driven structure with `validateFunc` callbacks
- One suite method per function under test — all scenarios (success, errors, edge cases) as rows in one table
- Avoid generic file names like `helpers.go` or `utils.go` — name
files after what they contain

Expand Down
6 changes: 6 additions & 0 deletions docs/docs/sidebar/development/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ Unit tests should follow the Go convention of being located in a file named
located in `test/integration/` and use a `//go:build integration` tag. They
build and start a real `osapi` binary, so they require no external setup.

Use `testify/suite` with table-driven patterns and `validateFunc` callbacks.
**One suite method per function under test.** All scenarios for a function
(success, error codes, transport failures, nil responses) belong as rows in a
single table — never split into separate `TestFoo`, `TestFooError`,
`TestFooNilResponse` methods.

### File naming

Avoid generic file names like `helpers.go` or `utils.go`. Name files after what
Expand Down