-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
tests: don't mutate global structs in core scheduler tests #16120
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
Some of the core scheduler tests need the maximum batch size for writes to be smaller than the usual `structs.MaxUUIDsPerWriteRequest`. But they do so by unsafely modifying the global struct, which creates test flakes in other tests. Modify the functions under test to take a batch size parameter. Production code will pass the global while the tests can inject smaller values.
25eb555
to
99d78e5
Compare
New semgrep rule from this PR, without the patch to the tests:
|
lgfa29
approved these changes
Feb 10, 2023
07e5e9e
to
1743ea4
Compare
1743ea4
to
800241a
Compare
This was referenced Feb 10, 2023
Merged
Merged
tgross
added a commit
that referenced
this pull request
Feb 10, 2023
Some of the core scheduler tests need the maximum batch size for writes to be smaller than the usual `structs.MaxUUIDsPerWriteRequest`. But they do so by unsafely modifying the global struct, which creates test flakes in other tests. Modify the functions under test to take a batch size parameter. Production code will pass the global while the tests can inject smaller values. Turn the `structs.MaxUUIDsPerWriteRequest` into a constant, and add a semgrep rule for avoiding this kind of thing in the future.
tgross
added a commit
that referenced
this pull request
Feb 10, 2023
…16123) Some of the core scheduler tests need the maximum batch size for writes to be smaller than the usual `structs.MaxUUIDsPerWriteRequest`. But they do so by unsafely modifying the global struct, which creates test flakes in other tests. Modify the functions under test to take a batch size parameter. Production code will pass the global while the tests can inject smaller values. Turn the `structs.MaxUUIDsPerWriteRequest` into a constant, and add a semgrep rule for avoiding this kind of thing in the future. Co-authored-by: Tim Gross <tgross@hashicorp.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport/1.2.x
backport to 1.1.x release line
backport/1.3.x
backport to 1.3.x release line
backport/1.4.x
backport to 1.4.x release line
theme/testing
Test related issues
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.
Some of the core scheduler tests need the maximum batch size for writes to be smaller than the usual
structs.MaxUUIDsPerWriteRequest
. But they do so by unsafely modifying the global struct, which creates test flakes in other tests.Modify the functions under test to take a batch size parameter. Production code will pass the global while the tests can inject smaller values. Turn the
structs.MaxUUIDsPerWriteRequest
into a constant, and add a semgrep rule for avoiding this kind of thing in the future.Discovered while trying to debug #16112, but this should get backported to all supported versions whereas that will be only to 1.4.x