Fix pod controller flaky unit test #192
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.
What this PR does / why we need it:
client-go recommends to call WaitForCacheSync after calling Start on the SharedInformerFactory.
https://pkg.go.dev/k8s.io/[email protected]/informers#SharedInformerFactory
This fixes the flaky unit test for the pod controller.
ginkgo could be updated to its version 2 (github.com/onsi/ginkgo/v2)
Which issue(s) this PR fixes *
/
Special notes for your reviewer (optional):
I am not so familiar writing controller only with client-go, usually I use controller-runtime. So I don't really know what is done behind WaitForCacheSync except from what I could read in the documentation.
From what I observed, sometimes, handlePodUpdate is not called with the latest pod changes.
I tried to repeat the tests 100 times with this fix (using
ginkgo --repeat=100 -timeout=240s ./pkg/controller/...
), it never failed.