.github: Fix caching of integration test runs #5041
Merged
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.
PR Checklist
PR Structure
otherwise).
services/friendbot
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
.md
files, etc... affected by this change). Take a look in the
docs
folder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Failed integration tests failed on PRs would always succeed on subsequent retries because GithubCI would find an entry in the our test cache and assume that the tests had previously passed. This bug is caused by the fact that the cache key was the same for different integration tests.
The integration test matrix includes the following parameters:
Not all of these parameters were included in the cache key. In particular, the ingestion-backend parameter was not part of the cache key. If the integration tests succeeded with legacy ingestion via stellar core's postgres db but failed with captive core ingestion, the successful run would be stored in the cache using the same cache key as the failed run.
To fix this issue I have included the
PREFIX
environment variable in the cache key. ThePREFIX
environment variable includes all of the test matrix parameters.Known limitations
Note we still might have this issue with flaky tests. After the flaky test succeeds for the first time, the test run will be included in the cache. Then all subsequent attempts at retrying the test will restore from the cache instead of executing the tests.