Scaffold webhook test examples do not use suite_test structure

[mateusoliveira43]

What do you want to happen?

For example, Defaulter webhook was already setup here

kubebuilder/testdata/project-v4/internal/webhook/v1/webhook_suite_test.go

Line 121 in 944a9de

err = SetupAdmiralWebhookWithManager(mgr)

And manager started here

kubebuilder/testdata/project-v4/internal/webhook/v1/webhook_suite_test.go

Line 137 in 944a9de

err = mgr.Start(ctx)

But example tells user to manually call Defaulter webhook

kubebuilder/testdata/project-v4/internal/webhook/v1/admiral_webhook_test.go

Lines 49 to 58 in 944a9de

	// TODO (user): Add logic for defaulting webhooks
	// Example:
	// It("Should apply defaults when a required field is empty", func() {
	// By("simulating a scenario where defaults should be applied")
	// obj.SomeFieldWithDefault = ""
	// By("calling the Default method to apply defaults")
	// defaulter.Default(ctx, obj)
	// By("checking that the default values are set")
	// Expect(obj.SomeFieldWithDefault).To(Equal("default_value"))
	// })

It could be simplified to

It("Should apply defaults when a required field is empty", func() { 
    By("creating a object where defaults should be applied") 
    obj.SomeFieldWithDefault = "" 
    Expect(k8sClient.Create(ctx, obj)).NotTo(HaveOccurred())

    By("checking that the default values are set") 
    Expect(obj.SomeFieldWithDefault).To(Equal("default_value")) 
}) 

Note: scaffold internal/controller/suite_test.go do not start a manager. Instead of changing users examples, another approach would be removing manager start up in webhook suite_test.go, which would be my suggestion.

Extra Labels

/kind cleanup

[camilamacedo86]

Hi @mateusoliveira43,

To ensure that I understand, you are saying that instead of calling the method that set the default values

By("calling the Default method to apply defaults")
// defaulter.Default(ctx, obj)

We should create the resource Expect(k8sClient.Create(ctx, obj)).NotTo(HaveOccurred()) so the default values should be set.

I think you are right about this one.
Good catcher 👍

[mogsie]

Small nit, but to make assertions on the error of a function call, you should chain the Expect with Error():

    Expect(k8sClient.Create(ctx, obj)).Error().NotTo(HaveOccurred())

Gomega also provides a shorthand for this specifically for the single-error func: Use the Succeed() matcher

    Expect(k8sClient.Create(ctx, obj)).To(Succeed())

[camilamacedo86]

@mateusoliveira43 I think we just need to address #4442 (comment) then we can close this one, right?

[mateusoliveira43]

need to add the code changes to the project

[camilamacedo86]

Hi @mateusoliveira43

• So we need to the code changes described in; Scaffold webhook test examples do not use suite_test structure #4442 (comment). Beyond that, what changes do we need ?

[mateusoliveira43]

we need to be able to create namespaces in webhook tests (to be able to create CRD). So adding namespace object to webhook tests scheme or using a fully loaded scheme #4449