ddtrace/tracer: address race detector warning from TestDefaultHTTPClient #1347
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
Doing a deep comparision (through assert.Equal/assert.NotEqual) of http.Clients in these tests can trigger a race detector warning: === FAIL: ddtrace/tracer TestDefaultHTTPClient/socket (0.00s) ================== WARNING: DATA RACE Read at 0x000001e0a080 by goroutine 123: [ ... elided ... ] reflect.DeepEqual() /usr/local/Cellar/go/1.18.3/libexec/src/reflect/deepequal.go:237 +0x3f9 github.com/stretchr/testify/assert.ObjectsAreEqual() /Users/nick.ripley/go/pkg/mod/github.com/stretchr/testify@v1.7.0/assert/assertions.go:65 +0x184 github.com/stretchr/testify/assert.NotEqual() /Users/nick.ripley/go/pkg/mod/github.com/stretchr/testify@v1.7.0/assert/assertions.go:694 +0x204 gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer.TestDefaultHTTPClient.func2() /Users/nick.ripley/dd/dd-trace-go/ddtrace/tracer/option_test.go:433 +0x3a4 testing.tRunner() /usr/local/Cellar/go/1.18.3/libexec/src/testing/testing.go:1439 +0x213 testing.(*T).Run.func1() /usr/local/Cellar/go/1.18.3/libexec/src/testing/testing.go:1486 +0x47 Previous write at 0x000001e0a080 by goroutine 19: sync/atomic.AddInt32() /usr/local/Cellar/go/1.18.3/libexec/src/runtime/race_amd64.s:279 +0xb sync/atomic.AddInt32() <autogenerated>:1 +0x1a net/http.(*Transport).removeIdleConn.func1() /usr/local/Cellar/go/1.18.3/libexec/src/net/http/transport.go:1096 +0x39 runtime.deferreturn() /usr/local/Cellar/go/1.18.3/libexec/src/runtime/panic.go:436 +0x32 net/http.(*persistConn).readLoop.func1() /usr/local/Cellar/go/1.18.3/libexec/src/net/http/transport.go:2062 +0x72 runtime.deferreturn() /usr/local/Cellar/go/1.18.3/libexec/src/runtime/panic.go:436 +0x32 net/http.(*Transport).dialConn.func5() /usr/local/Cellar/go/1.18.3/libexec/src/net/http/transport.go:1750 +0x39 This is a data race but not actually a bug in the tracer library, just a bug in the tests. We can use assert.Same/assert.NotSame to compare the *http.Clients as pointers, since the tests are just checking whether or not the default client is returned.
gbbr
approved these changes
Jun 17, 2022
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.
Doing a deep comparision (through
assert.Equal/assert.NotEqual) of*http.Clients in these tests can trigger a race detector warning:This is a data race but not actually a bug in the tracer library, just a bug in
the tests. We can use
assert.Same/assert.NotSameto compare the*http.Clients as pointers, since the tests are just checking whether or notthe default client is returned.