ci: improve 'tfail in goroutine' ruleguard rule #19682
Merged
Conversation
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
ethanndickson
commented
Sep 3, 2025
Comment on lines
183
to
-189
| go func($*_){ | ||
| $*_ | ||
| $require.$_($*_) | ||
| require.$_($*_) | ||
| $*_ | ||
| }($*_)`). | ||
| At(m["require"]). | ||
| Where(m["require"].Text == "require"). |
There was a problem hiding this comment.
The prior version would only match on the first line in the goroutine of the form <A>.<B>(<C>), meaning the rule wouldn't fire a violation if the require.* came after some other selector.Func. Ruleguard's pretty limited, and neither I nor Blink could find a way to make the matching not greedy.
To fix, we're just going to only match on lines where the selector is requires.
Comment on lines
199
to
208
| m.Match(` | ||
| go func($*_){ | ||
| $*_ | ||
| $t.$fail($*_) | ||
| t.$fail($*_) | ||
| $*_ | ||
| }($*_)`). | ||
| At(m["fail"]). | ||
| Where(m["t"].Type.Implements("testing.TB") && m["fail"].Text.Matches("^(FailNow|Fatal|Fatalf)$")). | ||
| Where(m["fail"].Text.Matches("^(FailNow|Fatal|Fatalf)$")). | ||
| Report("Do not call functions that may call t.FailNow in a goroutine, as this can cause data races (see testing.go:834)") | ||
| } |
There was a problem hiding this comment.
We apply the same idea here, but with a caveat that if there's some other t.* function that's called before the t.Fail/whatever the rule won't fire. It's not perfect, but it's probably good enough.
7eba8dd to
10d0f7f
Compare
johnstcn
approved these changes
Sep 3, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 PR improves the ruleguard rule for detecting
t.Failcalls in goroutines. It picks up additional violations, of which are fixed in this PR.See self-review for details.
The motivation for fixing this comes from a flake I fixed in #19599, where tests would fail from a
requirein anEventually.