tracer.startTestTracer: Call SetServiceName("") when stopping #2260
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
While debugging a different unit test, I noticed that the service
name can leak between tests. For TestSpanLog: if you remove some of
the WithService(...) options, the tests still pass because it uses
the service name that was previously set.
To prevent this, call globalconfig.SetServiceName("") when stopping
the tracer. I also added a test to verify that the span log does not
include any options, even after setting all the options.
This isn't really causing any problems, except that it prevents
running the unit tests with the -shuffle=on flag, because some tests
are accidentally depending on other tests.
BenchmarksBenchmark execution time: 2023-10-12 16:37:52 Comparing candidate commit f77f6fa in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 41 metrics, 0 unstable metrics. |
ajgajg1134
approved these changes
Oct 11, 2023
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.
What does this PR do?
While debugging a different unit test, I noticed that the service name can leak between tests. For TestSpanLog: if you remove some of the WithService(...) options, the tests still pass because it uses the service name that was previously set.
To prevent this, call globalconfig.SetServiceName("") when stopping the tracer. I also added a test to verify that the span log does not include any options, even after setting all the options.
This isn't really causing any problems, except that it prevents running the unit tests with the -shuffle=on flag, because some tests are accidentally depending on other tests.
Motivation
Found while attempting to write a unit test for a race bug.
Reviewer's Checklist
For Datadog employees:
@DataDog/security-design-and-guidance.Unsure? Have a question? Request a review!