Skip to content

ci(freezegun): fix leaky test causing flakes #13658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 17, 2025

Conversation

brettlangdon
Copy link
Member

@brettlangdon brettlangdon commented Jun 12, 2025

This is a common flake in CI, we found that one of the tests was changing the global configuration without resetting it.

The leaky test was found with https://github.com/asottile/detect-test-pollution

Checklist

  • 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
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

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 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

@brettlangdon brettlangdon requested a review from a team as a code owner June 12, 2025 15:42
@brettlangdon brettlangdon added changelog/no-changelog A changelog entry is not required for this PR. backport 2.21 labels Jun 12, 2025
Copy link
Contributor

CODEOWNERS have been resolved as:

tests/contrib/freezegun/test_freezegun.py                               @DataDog/ci-app-libraries

@brettlangdon brettlangdon enabled auto-merge (squash) June 12, 2025 15:54
Copy link
Contributor

github-actions bot commented Jun 12, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 274 ± 2 ms.

The average import time from base is: 275 ± 1 ms.

The import time difference between this PR and base is: -1.52 ± 0.07 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 1.965 ms (0.72%)
ddtrace.bootstrap.sitecustomize 1.274 ms (0.47%)
ddtrace.bootstrap.preload 1.274 ms (0.47%)
ddtrace.internal.remoteconfig.client 0.623 ms (0.23%)
ddtrace 0.691 ms (0.25%)
ddtrace.internal._unpatched 0.050 ms (0.02%)
json 0.028 ms (0.01%)
json.decoder 0.028 ms (0.01%)
re 0.028 ms (0.01%)
enum 0.028 ms (0.01%)
types 0.028 ms (0.01%)
subprocess 0.022 ms (0.01%)
contextlib 0.022 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Jun 12, 2025

Benchmarks

Benchmark execution time: 2025-06-16 13:16:08

Comparing candidate commit 20556c8 in PR branch brettlangdon/fix.freegun.flaky.test with baseline commit 5692392 in branch main.

Found 0 performance improvements and 1 performance regressions! Performance is the same for 560 metrics, 3 unstable metrics.

scenario:iastaspectssplit-splitlines_aspect

  • 🟥 execution_time [+106.287ns; +145.349ns] or [+7.171%; +9.806%]

@brettlangdon brettlangdon requested a review from gnufede June 14, 2025 00:28
@brettlangdon brettlangdon merged commit f86e11a into main Jun 17, 2025
364 of 365 checks passed
@brettlangdon brettlangdon deleted the brettlangdon/fix.freegun.flaky.test branch June 17, 2025 12:29
github-actions bot pushed a commit that referenced this pull request Jun 17, 2025
This is a common flake in CI, we found that one of the tests was
changing the global configuration without resetting it.

The leaky test was found with
https://github.com/asottile/detect-test-pollution

## 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 f86e11a)
brettlangdon added a commit that referenced this pull request Jun 17, 2025
Backport f86e11a from #13658 to 2.21.

This is a common flake in CI, we found that one of the tests was
changing the global configuration without resetting it.

The leaky test was found with
https://github.com/asottile/detect-test-pollution

## 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
- [x] 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)

Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.21 changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants