test(agent): Improve use of inv.Context()
#7696
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
This will ensure tests timeout instead of hang indefinitely since `inv.Context()` is assigned a timeout by default.
johnstcn
approved these changes
May 26, 2023
mtojek
approved these changes
May 26, 2023
| require.NoError(t, err) | ||
| defer dialer.Close() | ||
| require.True(t, dialer.AwaitReachable(context.Background())) |
There was a problem hiding this comment.
I think that this is a second PR fixing context.Background(). I'm curious if there is a lint-way to prevent this dev mistake.
There was a problem hiding this comment.
It would be unfortunate to ban context.Background() entirely since there are valid use-cases. But most of our tests should try to have a timeout so maybe? Ruleguard (scripts/rules.go) would probably be the place to put it, but it's a bit finicky to get right.
In theory, we have a lot of "debt" here:
❯ rg 'context\.Background\(\)' **/*_test.go | grep -E -v 'context\.With(Timeout|Deadline|Value)\(' | wc -l
451
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 will ensure tests timeout instead of hang indefinitely since
inv.Context()is assigned a timeout by default.