Skip to content

🌱 Make webhook support e2es more robust #2111

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

Merged
merged 1 commit into from
Jul 21, 2025
Merged

🌱 Make webhook support e2es more robust #2111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 34 additions & 18 deletions test/experimental-e2e/experimental_e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,12 @@ func TestWebhookSupport(t *testing.T) {

t.Log("By waiting for the catalog to serve its metadata")
require.EventuallyWithT(t, func(ct *assert.CollectT) {
assert.NoError(t, c.Get(context.Background(), types.NamespacedName{Name: extensionCatalog.GetName()}, extensionCatalog))
assert.NoError(ct, c.Get(context.Background(), types.NamespacedName{Name: extensionCatalog.GetName()}, extensionCatalog))
cond := apimeta.FindStatusCondition(extensionCatalog.Status.Conditions, ocv1.TypeServing)
assert.NotNil(t, cond)
assert.Equal(t, metav1.ConditionTrue, cond.Status)
assert.Equal(t, ocv1.ReasonAvailable, cond.Reason)
if assert.NotNil(ct, cond) {
assert.Equal(ct, metav1.ConditionTrue, cond.Status)
assert.Equal(ct, ocv1.ReasonAvailable, cond.Reason)
}
Comment on lines +137 to +140
Copy link
Contributor

@camilamacedo86 camilamacedo86 Jul 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

At a quick glance, the current code might misleadingly suggest that if cond never becomes non-nil within the timeout, the test would not fail — giving the impression that it could pass silently.

To make this behavior more explicit and ensure that nil conditions are clearly reported during retries, I propose changing the inner logic to:

Suggested change
if assert.NotNil(ct, cond) {
assert.Equal(ct, metav1.ConditionTrue, cond.Status)
assert.Equal(ct, ocv1.ReasonAvailable, cond.Reason)
}
if !assert.NotNil(t, cond) {
// Keep retrying until cond is not nil
return
}
if !assert.Equal(t, metav1.ConditionTrue, cond.Status) {
// Keep retrying until condition status is true
return
}
if !assert.Equal(t, ocv1.ReasonAvailable, cond.Reason) {
// Keep retrying until reason is available
return
}

Copy link
Contributor

Choose a reason for hiding this comment

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

IHMO ^ less flake as well I think

}, pollDuration, pollInterval)

t.Log("By installing the webhook-operator ClusterExtension")
Expand Down Expand Up @@ -173,6 +174,8 @@ func TestWebhookSupport(t *testing.T) {
assert.Equal(ct, metav1.ConditionTrue, cond.Status)
assert.Equal(ct, ocv1.ReasonSucceeded, cond.Reason)
assert.Contains(ct, cond.Message, "Installed bundle")
}
if assert.NotNil(ct, clusterExtension.Status.Install) {
assert.NotEmpty(ct, clusterExtension.Status.Install.Bundle)
}
}, pollDuration, pollInterval)
Expand All @@ -197,21 +200,29 @@ func TestWebhookSupport(t *testing.T) {
}
v1Client := dynamicClient.Resource(v1Gvr).Namespace(namespace.GetName())

t.Log("By checking an invalid CR is rejected by the validating webhook")
obj := getWebhookOperatorResource("invalid-test-cr", namespace.GetName(), false)
_, err := v1Client.Create(t.Context(), obj, metav1.CreateOptions{})
require.Error(t, err)
require.Contains(t, err.Error(), "Invalid value: false: Spec.Valid must be true")
t.Log("By eventually seeing that invalid CR creation is rejected by the validating webhook")
require.EventuallyWithT(t, func(ct *assert.CollectT) {
obj := getWebhookOperatorResource("invalid-test-cr", namespace.GetName(), false)
_, err := v1Client.Create(t.Context(), obj, metav1.CreateOptions{})
assert.Error(ct, err)
assert.Contains(ct, err.Error(), "Invalid value: false: Spec.Valid must be true")
}, pollDuration, pollInterval)

var (
res *unstructured.Unstructured
err error
obj = getWebhookOperatorResource("valid-test-cr", namespace.GetName(), true)
)

t.Log("By checking a valid CR is mutated by the mutating webhook")
obj = getWebhookOperatorResource("valid-test-cr", namespace.GetName(), true)
_, err = v1Client.Create(t.Context(), obj, metav1.CreateOptions{})
require.NoError(t, err)
t.Log("By eventually creating a valid CR")
require.EventuallyWithT(t, func(ct *assert.CollectT) {
res, err = v1Client.Create(t.Context(), obj, metav1.CreateOptions{})
assert.NoError(ct, err)
}, pollDuration, pollInterval)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Cool add the EventuallyWithT seems a good thing

t.Cleanup(func() {
require.NoError(t, dynamicClient.Resource(v1Gvr).Namespace(namespace.GetName()).Delete(context.Background(), obj.GetName(), metav1.DeleteOptions{}))
require.NoError(t, v1Client.Delete(context.Background(), obj.GetName(), metav1.DeleteOptions{}))
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 seems fine for me

})
res, err := v1Client.Get(t.Context(), obj.GetName(), metav1.GetOptions{})
require.NoError(t, err)

require.Equal(t, map[string]interface{}{
"valid": true,
"mutate": true,
Expand All @@ -225,8 +236,13 @@ func TestWebhookSupport(t *testing.T) {
}
v2Client := dynamicClient.Resource(v2Gvr).Namespace(namespace.GetName())

res, err = v2Client.Get(t.Context(), obj.GetName(), metav1.GetOptions{})
require.NoError(t, err)
t.Log("By eventually getting the valid CR with a v2 client")
require.EventuallyWithT(t, func(ct *assert.CollectT) {
res, err = v2Client.Get(t.Context(), obj.GetName(), metav1.GetOptions{})
assert.NoError(ct, err)
}, pollDuration, pollInterval)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Cool add the EventuallyWithT seems a good thing


t.Log("and verifying that the CR is correctly converted")
require.Equal(t, map[string]interface{}{
"conversion": map[string]interface{}{
"valid": true,
Expand Down
Loading