Use DescribeTable in server config updates integration-tests

Author: ChunyiLyu

controllers/rabbitmqcluster_controller_test.go

@@ -18,6 +18,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/intstr"
 
 	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/extensions/table"
 	. "github.com/onsi/gomega"
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 	"github.com/rabbitmq/cluster-operator/internal/resource"
@@ -1639,86 +1640,75 @@ var _ = Describe("RabbitmqClusterController", func() {
 
 	})
 
-	Context("Server configurations updates", func() {
-		AfterEach(func() {
-			Expect(client.Delete(ctx, cluster)).To(Succeed())
-			waitForClusterDeletion(ctx, cluster, client)
-		})
+	DescribeTable("Server configurations updates",
+		func(testCase string) {
+			// create rabbitmqcluster
+			cluster = &rabbitmqv1beta1.RabbitmqCluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "rabbitmq-" + testCase,
+					Namespace: defaultNamespace,
+				},
+				Spec: rabbitmqv1beta1.RabbitmqClusterSpec{
+					Replicas: &one,
+				},
+			}
+			Expect(client.Create(ctx, cluster)).To(Succeed())
+			waitForClusterCreation(ctx, cluster, client)
 
-		assertRabbitmqServerUpdates := func(testCase string) {
-			It("updates the rabbitmq server", func() {
-				// create rabbitmqcluster
-				cluster = &rabbitmqv1beta1.RabbitmqCluster{
-					ObjectMeta: metav1.ObjectMeta{
-						Name:      "rabbitmq-" + testCase,
-						Namespace: defaultNamespace,
-					},
-					Spec: rabbitmqv1beta1.RabbitmqClusterSpec{
-						Replicas: &one,
-					},
+			// ensure that configMap and statefulSet does not have annotations set when configurations haven't changed
+			configMap, err := clientSet.CoreV1().ConfigMaps(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server-conf"), metav1.GetOptions{})
+			Expect(err).To(Not(HaveOccurred()))
+			Expect(configMap.Annotations).ShouldNot(HaveKey("rabbitmq.com/serverConfUpdatedAt"))
+
+			sts, err := clientSet.AppsV1().StatefulSets(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server"), metav1.GetOptions{})
+			Expect(err).To(Not(HaveOccurred()))
+			Expect(sts.Annotations).ShouldNot(HaveKey("rabbitmq.com/lastRestartAt"))
+
+			// update rabbitmq server configurations
+			Expect(updateWithRetry(cluster, func(r *rabbitmqv1beta1.RabbitmqCluster) {
+				if testCase == "additional-config" {
+					r.Spec.Rabbitmq.AdditionalConfig = "test_config=0"
 				}
-				Expect(client.Create(ctx, cluster)).To(Succeed())
-				waitForClusterCreation(ctx, cluster, client)
+				if testCase == "advanced-config" {
+					r.Spec.Rabbitmq.AdvancedConfig = "sample-advanced-config."
+				}
+				if testCase == "env-config" {
+					r.Spec.Rabbitmq.EnvConfig = "some-env-variable"
+				}
+			})).To(Succeed())
 
-				// ensure that configMap and statefulSet does not have annotations set when configurations haven't changed
+			By("annotating the server-conf ConfigMap")
+			// ensure annotations from the server-conf ConfigMap
+			var annotations map[string]string
+			Eventually(func() map[string]string {
 				configMap, err := clientSet.CoreV1().ConfigMaps(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server-conf"), metav1.GetOptions{})
 				Expect(err).To(Not(HaveOccurred()))
-				Expect(configMap.Annotations).ShouldNot(HaveKey("rabbitmq.com/serverConfUpdatedAt"))
-
+				annotations = configMap.Annotations
+				return annotations
+			}, 5).Should(HaveKey("rabbitmq.com/serverConfUpdatedAt"))
+			_, err = time.Parse(time.RFC3339, annotations["rabbitmq.com/serverConfUpdatedAt"])
+			Expect(err).NotTo(HaveOccurred(), "Annotation rabbitmq.com/serverConfUpdatedAt was not a valid RFC3339 timestamp")
+
+			By("annotating the sts podTemplate")
+			// ensure statefulSet annotations
+			Eventually(func() map[string]string {
 				sts, err := clientSet.AppsV1().StatefulSets(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server"), metav1.GetOptions{})
 				Expect(err).To(Not(HaveOccurred()))
-				Expect(sts.Annotations).ShouldNot(HaveKey("rabbitmq.com/lastRestartAt"))
+				annotations = sts.Spec.Template.Annotations
+				return annotations
+			}, 5).Should(HaveKey("rabbitmq.com/lastRestartAt"))
+			_, err = time.Parse(time.RFC3339, annotations["rabbitmq.com/lastRestartAt"])
+			Expect(err).NotTo(HaveOccurred(), "Annotation rabbitmq.com/lastRestartAt was not a valid RFC3339 timestamp")
 
-				// update rabbitmq server configurations
-				Expect(updateWithRetry(cluster, func(r *rabbitmqv1beta1.RabbitmqCluster) {
-					if testCase == "additional-config" {
-						r.Spec.Rabbitmq.AdditionalConfig = "test_config=0"
-					}
-					if testCase == "advanced-config" {
-						r.Spec.Rabbitmq.AdvancedConfig = "sample-advanced-config."
-					}
-					if testCase == "env-config" {
-						r.Spec.Rabbitmq.EnvConfig = "some-env-variable"
-					}
-				})).To(Succeed())
-
-				By("annotating the server-conf ConfigMap")
-				// ensure annotations from the server-conf ConfigMap
-				var annotations map[string]string
-				Eventually(func() map[string]string {
-					configMap, err := clientSet.CoreV1().ConfigMaps(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server-conf"), metav1.GetOptions{})
-					Expect(err).To(Not(HaveOccurred()))
-					annotations = configMap.Annotations
-					return annotations
-				}, 5).Should(HaveKey("rabbitmq.com/serverConfUpdatedAt"))
-				_, err = time.Parse(time.RFC3339, annotations["rabbitmq.com/serverConfUpdatedAt"])
-				Expect(err).NotTo(HaveOccurred(), "Annotation rabbitmq.com/serverConfUpdatedAt was not a valid RFC3339 timestamp")
-
-				By("annotating the sts podTemplate")
-				// ensure statefulSet annotations
-				Eventually(func() map[string]string {
-					sts, err := clientSet.AppsV1().StatefulSets(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server"), metav1.GetOptions{})
-					Expect(err).To(Not(HaveOccurred()))
-					annotations = sts.Spec.Template.Annotations
-					return annotations
-				}, 5).Should(HaveKey("rabbitmq.com/lastRestartAt"))
-				_, err = time.Parse(time.RFC3339, annotations["rabbitmq.com/lastRestartAt"])
-				Expect(err).NotTo(HaveOccurred(), "Annotation rabbitmq.com/lastRestartAt was not a valid RFC3339 timestamp")
-			})
-		}
-
-		When("spec.rabbitmq.additionalConfig is updated", func() {
-			assertRabbitmqServerUpdates("additional-config")
-		})
-
-		When("spec.rabbitmq.advancedConfig is updated", func() {
-			assertRabbitmqServerUpdates("advanced-config")
-		})
+			// delete rmq cluster
+			Expect(client.Delete(ctx, cluster)).To(Succeed())
+			waitForClusterDeletion(ctx, cluster, client)
+		},
 
-		When("spec.rabbitmq.envConfig is updated", func() {
-			assertRabbitmqServerUpdates("env-config")
-		})
-	})
+		Entry("spec.rabbitmq.additionalConfig is updated", "additional-config"),
+		Entry("spec.rabbitmq.advancedConfig is updated", "advanced-config"),
+		Entry("spec.rabbitmq.envConfig is updated", "env-config"),
+	)
 })
 
 func extractContainer(containers []corev1.Container, containerName string) corev1.Container {