resource: Fix flaky test due to missing Done call #25646
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
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
lmb
reviewed
May 24, 2023
joamaki
force-pushed
the
pr/joamaki/fix-resource-test-flakyness
branch
from
51ad940
to
4cd6d56
Compare
lmb
approved these changes
May 24, 2023
lmb
reviewed
May 24, 2023
pkg/k8s/resource/resource_test.go
Outdated
| @@ -40,7 +41,7 @@ func TestMain(m *testing.M) { | |||
| goleak.VerifyTestMain(m, goleak.Cleanup(cleanup)) | |||
| } | |||
|
|
|||
| func testStore(t *testing.T, node *corev1.Node, store resource.Store[*corev1.Node]) { | |||
| func testStore(t testing.TB, node *corev1.Node, store resource.Store[*corev1.Node]) { | |||
There was a problem hiding this comment.
Nit: the change is probably not required anymore? Conventionally this should be tb now which would lead to a lot of churn.
There was a problem hiding this comment.
Reverted this hunk.
The workaround in 5fa2ac4 was faulty as it did not call ev.Done on the received event leading to further events not being received and thus eventually causing the context to time out. The problem was reproduced reliably locally by adding short time.Sleep calls to the pushUpdate and the initial listing to trigger the race causing the double updates. To remedy this, add the missing ev.Done call, handle timeout gracefully and make assertions FailNow immediately to not mask problems due to e.g. nil deref. FIxes: cilium#24696 Fixes: 5fa2ac4 ("resource: Work around a rare race in initial sync") Signed-off-by: Jussi Maki <jussi@isovalent.com>
joamaki
force-pushed
the
pr/joamaki/fix-resource-test-flakyness
branch
from
4cd6d56
to
c8e75ad
Compare
joamaki
added
the
release-note/misc
maintainer-s-little-helper
bot
removed
the
dont-merge/needs-release-note-label
|
Relevant test is the |
joamaki
added
the
ready-to-merge
youngnick
approved these changes
Jun 1, 2023
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.
The workaround in 5fa2ac4 was faulty as it did not call ev.Done on the received event leading to further events not being received and thus eventually causing the context to time out. The problem was reproduced reliably locally by adding short time.Sleep calls to the pushUpdate and the initial listing to trigger the race causing the double updates.
To remedy this, add the missing ev.Done call, handle timeout gracefully and make assertions FailNow immediately to not mask problems due to e.g. nil deref.
FIxes: #24696
Fixes: 5fa2ac4 ("resource: Work around a rare race in initial sync")