fix: mock public DogStatsd API instead of private _report method#130
Open
fix: mock public DogStatsd API instead of private _report method#130
Conversation
The datadog 0.52.x release added new parameters to the internal _report() method, breaking all 57 tests that mocked it. Switch to mocking the public increment() and gauge() methods so tests are resilient to future internal refactors.
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
1 participant
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.
Summary
DogStatsd._report()with publicincrement()andgauge()methodsdatadogfrom 0.51.0 to 0.52.1 in test-requirements.txt_report()signature change in datadog 0.52.xContext
PR #121 (Renovate: datadog 0.51.0 → 0.52.1) fails because the internal
_report()methodgained new kwargs (
sampling,cardinality) in 0.52.x. Rather than patching the assertionsto match the new internal signature, this PR mocks the public API so tests are resilient to
future internal refactors.
Test plan
Notes
valueparameter inassert_statsd_counter()is no longer asserted because theproduction code uses
increment()'s default value. This is documented in the docstring.