Repository navigation
feat: a quarantine check that fails the build once a quarantine runs out - #159
Merged
Merged
Conversation
This file contains hidden or 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
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.
A flaky test can be quarantined only with the issue that tracks its fix and an expiry at most 14 days away. Once that date passes the build fails again, so a quarantine cannot become permanent (estate testing standard, section 7; ADR-0022).
The marker is one string, put in the reason of whatever skips the test, so every language uses its own skip:
scripts/quarantine_check.pyreads every tracked test file (_test.go,.spec.ts,.test.ts,*Test.kt,*Test.java). A marker fails the build when:Each failure is a GitHub annotation on the line. A marker that expires today still passes. Markers in documents are not read.
quarantine-check.ymlis a reusable workflow that runs it. It is one 5-minute job that checks out the caller and this repository at its released version.CI holds the script to 100% line and branch coverage, like the other two gating scripts. Its tests follow the testing standard: one behaviour per test, named as a sentence.
Part of JorisJonkers-dev/workspace#128. #156 closes once the testing standard documents the marker and identity runs the check.
Checks
tests/test_quarantine_check.py: 16 tests, 100% line and branch coverage.tests/pass, and actionlint passes on both changed workflows.