Skip to content
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.

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

clarify README #134

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,33 @@ func TestMain(m *testing.M) {
}
```

### Note

For tests that use [t.Parallel](https://pkg.go.dev/testing#T.Parallel), `goleak` does
not know how to distinguish a leaky goroutine from tests that have not finished running.


```go
func TestA(t *testing.T) {
tt := struct{
name string
input SomeType
expected string
}{
// ...
}

for _, t := range tt {
t.Run(t.name, func(t *testing.T) {
t.Parallel() // <- goleak gets confused here!

// ...
}
}
}
```
For such cases you should also defer to using `goleak.VerifyTestMain` as shown above.

## Determine Source of Package Leaks

When verifying leaks using `TestMain`, the leak test is only run once after all tests
Expand Down
Loading