feat: add e2e test to validate webhook conversion between versions

Author: wazery

docs/book/src/multiversion-tutorial/testdata/project/test/e2e/e2e_test.go

@@ -26,6 +26,7 @@ import (
 	"os/exec"
 	"path/filepath"
 	"time"
+	"strings"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -327,6 +328,35 @@ var _ = Describe("Manager", Ordered, func() {
 		//    fmt.Sprintf(`controller_runtime_reconcile_total{controller="%s",result="success"} 1`,
 		//    strings.ToLower(<Kind>),
 		// ))
+		It("Should successfully convert between v1 and v2 versions", func() {
+			By("Creating a v1 CronJob with sample data")
+			cmd := exec.Command("kubectl", "apply", "-f", "config/samples/batch_v1_cronjob.yaml", "-n", namespace)
+			_, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v1 CronJob")
+
+			By("Verifying the v1 CronJob was created")
+			cmd = exec.Command("kubectl", "get", "cronjobs.v1.batch.tutorial.kubebuilder.io", "-n", namespace, "-o", "jsonpath={.items[0].metadata.name}")
+			v1Name, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get v1 CronJob")
+			Expect(strings.TrimSpace(v1Name)).NotTo(BeEmpty(), "v1 CronJob name should not be empty")
+
+			By("Creating a v2 CronJob with sample data")
+			cmd = exec.Command("kubectl", "apply", "-f", "config/samples/batch_v2_cronjob.yaml", "-n", namespace)
+			_, err = utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v2 CronJob")
+
+			By("Verifying the v2 CronJob was created")
+			cmd = exec.Command("kubectl", "get", "cronjobs.v2.batch.tutorial.kubebuilder.io", "-n", namespace, "-o", "jsonpath={.items[0].metadata.name}")
+			v2Name, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get v2 CronJob")
+			Expect(strings.TrimSpace(v2Name)).NotTo(BeEmpty(), "v2 CronJob name should not be empty")
+
+			By("Verifying conversion webhook is active by checking controller logs")
+			cmd = exec.Command("kubectl", "logs", "-l", "control-plane=controller-manager", "-n", namespace, "--tail=50")
+			logs, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get controller logs")
+			Expect(logs).To(ContainSubstring("cronjob"), "Controller logs should contain cronjob references")
+		})
 	})
 })
 

hack/docs/internal/multiversion-tutorial/generate_multiversion.go

@@ -111,6 +111,7 @@ func (sp *Sample) UpdateTutorial() {
 	sp.updateConversionFiles()
 	sp.updateSampleV2()
 	sp.updateMain()
+	sp.updateE2EWebhookConversion()
 }
 
 func (sp *Sample) updateCronjobV1DueForce() {
@@ -790,3 +791,74 @@ func (sp *Sample) CodeGen() {
 	err = sp.ctx.EditHelmPlugin()
 	hackutils.CheckError("Failed to enable helm plugin", err)
 }
+
+const webhookConversionE2ETest = `
+		It("Should successfully convert between v1 and v2 versions", func() {
+			By("Creating a v1 CronJob with sample data")
+			cmd := exec.Command("kubectl", "apply", "-f", "config/samples/batch_v1_cronjob.yaml", "-n", namespace)
+			_, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v1 CronJob")
+
+			By("Verifying the v1 CronJob was created")
+			cmd = exec.Command("kubectl", "get", "cronjobs.v1.batch.tutorial.kubebuilder.io", "-n", namespace, "-o", "jsonpath={.items[0].metadata.name}")
+			v1Name, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get v1 CronJob")
+			Expect(strings.TrimSpace(v1Name)).NotTo(BeEmpty(), "v1 CronJob name should not be empty")
+
+			By("Creating a v2 CronJob with sample data")
+			cmd = exec.Command("kubectl", "apply", "-f", "config/samples/batch_v2_cronjob.yaml", "-n", namespace)
+			_, err = utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v2 CronJob")
+
+			By("Verifying the v2 CronJob was created")
+			cmd = exec.Command("kubectl", "get", "cronjobs.v2.batch.tutorial.kubebuilder.io", "-n", namespace, "-o", "jsonpath={.items[0].metadata.name}")
+			v2Name, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get v2 CronJob")
+			Expect(strings.TrimSpace(v2Name)).NotTo(BeEmpty(), "v2 CronJob name should not be empty")
+
+			By("Verifying conversion webhook is active by checking controller logs")
+			cmd = exec.Command("kubectl", "logs", "-l", "control-plane=controller-manager", "-n", namespace, "--tail=50")
+			logs, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to get controller logs")
+			Expect(logs).To(ContainSubstring("cronjob"), "Controller logs should contain cronjob references")
+		})`
+
+func (sp *Sample) updateE2EWebhookConversion() {
+	cronjobE2ETest := filepath.Join(sp.ctx.Dir, "test", "e2e", "e2e_test.go")
+
+	// Add strings import if not already present
+	err := pluginutil.InsertCodeIfNotExist(cronjobE2ETest,
+		`	"os/exec"
+	"path/filepath"
+	"time"`,
+		`
+	"strings"`)
+	hackutils.CheckError("adding strings import for e2e test", err)
+
+	// Add CronJob cleanup to the AfterEach block
+	err = pluginutil.InsertCode(cronjobE2ETest,
+		`	// After each test, check for failures and collect logs, events,
+	// and pod descriptions for debugging.
+	AfterEach(func() {`,
+		`		By("Cleaning up test CronJob resources")
+		cmd := exec.Command("kubectl", "delete", "-f", "config/samples/batch_v1_cronjob.yaml", "-n", namespace, "--ignore-not-found=true")
+		_, _ = utils.Run(cmd)
+		cmd = exec.Command("kubectl", "delete", "-f", "config/samples/batch_v2_cronjob.yaml", "-n", namespace, "--ignore-not-found=true")
+		_, _ = utils.Run(cmd)
+
+`)
+	hackutils.CheckError("adding CronJob cleanup to AfterEach", err)
+
+	// Add webhook conversion test after the existing TODO comment
+	err = pluginutil.InsertCode(cronjobE2ETest,
+		`		// TODO: Customize the e2e test suite with scenarios specific to your project.
+		// Consider applying sample/CR(s) and check their status and/or verifying
+		// the reconciliation by using the metrics, i.e.:
+		// metricsOutput := getMetricsOutput()
+		// Expect(metricsOutput).To(ContainSubstring(
+		//    fmt.Sprintf(`+"`"+`controller_runtime_reconcile_total{controller="%s",result="success"} 1`+"`"+`,
+		//    strings.ToLower(<Kind>),
+		// ))`,
+		webhookConversionE2ETest)
+	hackutils.CheckError("adding webhook conversion e2e test", err)
+}