fix(test): TestBlockPoolMaliciousNode shutdown threads at exit (backport #4633)#4634
Merged
fix(test): TestBlockPoolMaliciousNode shutdown threads at exit (backport #4633)#4634
TestBlockPoolMaliciousNode shutdown threads at exit (backport #4633)#4634Conversation
This is a drive-by fix of a test that doesn't shut its threads down until the whole `go test` execution finishes. I think we have a bunch of these, but I came across this one during an unrelated troubleshooting. Is it worth fixing this? It's not really causing any issues, it's just sloppy coding. The only way to see any difference is to run the `go test` until it reaches its time limit and panics. In that case, the trace will contain references to the threads. For example: ``` go test github.com/cometbft/cometbft/blocksync -v -run TestBlockPoolMaliciousNode -count 100 -failfast -race -timeout 30s ``` After 30 seconds the test didn't run 100 times yet, hence `go test` panics. Because the test has been run multiple times already, multiple sets of threads will be reported in the panic. With the fix, only one set is reported. Author: @greg-szabo --------- Co-authored-by: Greg Szabo <greg@philosobear.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit fdaca92)
melekes
approved these changes
Dec 9, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 is a drive-by fix of a test that doesn't shut its threads down until the whole
go testexecution finishes. I think we have a bunch of these, but I came across this one during an unrelated troubleshooting.Is it worth fixing this? It's not really causing any issues, it's just sloppy coding.
The only way to see any difference is to run the
go testuntil it reaches its time limit and panics. In that case, the trace will contain references to the threads.For example:
After 30 seconds the test didn't run 100 times yet, hence
go testpanics. Because the test has been run multiple times already, multiple sets of threads will be reported in the panic. With the fix, only one set is reported.Author: @greg-szabo
This is an automatic backport of pull request #4633 done by [Mergify](https://mergify.com).