fix: replace t.Logf with slog in newMockCheck to fix data race - #464
Open
lvlcn-t wants to merge 1 commit into
Open
fix: replace t.Logf with slog in newMockCheck to fix data race#464lvlcn-t wants to merge 1 commit into
lvlcn-t wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
The mock check's
RunFuncandShutdownFunccapturedt *testing.Tand calledt.Logffrom within a goroutine spawned byRegisterCheck. Since the parent subtest could finish before that goroutine executed, the Go race detector flagged a concurrent read/write ont's internal state.Changes
t *testing.Tparameter fromnewMockCheckt.Helper()call (no longer valid withoutt)t.Logf("Run called for check %s", name)withslog.InfoContext(ctx, "Run called", "check", name)t.Logf("Shutdown called for check %s", name)withslog.Info("Shutdown called", "check", name)targumentFor additional information look at the commits.
Tests done
go test -race ./pkg/sparrow/...passes cleanly)TODO