-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add warnings for duplicate test IDs & misconfigured retry commands #100
Open
pierrebeaucamp
wants to merge
11
commits into
main
Choose a base branch
from
pierre/more-warnings
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
66fe755
to
6f04a27
Compare
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.
Both warnings can also be configured as hard failures: Either as CLI Flags (
--fail-on-duplicate-test-id
and--fail-on-misconfigured-retry
) or in the config file (asfail-on-duplicate-test-id: true
in the suite config andfail-on-misconfiguration: true
in the retry config respectively).Duplicate test identification has an interesting edge-case: Although we can trivially check for duplicates using the
test.Matches
method, we sometimes match tests using an "identity recipe" instead - these recipes usually only use a subset of available test metadata, which leads to the possibility oftest.Matches
not identifying a duplicate while an "identity recipe" would.To work around this, we'll check for duplicates using the identity-recipe as well - however this requires that we know expected identity recipes ahead of time. To make this work, we can now pull these identity recipes from Cloud. Captain will do this if it cannot find a
.captain/recipes.json
file.Note: This PR doesn't add any kind of invalidation for the cached recipes. So far, our recipes never had to change. Adding invalidation is not much work should we need to do this in the future.
I ended up refactoring a small part of the retry code: I noticed that we explicitly checked for
test.Attempt.Status.ImpliesFailure()
in eachSubstitudeFor
method for each framework. Instead, I've put this check inside thefilter
function that we pass along.There are only two places that call
SubstitudeFor
, so addingtest.Attempt.Status.ImpliesFailure()
into the filter centralized the logic to these two places (instead of duplicating it across each framework). Furthermore, this allowed me to re-use thefilter
function to later check for misconfigured retry commands.The only adverse effect of this change is that I had to update a bunch of test-files as they had a stub filter function previously.