Skip to content
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

Fix incorrect use of loop variable in parallel test #11082

Merged
merged 1 commit into from
Aug 23, 2022

Conversation

renatolabs
Copy link
Contributor

This commit fixes an occurrence of a loop variable being captured in a
parallel test. With very high probability, only the last test case
will actually be exercised. To work around this problem, we create a
local copy of the range variable before the parallel test, as advised
by the Go documentation at:

https://pkg.go.dev/testing#hdr-Subtests_and_Sub_benchmarks

Issue was found automatically using the loopvarcapture linter.

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Aug 23, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive. Additionally, flag names should use dashes (-) as word separators rather than underscores (_).
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

@@ -118,6 +118,7 @@ func TestIsTabletsInList(t *testing.T) {
}

for _, testcase := range testcases {
testcase := testcase // capture range variable
Copy link
Contributor

@mattlord mattlord Aug 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @renatolabs !

Can you please add a comment here as well just to be sure nobody comes along later and removes this "unnecessary" line. 🙂 Something like this:

// We create an explicit copy of the range variable for each parallel runner
// to be sure that they each run as expected. You can see more information on
// this here: https://pkg.go.dev/testing#hdr-Subtests_and_Sub_benchmarks
// The problem is covered by govet's rangeloop check:
//   https://github.com/golangci/govet/blob/master/rangeloop.go

Otherwise it LGTM. Thank you for contributing to Vitess! ❤️

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing!

I included the comment as you suggested, except for the last two lines, as vet does not capture these types of bugs right now (golang/go#16520).

As a side note, the dynamic race detector that ships with Go (go test -race) is also not able to detect bugs of this type because of golang/go#35670.

This commit fixes an occurrence of a loop variable being captured in a
parallel test. With very high probability, only the last test case
will actually be exercised. To work around this problem, we create a
local copy of the range variable before the parallel test, as advised
by the Go documentation at:

https://pkg.go.dev/testing#hdr-Subtests_and_Sub_benchmarks

Issue was found automatically using the `loopvarcapture` linter.

Signed-off-by: Renato Costa <renato@cockroachlabs.com>
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again! ❤️

@mattlord mattlord merged commit 577a72c into vitessio:main Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants