Skip to content

Fix flaky VRG test by waiting for deletion to complete #2295

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.

Sign up for GitHub

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

Open
nadavleva wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix flaky VRG test by waiting for deletion to complete #2295

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc46c3a
Fix flaky VRG test by waiting for deletion to complete (issue #2294)
Oct 12, 2025
9dd03bd
Use WithTimeout in VRG test as suggested by reviewer
Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion internal/controller/vrg_recipe_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package controllers_test
import (
"context"
"strings"
"time"

volrep "github.com/csi-addons/kubernetes-csi-addons/api/replication.storage/v1alpha1"
. "github.com/onsi/ginkgo/v2"
Expand Down Expand Up @@ -249,7 +250,7 @@ var _ = Describe("VolumeReplicationGroupRecipe", func() {
}
vrgDelete := func() {
Expect(k8sClient.Delete(ctx, vrg)).To(Succeed())
Eventually(vrgGet).Should(MatchError(k8serrors.NewNotFound(
Eventually(vrgGet, time.Second*10, time.Millisecond*100).Should(MatchError(k8serrors.NewNotFound(
Copy link
Member

@nirs nirs Oct 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may work but it is not clear based on the the function signature:

Eventually(actualOrCtx any, args ...any) AsyncAssertion

We should use:

Eventually(vrgGet).WithTimeout(10*time.Second).Should(MatchError(k8serrors.NewNotFound(

Also it will help to add a comment explaining why we need larger timeout for this test.

I would not bother with the polling interval to keep the code simpler.

Can you share tests results with this timeout, proving that the flakiness is caused by short timeout?

A good example would be to run this test 100 times with this timeout and measure how much time we waited (min, max, avg).

We have lot of falky tests, I wonder this delete timeout within 1 second is not causing other tests to fail. We can increate the default timeout to test this:
https://pkg.go.dev/github.com/onsi/gomega#SetDefaultEventuallyTimeout

Copy link
Author

@nadavleva nadavleva Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will run some tests to verify the behavior and have more info on the deletion time interval.
I encountered additional tests that are flaky due to timeout, e.g. #2235

schema.GroupResource{
Group: ramen.GroupVersion.Group,
Resource: "volumereplicationgroups",
Expand Down