feat: add e2e test to validate webhook conversion between versions

Author: wazery

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

@@ -25,6 +25,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strings"
 	"time"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -319,7 +320,147 @@ var _ = Describe("Manager", Ordered, func() {
 
 		// +kubebuilder:scaffold:e2e-webhooks-checks
 
-		// TODO: Customize the e2e test suite with scenarios specific to your project.
+		It("should validate webhook conversion between v1 and v2 CronJob versions", func() {
+			By("creating a CronJob in v1 format")
+
+			// Create a CronJob using v1 API with traditional cron schedule
+			cronJobV1 := `
+apiVersion: batch.tutorial.kubebuilder.io/v1
+kind: CronJob
+metadata:
+  name: test-cronjob-v1
+  namespace: ` + namespace + `
+spec:
+  schedule: "*/5 * * * *"
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+          - name: hello
+            image: busybox:1.28
+            imagePullPolicy: IfNotPresent
+            command:
+            - /bin/sh
+            - -c
+            - date; echo Hello from the Kubernetes cluster
+          restartPolicy: OnFailure
+`
+
+			// Apply the v1 CronJob
+			cmd := exec.Command("kubectl", "apply", "-f", "-")
+			cmd.Stdin = strings.NewReader(cronJobV1)
+			_, err := utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v1 CronJob")
+
+			// Verify the CronJob was created and is accessible
+			By("verifying the v1 CronJob was created successfully")
+			Eventually(func(g Gomega) {
+				cmd := exec.Command("kubectl", "get", "cronjob.batch.tutorial.kubebuilder.io", "test-cronjob-v1", "-n", namespace, "-o", "json")
+				output, err := utils.Run(cmd)
+				g.Expect(err).NotTo(HaveOccurred())
+
+				var cronJobData map[string]interface{}
+				err = json.Unmarshal([]byte(output), &cronJobData)
+				g.Expect(err).NotTo(HaveOccurred())
+
+				// Verify this is indeed a resource with string schedule
+				spec, ok := cronJobData["spec"].(map[string]interface{})
+				g.Expect(ok).To(BeTrue(), "Failed to get spec from CronJob")
+
+				schedule, ok := spec["schedule"].(string)
+				g.Expect(ok).To(BeTrue(), "Schedule should be a string in stored format")
+				g.Expect(schedule).To(Equal("*/5 * * * *"), "Schedule should match the applied format")
+			}).Should(Succeed())
+
+			By("creating a CronJob in v2 format to test structured schedule")
+
+			// Create a CronJob using v2 API with structured schedule
+			cronJobV2 := `
+apiVersion: batch.tutorial.kubebuilder.io/v2
+kind: CronJob
+metadata:
+  name: test-cronjob-v2
+  namespace: ` + namespace + `
+spec:
+  schedule:
+    minute: "0"
+    hour: "6"
+    dayOfMonth: "1"
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+          - name: hello
+            image: busybox:1.28
+            imagePullPolicy: IfNotPresent
+            command:
+            - /bin/sh
+            - -c
+            - date; echo Hello from v2 CronJob
+          restartPolicy: OnFailure
+`
+
+			// Apply the v2 CronJob
+			cmd = exec.Command("kubectl", "apply", "-f", "-")
+			cmd.Stdin = strings.NewReader(cronJobV2)
+			_, err = utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to create v2 CronJob")
+
+			// Verify the v2 CronJob was created and stored correctly
+			By("verifying the v2 CronJob was created successfully")
+			Eventually(func(g Gomega) {
+				cmd := exec.Command("kubectl", "get", "cronjob.batch.tutorial.kubebuilder.io", "test-cronjob-v2", "-n", namespace, "-o", "json")
+				output, err := utils.Run(cmd)
+				g.Expect(err).NotTo(HaveOccurred())
+
+				var cronJobData map[string]interface{}
+				err = json.Unmarshal([]byte(output), &cronJobData)
+				g.Expect(err).NotTo(HaveOccurred())
+
+				spec, ok := cronJobData["spec"].(map[string]interface{})
+				g.Expect(ok).To(BeTrue(), "Failed to get spec from CronJob")
+
+				// The schedule should be stored as string in the hub version (v1) due to conversion
+				schedule, ok := spec["schedule"].(string)
+				g.Expect(ok).To(BeTrue(), "Schedule should be stored as string due to hub conversion")
+				// This should be the converted cron string: minute=0, hour=6, dayOfMonth=1, month=*, dayOfWeek=*
+				g.Expect(schedule).To(Equal("0 6 1 * *"), "Schedule should be converted to cron format")
+			}).Should(Succeed())
+
+			By("testing conversion by applying patch to trigger webhook conversion")
+			// Apply a patch to trigger conversion webhook calls
+			patchData := `{"metadata":{"labels":{"test":"conversion"}}}`
+			cmd = exec.Command("kubectl", "patch", "cronjob.batch.tutorial.kubebuilder.io", "test-cronjob-v1", "-n", namespace,
+				"--type", "merge", "-p", patchData)
+			_, err = utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to patch v1 CronJob")
+
+			cmd = exec.Command("kubectl", "patch", "cronjob.batch.tutorial.kubebuilder.io", "test-cronjob-v2", "-n", namespace,
+				"--type", "merge", "-p", patchData)
+			_, err = utils.Run(cmd)
+			Expect(err).NotTo(HaveOccurred(), "Failed to patch v2 CronJob")
+
+			By("verifying conversion webhook was called by checking controller logs")
+			// Check the controller logs for conversion messages
+			Eventually(func(g Gomega) {
+				cmd := exec.Command("kubectl", "logs", controllerPodName, "-n", namespace)
+				logs, err := utils.Run(cmd)
+				g.Expect(err).NotTo(HaveOccurred())
+
+				// Look for conversion log messages that we added in the conversion functions
+				g.Expect(logs).To(ContainSubstring("ConvertTo: Converting CronJob from Spoke version v2 to Hub version v1"),
+					"Should see v2->v1 conversion in logs")
+				g.Expect(logs).To(ContainSubstring("ConvertFrom: Converting CronJob from Hub version v1 to Spoke version v2"),
+					"Should see v1->v2 conversion in logs")
+			}, 30*time.Second, 2*time.Second).Should(Succeed())
+
+			// Cleanup the test CronJobs
+			By("cleaning up test CronJobs")
+			cmd = exec.Command("kubectl", "delete", "cronjob.batch.tutorial.kubebuilder.io", "test-cronjob-v1", "test-cronjob-v2", "-n", namespace, "--ignore-not-found")
+			_, _ = utils.Run(cmd) // Use _ for cleanup as it might fail if resources don't exist
+		}) // 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()