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

gh-86275: improve Hypothesis configuration for CI and local runs #104468

Merged
merged 4 commits into from
May 21, 2023

Conversation

Zac-HD
Copy link
Contributor

@Zac-HD Zac-HD commented May 14, 2023

Per #22863 (comment), this PR configures Hypothesis to ignore unexpectedly slow tests. Relative to the default of failing, this reduces flakiness due to variable performance of CI machines.

The second commit adds caching to the CI test run, so that if a CI run finds a rare but real failure that input will be replayed in future CI runs (at least until the cache expires, or the test passes and Hypothesis discards the now-passing input). This doesn't come up often, but if it does will convert flaky tests into reliable failures.

Third, we can upload the database as an "artifact" from CI and configure local runs to use that as a pull-through cache - meaning that "reproducing a failure from CI" is just "run the tests locally". No impact on flakiness but it's a rather nice workflow! 1

cc @pganssle for review / checking that it works on your machine

Footnotes

  1. Unfortunately the 'dump a patch with explicit examples' workflow relies on libcst and our pytest plugin - if this would be particularly interesting we can talk about making it work with unittest and perhaps even ast.

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI on this PR is currently failing to start due to invalid workflow syntax:

https://github.com/python/cpython/actions/runs/4977097067

The workflow is not valid. .github/workflows/build.yml (Line: 378, Col: 11): A sequence was not expected

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

.github/workflows/build.yml Outdated Show resolved Hide resolved
@Zac-HD
Copy link
Contributor Author

Zac-HD commented May 16, 2023

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@AlexWaygood: please review the changes made to this pull request.

@hugovk hugovk merged commit 014dd30 into python:main May 21, 2023
@Zac-HD Zac-HD deleted the hypothesis-configuration branch May 21, 2023 13:02
@@ -374,7 +374,7 @@ jobs:
with:
path: ./hypothesis
key: hypothesis-database-${{ github.head_ref || github.run_id }}
restore-keys:
restore-keys: |
- hypothesis-database-
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Zac-HD did you mean to keep that leading hyphen?

Copy link
Contributor

@webknjaz webknjaz Jul 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes it look up the '- hypothesis-database-' prefix, and I'm pretty sure you wanted 'hypothesis-database-':

Cache not found for input keys: hypothesis-database-9927179210, - hypothesis-database-

(https://github.com/python/cpython/actions/runs/9927179210/job/27421821417#step:21:24)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Zac-HD here's the fix: #121756

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants