profiler: deduplicate test profiler setup logic #2428
Merged
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
Many tests do the same thing: create an HTTP server running our mock backend with a channel for receving profile uploads, start a profiler pointing to the mock backend plus whatever other options we're testing, and then receive some profiles and clean up at the end. Pull most of this common setup code into some helpers, so that test cases can be focused primarliy on the specific contents of the profile uploads they're validating. This commit doesn't touch every single test, since some such as TestTryUpload and TestProfilerPassthrough rely on manipulating profiler-internal stuff and would be better handled in separate commits.
BenchmarksBenchmark execution time: 2023-12-12 18:48:31 Comparing candidate commit 068bc75 in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 39 metrics, 2 unstable metrics. |
felixge
approved these changes
Dec 14, 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?
Create a common helper for setting up a profiler hooked up to a mock backend
for testing.
This PR doesn't touch every single test, since some such as TestTryUpload and
TestProfilerPassthrough rely on manipulating profiler-internal stuff and would
be better handled in separate commits.
Motivation
Many tests do the same thing: create an HTTP server running our mock backend
with a channel for receving profile uploads, start a profiler pointing to the
mock backend plus whatever other options we're testing, and then receive some
profile uploads, make assertions about them, and clean up at the end.
In general, I think this is a good pattern for testing the profiler. We should
ideally only test it using the public API, and only make assertions about the
observable output (i.e. what we send to our backend). Having a helper that
makes this easy to do this is a step in that direction.
Reviewer's Checklist
For Datadog employees:
@DataDog/security-design-and-guidance.Unsure? Have a question? Request a review!