test: avoid leaking goroutines #124
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrbo
approved these changes
Apr 2, 2024
This commit adds a test that checks for goroutine leaks in the `workerpool` package, and also fixes two goroutine leaks. There is unfortunately no easy way of running `goleak` before every test without either a lot of copy-paste, or additional code to ensure every test file has a `TestMain` function. A leaked goroutine will produce the following error with `goleak`: ``` goleak: Errors on successful test run: found unexpected goroutines: [Goroutine 7 in state chan receive, with github.com/nlnwa/warchaeology/internal/workerpool .New.func1 on top of the stack: goroutine 7 [chan receive]: github.com/nlnwa/warchaeology/internal/workerpool. New.func1(0xc00008a1e0) ./warchaeology/internal/workerpool/workerpool.go: 23 +0x66 created by github.com/nlnwa/warchaeology/internal/workerpool.New in goroutine 6 ./warchaeology/internal/workerpool/workerpool.go: 22 +0x85 ] FAIL github.com/nlnwa/warchaeology/internal/workerpool 0.450s FAIL ```
trym-b
force-pushed
the
test/add-goleak-to-relevant-tests
branch
from
4063436
to
67ab417
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a test that checks for goroutine
leaks in the
workerpoolpackage, and also fixestwo goroutine leaks.
There is unfortunately no easy way of running
goleakbefore every test without either a lot of copy-paste, or additional code to ensure everytest file has a
TestMainfunction.A leaked goroutine will produce the following
error with
goleak: