Skip to content
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

fix(ci_visibility): handle pytest ATR retry failures in unittest classes [backport 2.19] #12047

Merged
merged 2 commits into from
Jan 28, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jan 23, 2025

Backport dc7037e from #12030 to 2.19.

Auto Test Retries had a bug where retries of tests defined inside unittest classes would always succeed, even if the test failed. This was because for unittest classes, pytest saves the exception status in the pytest_runtest_makereport hook, which was not called during retries. This PR fixes it so that the hook is called.

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

…ses (#12030)

Auto Test Retries had a bug where retries of tests defined inside
unittest classes would always succeed, even if the test failed. This was
because for unittest classes, pytest saves the exception status in the
[`pytest_runtest_makereport`
hook](https://github.com/pytest-dev/pytest/blob/8.3.x/src/_pytest/unittest.py#L368),
which was not called during retries. This PR fixes it so that the hook
is called.

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

(cherry picked from commit dc7037e)
@github-actions github-actions bot requested review from a team as code owners January 23, 2025 16:55
@pr-commenter
Copy link

pr-commenter bot commented Jan 23, 2025

Benchmarks

Benchmark execution time: 2025-01-28 12:31:19

Comparing candidate commit 84cb989 in PR branch backport-12030-to-2.19 with baseline commit 067d6a7 in branch 2.19.

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

scenario:iast_aspects-ospathsplitext_aspect

  • 🟩 execution_time [-339.658ns; -285.846ns] or [-8.705%; -7.326%]

Copy link
Contributor Author

CODEOWNERS have been resolved as:

releasenotes/notes/ci_visibility-fix-pytest-classes-b54582b09727fdc1.yaml  @DataDog/apm-python
ddtrace/contrib/pytest/_retry_utils.py                                  @DataDog/ci-app-libraries
tests/contrib/pytest/test_pytest_atr.py                                 @DataDog/ci-app-libraries

@brettlangdon brettlangdon enabled auto-merge (squash) January 28, 2025 11:50
@brettlangdon brettlangdon merged commit 5dd85b4 into 2.19 Jan 28, 2025
249 checks passed
@brettlangdon brettlangdon deleted the backport-12030-to-2.19 branch January 28, 2025 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants