Skip to content

Commit

Permalink
ci(botocore): fix flaky botocore tests (#11872)
Browse files Browse the repository at this point in the history
Botocore sensitive data redaction sets
`AWSPayloadTagging.request_redaction_paths` and
`AWSPayloadTagging.response_redaction_paths` the first time
[AWSPayloadTagging.expand_payload_as_tags(...)](https://github.com/DataDog/dd-trace-py/blob/4970e6d0e8f6787e841576e6229ee572d743e9e8/ddtrace/_trace/utils_botocore/aws_payload_tagging.py#L83)
is called.

In tests overriding `config.botocore.payload_tagging_request` and
`config.botocore.payload_tagging_request` using
`tests.utils.override_config(..)` is not sufficient. We also need to set
`ddtrace._trace.utils_botocore.span_tags._PAYLOAD_TAGGER.validated` to
`False`. This ensures the overriden botocore configurations are actually
used.

Note: This PR does not fix the underlying issue of `AWSPayloadTagging`
configurations becoming out of sync with `ddtrace.config.botocore`. We
will need to address this bug in a future PR.

Depending on the order the tests were run the following snapshot test
would fail:
https://app.circleci.com/pipelines/github/DataDog/dd-trace-py/80321/workflows/54bb5dd9-9c50-4e2a-afeb-e168c6c1e6d9/jobs/4394672

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [ ] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit 505d148)
  • Loading branch information
mabdinur authored and github-actions[bot] committed Jan 15, 2025
1 parent 8f64e05 commit ce533f9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions tests/contrib/botocore/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

from ddtrace._trace._span_pointer import _SpanPointer
from ddtrace._trace._span_pointer import _SpanPointerDirection
from ddtrace._trace.utils_botocore import span_tags
from tests.utils import get_128_bit_trace_id_from_headers


Expand Down Expand Up @@ -104,6 +105,12 @@ def setUp(self):
super(BotocoreTest, self).setUp()

Pin(service=self.TEST_SERVICE, tracer=self.tracer).onto(botocore.parsers.ResponseParser)
# Setting the validated flag to False ensures the redaction paths configurations are re-validated
# FIXME: Ensure AWSPayloadTagging._REQUEST_REDACTION_PATHS_DEFAULTS is always in sync with
# config.botocore.payload_tagging_request
# FIXME: Ensure AWSPayloadTagging._RESPONSE_REDACTION_PATHS_DEFAULTS is always in sync with
# config.botocore.payload_tagging_response
span_tags._PAYLOAD_TAGGER.validated = False

def tearDown(self):
super(BotocoreTest, self).tearDown()
Expand Down

0 comments on commit ce533f9

Please sign in to comment.