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 db test data race for queue tick interval #29276

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

fairclothjm
Copy link
Contributor

Description

Attempt to fix a data race for the queue tick interval on the logical.BackendConfig map. I was unable to repro the data race locally, but I think reinitializing the BackendConfig for each value under test should fix the issue.

Failure: https://github.com/hashicorp/vault-enterprise/actions/runs/12584472353/job/35075729417

Test data race output:

WARNING: DATA RACE
Write at 0x00c00cedad80 by goroutine 29135:
  runtime.mapassign_faststr()
      /home/runner/actions-runner/_work/_tool/go/1.23.3/x64/src/runtime/map_faststr.go:223 +0x0
  github.com/hashicorp/vault/builtin/logical/database.TestQueueTickIntervalKeyConfig()
      /home/runner/actions-runner/_work/vault-enterprise/vault-enterprise/builtin/logical/database/rotation_test.go:1045 +0x308
  testing.tRunner()
      /home/runner/actions-runner/_work/_tool/go/1.23.3/x64/src/testing/testing.go:1690 +0x226
  testing.(*T).Run.gowrap1()
      /home/runner/actions-runner/_work/_tool/go/1.23.3/x64/src/testing/testing.go:1743 +0x44

Previous read at 0x00c00cedad80 by goroutine 37721:
  runtime.mapaccess2_faststr()
      /home/runner/actions-runner/_work/_tool/go/1.23.3/x64/src/runtime/map_faststr.go:117 +0x0
  github.com/hashicorp/vault/builtin/logical/database.(*databaseBackend).initQueue()
      /home/runner/actions-runner/_work/vault-enterprise/vault-enterprise/builtin/logical/database/rotation.go:622 +0x6c8
  github.com/hashicorp/vault/builtin/logical/database.Factory.gowrap1()
      /home/runner/actions-runner/_work/vault-enterprise/vault-enterprise/builtin/logical/database/backend.go:76 +0x5d

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@fairclothjm fairclothjm requested a review from a team as a code owner January 2, 2025 21:50
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 2, 2025
Copy link

github-actions bot commented Jan 2, 2025

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Jan 2, 2025

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@helenfufu helenfufu left a comment

Choose a reason for hiding this comment

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

Reinitializing the config in separate subtests makes sense to me!

Copy link
Contributor

@stevendpclark stevendpclark left a comment

Choose a reason for hiding this comment

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

Thanks for addressing this!

@fairclothjm fairclothjm merged commit 9a83073 into main Jan 3, 2025
99 of 103 checks passed
@fairclothjm fairclothjm deleted the fix-db-test-race-queuetickinterval branch January 3, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants