ci(botocore): fix flaky botocore tests [backport 2.19] #11969
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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)
github-actions
bot
added
the
changelog/no-changelog
|
|
erikayasuda
approved these changes
Jan 15, 2025
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.
Backport 505d148 from #11872 to 2.19.
Botocore sensitive data redaction sets
AWSPayloadTagging.request_redaction_pathsandAWSPayloadTagging.response_redaction_pathsthe first time AWSPayloadTagging.expand_payload_as_tags(...) is called.In tests overriding
config.botocore.payload_tagging_requestandconfig.botocore.payload_tagging_requestusingtests.utils.override_config(..)is not sufficient. We also need to setddtrace._trace.utils_botocore.span_tags._PAYLOAD_TAGGER.validatedtoFalse. This ensures the overriden botocore configurations are actually used.Note: This PR does not fix the underlying issue of
AWSPayloadTaggingconfigurations becoming out of sync withddtrace.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
Reviewer Checklist