Correct shovel properties type

- destApplicationProperties, destPublishProperties and destPublishProperties should be map instead of string. See related rabbit-hole changes: michaelklishin/rabbit-hole#262 michaelklishin/rabbit-hole#268
rabbitmq · May 19, 2023 · abffc11 · abffc11
1 parent 1574118
commit abffc11
Show file tree

Hide file tree

Showing 24 changed files with 231 additions and 137 deletions.
diff --git a/api/v1beta1/shovel_types.go b/api/v1beta1/shovel_types.go
@@ -3,6 +3,7 @@ package v1beta1
 import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 )
 
@@ -26,28 +27,34 @@ type ShovelSpec struct {
 	// +kubebuilder:validation:Required
 	UriSecret *corev1.LocalObjectReference `json:"uriSecret"`
 	// +kubebuilder:validation:Enum=on-confirm;on-publish;no-ack
-	AckMode                          string `json:"ackMode,omitempty"`
-	AddForwardHeaders                bool   `json:"addForwardHeaders,omitempty"`
-	DeleteAfter                      string `json:"deleteAfter,omitempty"`
-	DestinationAddForwardHeaders     bool   `json:"destAddForwardHeaders,omitempty"`
-	DestinationAddTimestampHeader    bool   `json:"destAddTimestampHeader,omitempty"`
-	DestinationAddress               string `json:"destAddress,omitempty"`
-	DestinationApplicationProperties string `json:"destApplicationProperties,omitempty"`
-	DestinationExchange              string `json:"destExchange,omitempty"`
-	DestinationExchangeKey           string `json:"destExchangeKey,omitempty"`
-	DestinationProperties            string `json:"destProperties,omitempty"`
-	DestinationProtocol              string `json:"destProtocol,omitempty"`
-	DestinationPublishProperties     string `json:"destPublishProperties,omitempty"`
-	DestinationQueue                 string `json:"destQueue,omitempty"`
-	PrefetchCount                    int    `json:"prefetchCount,omitempty"`
-	ReconnectDelay                   int    `json:"reconnectDelay,omitempty"`
-	SourceAddress                    string `json:"srcAddress,omitempty"`
-	SourceDeleteAfter                string `json:"srcDeleteAfter,omitempty"`
-	SourceExchange                   string `json:"srcExchange,omitempty"`
-	SourceExchangeKey                string `json:"srcExchangeKey,omitempty"`
-	SourcePrefetchCount              int    `json:"srcPrefetchCount,omitempty"`
-	SourceProtocol                   string `json:"srcProtocol,omitempty"`
-	SourceQueue                      string `json:"srcQueue,omitempty"`
+	AckMode                       string `json:"ackMode,omitempty"`
+	AddForwardHeaders             bool   `json:"addForwardHeaders,omitempty"`
+	DeleteAfter                   string `json:"deleteAfter,omitempty"`
+	DestinationAddForwardHeaders  bool   `json:"destAddForwardHeaders,omitempty"`
+	DestinationAddTimestampHeader bool   `json:"destAddTimestampHeader,omitempty"`
+	DestinationAddress            string `json:"destAddress,omitempty"`
+	DestinationExchange           string `json:"destExchange,omitempty"`
+	DestinationExchangeKey        string `json:"destExchangeKey,omitempty"`
+	DestinationProtocol           string `json:"destProtocol,omitempty"`
+	// +kubebuilder:validation:Type=object
+	// +kubebuilder:pruning:PreserveUnknownFields
+	DestinationApplicationProperties *runtime.RawExtension `json:"destApplicationProperties,omitempty"`
+	// +kubebuilder:validation:Type=object
+	// +kubebuilder:pruning:PreserveUnknownFields
+	DestinationProperties *runtime.RawExtension `json:"destProperties,omitempty"`
+	// +kubebuilder:validation:Type=object
+	// +kubebuilder:pruning:PreserveUnknownFields
+	DestinationPublishProperties *runtime.RawExtension `json:"destPublishProperties,omitempty"`
+	DestinationQueue             string                `json:"destQueue,omitempty"`
+	PrefetchCount                int                   `json:"prefetchCount,omitempty"`
+	ReconnectDelay               int                   `json:"reconnectDelay,omitempty"`
+	SourceAddress                string                `json:"srcAddress,omitempty"`
+	SourceDeleteAfter            string                `json:"srcDeleteAfter,omitempty"`
+	SourceExchange               string                `json:"srcExchange,omitempty"`
+	SourceExchangeKey            string                `json:"srcExchangeKey,omitempty"`
+	SourcePrefetchCount          int                   `json:"srcPrefetchCount,omitempty"`
+	SourceProtocol               string                `json:"srcProtocol,omitempty"`
+	SourceQueue                  string                `json:"srcQueue,omitempty"`
 }
 
 // ShovelStatus defines the observed state of Shovel

diff --git a/api/v1beta1/shovel_types_test.go b/api/v1beta1/shovel_types_test.go
@@ -6,6 +6,7 @@ import (
 	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 )
 
@@ -63,12 +64,12 @@ var _ = Describe("Shovel spec", func() {
 				DestinationAddForwardHeaders:     true,
 				DestinationAddTimestampHeader:    true,
 				DestinationAddress:               "myQueue",
-				DestinationApplicationProperties: "a-property",
+				DestinationApplicationProperties: &runtime.RawExtension{Raw: []byte(`{"key": "a-property"}`)},
 				DestinationExchange:              "an-exchange",
 				DestinationExchangeKey:           "a-key",
-				DestinationProperties:            "a-property",
+				DestinationProperties:            &runtime.RawExtension{Raw: []byte(`{"key": "a-property"}`)},
 				DestinationProtocol:              "amqp091",
-				DestinationPublishProperties:     "a-property",
+				DestinationPublishProperties:     &runtime.RawExtension{Raw: []byte(`{"delivery_mode": 1}`)},
 				DestinationQueue:                 "a-queue",
 				PrefetchCount:                    10,
 				ReconnectDelay:                   10,
@@ -98,10 +99,10 @@ var _ = Describe("Shovel spec", func() {
 		Expect(fetched.Spec.DestinationAddTimestampHeader).To(BeTrue())
 		Expect(fetched.Spec.DestinationAddForwardHeaders).To(BeTrue())
 		Expect(fetched.Spec.DestinationAddress).To(Equal("myQueue"))
-		Expect(fetched.Spec.DestinationApplicationProperties).To(Equal("a-property"))
+		Expect(fetched.Spec.DestinationApplicationProperties.Raw).To(Equal([]byte(`{"key":"a-property"}`)))
 		Expect(fetched.Spec.DestinationExchange).To(Equal("an-exchange"))
 		Expect(fetched.Spec.DestinationExchangeKey).To(Equal("a-key"))
-		Expect(fetched.Spec.DestinationProperties).To(Equal("a-property"))
+		Expect(fetched.Spec.DestinationProperties.Raw).To(Equal([]byte(`{"key":"a-property"}`)))
 		Expect(fetched.Spec.DestinationQueue).To(Equal("a-queue"))
 		Expect(fetched.Spec.PrefetchCount).To(Equal(10))
 		Expect(fetched.Spec.ReconnectDelay).To(Equal(10))

diff --git a/api/v1beta1/shovel_webhook_test.go b/api/v1beta1/shovel_webhook_test.go
@@ -6,6 +6,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 )
 
 var _ = Describe("shovel webhook", func() {
@@ -25,12 +26,12 @@ var _ = Describe("shovel webhook", func() {
 			DestinationAddForwardHeaders:     true,
 			DestinationAddTimestampHeader:    true,
 			DestinationAddress:               "myQueue",
-			DestinationApplicationProperties: "a-property",
+			DestinationApplicationProperties: &runtime.RawExtension{Raw: []byte(`{"key": "a-property"}`)},
 			DestinationExchange:              "an-exchange",
 			DestinationExchangeKey:           "a-key",
-			DestinationProperties:            "a-property",
+			DestinationProperties:            &runtime.RawExtension{Raw: []byte(`{"key": "a-property"}`)},
 			DestinationProtocol:              "amqp091",
-			DestinationPublishProperties:     "a-property",
+			DestinationPublishProperties:     &runtime.RawExtension{Raw: []byte(`{"delivery_mode": 1}`)},
 			DestinationQueue:                 "a-queue",
 			PrefetchCount:                    10,
 			ReconnectDelay:                   10,
@@ -156,7 +157,7 @@ var _ = Describe("shovel webhook", func() {
 
 		It("allows updates on DestinationApplicationProperties", func() {
 			newShovel := shovel.DeepCopy()
-			newShovel.Spec.DestinationApplicationProperties = "new-property"
+			newShovel.Spec.DestinationApplicationProperties = &runtime.RawExtension{Raw: []byte(`{"key": "new"}`)}
 			Expect(newShovel.ValidateUpdate(&shovel)).To(Succeed())
 		})
 
@@ -174,7 +175,7 @@ var _ = Describe("shovel webhook", func() {
 
 		It("allows updates on DestinationProperties", func() {
 			newShovel := shovel.DeepCopy()
-			newShovel.Spec.DestinationProperties = "new"
+			newShovel.Spec.DestinationProperties = &runtime.RawExtension{Raw: []byte(`{"key": "new"}`)}
 			Expect(newShovel.ValidateUpdate(&shovel)).To(Succeed())
 		})
 		It("allows updates on DestinationProtocol", func() {
@@ -185,7 +186,7 @@ var _ = Describe("shovel webhook", func() {
 
 		It("allows updates on DestinationPublishProperties", func() {
 			newShovel := shovel.DeepCopy()
-			newShovel.Spec.DestinationPublishProperties = "new-property"
+			newShovel.Spec.DestinationPublishProperties = &runtime.RawExtension{Raw: []byte(`{"key": "new"}`)}
 			Expect(newShovel.ValidateUpdate(&shovel)).To(Succeed())
 		})
 

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/rabbitmq.com_bindings.yaml b/config/crd/bases/rabbitmq.com_bindings.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: bindings.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_exchanges.yaml b/config/crd/bases/rabbitmq.com_exchanges.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: exchanges.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_federations.yaml b/config/crd/bases/rabbitmq.com_federations.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: federations.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_permissions.yaml b/config/crd/bases/rabbitmq.com_permissions.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: permissions.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_policies.yaml b/config/crd/bases/rabbitmq.com_policies.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: policies.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_queues.yaml b/config/crd/bases/rabbitmq.com_queues.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: queues.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_schemareplications.yaml b/config/crd/bases/rabbitmq.com_schemareplications.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: schemareplications.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_shovels.yaml b/config/crd/bases/rabbitmq.com_shovels.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: shovels.rabbitmq.com
 spec:
   group: rabbitmq.com
@@ -56,17 +55,20 @@ spec:
               destAddress:
                 type: string
               destApplicationProperties:
-                type: string
+                type: object
+                x-kubernetes-preserve-unknown-fields: true
               destExchange:
                 type: string
               destExchangeKey:
                 type: string
               destProperties:
-                type: string
+                type: object
+                x-kubernetes-preserve-unknown-fields: true
               destProtocol:
                 type: string
               destPublishProperties:
-                type: string
+                type: object
+                x-kubernetes-preserve-unknown-fields: true
               destQueue:
                 type: string
               name:

diff --git a/config/crd/bases/rabbitmq.com_superstreams.yaml b/config/crd/bases/rabbitmq.com_superstreams.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: superstreams.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_topicpermissions.yaml b/config/crd/bases/rabbitmq.com_topicpermissions.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: topicpermissions.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_users.yaml b/config/crd/bases/rabbitmq.com_users.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: users.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/crd/bases/rabbitmq.com_vhosts.yaml b/config/crd/bases/rabbitmq.com_vhosts.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.11.3
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.11.4
   name: vhosts.rabbitmq.com
 spec:
   group: rabbitmq.com

diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -2,7 +2,6 @@
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-  creationTimestamp: null
   name: manager-role
 rules:
 - apiGroups:

diff --git a/config/webhook/manifests.yaml b/config/webhook/manifests.yaml
@@ -2,7 +2,6 @@
 apiVersion: admissionregistration.k8s.io/v1
 kind: ValidatingWebhookConfiguration
 metadata:
-  creationTimestamp: null
   name: validating-webhook-configuration
 webhooks:
 - admissionReviewVersions:

diff --git a/controllers/shovel_controller.go b/controllers/shovel_controller.go
@@ -29,7 +29,11 @@ func (r *ShovelReconciler) DeclareFunc(ctx context.Context, client rabbitmqclien
 	if err != nil {
 		return fmt.Errorf("failed to parse shovel uri secret; secret name: %s, error: %w", shovel.Spec.UriSecret.Name, err)
 	}
-	return validateResponse(client.DeclareShovel(shovel.Spec.Vhost, shovel.Spec.Name, internal.GenerateShovelDefinition(shovel, srcUri, destUri)))
+	definition, err := internal.GenerateShovelDefinition(shovel, srcUri, destUri)
+	if err != nil {
+		return fmt.Errorf("failed to generate shovel definition: %w", err)
+	}
+	return validateResponse(client.DeclareShovel(shovel.Spec.Vhost, shovel.Spec.Name, *definition))
 }
 func (r *ShovelReconciler) getUris(ctx context.Context, shovel *topology.Shovel) (string, string, error) {
 	if shovel.Spec.UriSecret == nil {