Add schema validation for rabbitmq.additionalPlugins

api/v1beta1/rabbitmqcluster_types.go

@@ -69,10 +69,17 @@ type RabbitmqClusterSpec struct {
 	Rabbitmq    RabbitmqClusterConfigurationSpec `json:"rabbitmq,omitempty"`
 }
 
+// kubebuilder validating tags 'Pattern' and 'MaxLength' must be specified on string type.
+// Alias type 'string' as 'Plugin' to specify schema validation on items of the list 'AdditionalPlugins'
+// +kubebuilder:validation:Pattern:="^\\w+$"
+// +kubebuilder:validation:MaxLength=100
+type Plugin string
+
 // Rabbitmq related configurations
 type RabbitmqClusterConfigurationSpec struct {
 	// List of plugins to enable in addition to essential plugins: rabbitmq_management, rabbitmq_prometheus, and rabbitmq_peer_discovery_k8s.
-	AdditionalPlugins []string `json:"additionalPlugins,omitempty"`
+	// +kubebuilder:validation:MaxItems:=100
+	AdditionalPlugins []Plugin `json:"additionalPlugins,omitempty"`
 }
 
 // The settings for the persistent storage desired for each Pod in the RabbitmqCluster.

api/v1beta1/rabbitmqcluster_types_test.go

@@ -172,7 +172,7 @@ var _ = Describe("RabbitmqCluster", func() {
 							},
 						},
 						Rabbitmq: RabbitmqClusterConfigurationSpec{
-							AdditionalPlugins: []string{
+							AdditionalPlugins: []Plugin{
 								"my-plugins",
 							},
 						},

charts/rabbitmq/expected-template-output

@@ -7,11 +7,9 @@ metadata:
   labels:
     label1: foo
     label2: bar
-
   annotations:
     annotation1: foo
     annotation2: bar
-
 
 spec:
   image: rabbitmq:3.8.1
@@ -22,7 +20,6 @@ spec:
     type: LoadBalancer
     annotations:
       cloud.google.com/load-balancer-type: Internal
-
   persistence:
     storageClassName: foo
     storage: 30Gi
@@ -31,7 +28,6 @@ spec:
     key: dedicated
     operator: Equal
     value: rabbitmq
-
   affinity:
     nodeAffinity:
       requiredDuringSchedulingIgnoredDuringExecution:
@@ -42,15 +38,13 @@ spec:
             values:
             - e2e-az1
             - e2e-az2
-
   resources:
     limits:
       cpu: 888m
       memory: 1Gi
     requests:
       cpu: 777m
       memory: 1Gi
-
   rabbitmq:
     additionalPlugins:
     - rabbitmq_shovel

config/crd/bases/rabbitmq.pivotal.io_rabbitmqclusters.yaml

@@ -649,7 +649,13 @@ spec:
                   description: 'List of plugins to enable in addition to essential
                     plugins: rabbitmq_management, rabbitmq_prometheus, and rabbitmq_peer_discovery_k8s.'
                   items:
+                    description: kubebuilder validating tags 'Pattern' and 'MaxLength'
+                      must be specified on string type. Alias type 'string' as 'Plugin'
+                      to specify schema validation on items of the list 'AdditionalPlugins'
+                    maxLength: 100
+                    pattern: ^\w+$
                     type: string
+                  maxItems: 100
                   type: array
               type: object
             replicas:

controllers/rabbitmqcluster_controller.go

@@ -239,7 +239,7 @@ func (r *RabbitmqClusterReconciler) enablePlugins(rmq *rabbitmqv1beta1.RabbitmqC
 	for i := 0; i < int(rmq.Spec.Replicas); i++ {
 		podName := fmt.Sprintf("%s-%d", rmq.ChildResourceName("server"), i)
 		rabbitCommand := fmt.Sprintf("rabbitmq-plugins set %s",
-			strings.Join(appendIfUnique(resource.RequiredPlugins, rmq.Spec.Rabbitmq.AdditionalPlugins), " "))
+			strings.Join(resource.AppendIfUnique(resource.RequiredPlugins, rmq.Spec.Rabbitmq.AdditionalPlugins), " "))
 
 		output, err := r.exec(rmq.Namespace, podName, "rabbitmq", "sh", "-c", rabbitCommand)
 
@@ -334,19 +334,6 @@ func containsString(slice []string, s string) bool {
 	return false
 }
 
-func appendIfUnique(a, b []string) []string {
-	check := make(map[string]bool)
-	list := append(a, b...)
-	set := make([]string, 0)
-	for _, s := range list {
-		if _, value := check[s]; !value {
-			check[s] = true
-			set = append(set, s)
-		}
-	}
-	return set
-}
-
 func (r *RabbitmqClusterReconciler) prepareForDeletion(ctx context.Context, rabbitmqCluster *rabbitmqv1beta1.RabbitmqCluster) error {
 	if containsString(rabbitmqCluster.ObjectMeta.Finalizers, deletionFinalizer) {
 		if err := clientretry.RetryOnConflict(clientretry.DefaultRetry, func() error {

internal/resource/configmap.go

@@ -51,14 +51,19 @@ func (builder *ServerConfigMapBuilder) Build() (runtime.Object, error) {
 		},
 		Data: map[string]string{
 			"rabbitmq.conf":   defaultRabbitmqConf,
-			"enabled_plugins": "[" + strings.Join(appendIfUnique(RequiredPlugins, builder.Instance.Spec.Rabbitmq.AdditionalPlugins), ",") + "].",
+			"enabled_plugins": "[" + strings.Join(AppendIfUnique(RequiredPlugins, builder.Instance.Spec.Rabbitmq.AdditionalPlugins), ",") + "].",
 		},
 	}, nil
 }
 
-func appendIfUnique(a, b []string) []string {
+func AppendIfUnique(a []string, b []rabbitmqv1beta1.Plugin) []string {
+	data := make([]string, len(b))
+	for i := range data {
+		data[i] = string(b[i])
+	}
+
 	check := make(map[string]bool)
-	list := append(a, b...)
+	list := append(a, data...)
 	set := make([]string, 0)
 	for _, s := range list {
 		if _, value := check[s]; !value {

internal/resource/configmap_test.go

@@ -71,7 +71,7 @@ var _ = Describe("GenerateServerConfigMap", func() {
 
 		When("additionalPlugins are provided in instance spec", func() {
 			It("appends provided plugins to a list of required ones and removes duplicates", func() {
-				instance.Spec.Rabbitmq.AdditionalPlugins = []string{"rabbitmq_management", "rabbitmq_management", "rabbitmq_shovel", "rabbitmq_top", "my_great_plugin"}
+				instance.Spec.Rabbitmq.AdditionalPlugins = []rabbitmqv1beta1.Plugin{"rabbitmq_management", "rabbitmq_management", "rabbitmq_shovel", "rabbitmq_top", "my_great_plugin"}
 
 				expectedEnabledPlugins := "[" +
 					"rabbitmq_peer_discovery_k8s," +

system_tests/system_tests.go

@@ -115,7 +115,7 @@ var _ = Describe("Operator", func() {
 				// modify rabbitmqcluster.spec.rabbitmq.additionalPlugins
 				fetchedRabbit := &rabbitmqv1beta1.RabbitmqCluster{}
 				Expect(rmqClusterClient.Get(context.Background(), types.NamespacedName{Namespace: cluster.Namespace, Name: cluster.Name}, fetchedRabbit)).NotTo(HaveOccurred())
-				fetchedRabbit.Spec.Rabbitmq.AdditionalPlugins = []string{"rabbitmq_top"}
+				fetchedRabbit.Spec.Rabbitmq.AdditionalPlugins = []rabbitmqv1beta1.Plugin{"rabbitmq_top"}
 				Expect(rmqClusterClient.Update(context.TODO(), fetchedRabbit)).To(Succeed())
 
 				// wait for pod being restarted and becoming not ready