🌱 Flakes: replace require with assert in retry funcs
#1330
Merged
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
When `require` assertions are not satisfied they fails a test immediately. This is not desired when used with retry function such as `EventuallyWithT` since they are supposed to retry on a failure. This can cause flakes when, for example, we are asserting on a resource condition. On the first hit the resource might not have a condition and `require` will fail `EventuallyWithT` despite the fact that the code is correct and the condition gets set eventually. Signed-off-by: Mikalai Radchuk <mradchuk@redhat.com>
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
m1kola
changed the title
require with assert in retry funcsrequire with assert in retry funcs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1330 +/- ##
==========================================
- Coverage 76.17% 76.13% -0.05%
==========================================
Files 41 41
Lines 2409 2409
==========================================
- Hits 1835 1834 -1
- Misses 401 402 +1
Partials 173 173
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Can we generalize the statement that we should not use I know this is just test code, but the extra lines are messing with my OCD. 😉 require.EventuallyWithT(t, func(ct *assert.CollectT) {
assert.NoError(ct, c.Get(context.Background(), types.NamespacedName{Name: clusterExtension.Name}, clusterExtension))
cond := apimeta.FindStatusCondition(clusterExtension.Status.Conditions, ocv1alpha1.TypeProgressing)
if assert.NotNil(ct, cond) {
assert.Equal(ct, metav1.ConditionFalse, cond.Status)
assert.Equal(ct, ocv1alpha1.ReasonSuccess, cond.Reason)
}
}, pollDuration, pollInterval) |
grokspawn
approved these changes
Oct 3, 2024
Merged
via the queue into
operator-framework:main
with commit Oct 3, 2024
ab99642
17 of 18 checks passed
4 tasks
m1kola
pushed a commit
to grokspawn/operator-controller
that referenced
this pull request
Oct 4, 2024
While reviewing operator-framework#1330 we had a discussion about the ability to generally prevent the use of `requires` within `Eventually` calls to prevent future flakes, and that led us to evaluate the `testifylint`-er to give us some cautionary guidelines. It did _not_ resolve the requires-within-eventually issue, but we may try to tackle that with some custom AST in the future. Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 4, 2024
While reviewing #1330 we had a discussion about the ability to generally prevent the use of `requires` within `Eventually` calls to prevent future flakes, and that led us to evaluate the `testifylint`-er to give us some cautionary guidelines. It did _not_ resolve the requires-within-eventually issue, but we may try to tackle that with some custom AST in the future. Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
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.
Description
When
requireassertions are not satisfied they fails a test immediately. This is not desired when usedwith retry function such as
EventuallyWithTsince they are supposed to retry on a failure.This can cause flakes when, for example, we are asserting on a resource condition. On the first hit the resource might not have a condition and
requirewill failEventuallyWithTdespite the fact that the code is correct and the condition gets set eventually.Example failures from today & yesterday:
Reviewer Checklist