Merge pull request #961 from aawoznia26/922_controlling_resources_deletion

[#922] controlling resources deletion

Author: Zerpet

api/v1beta1/federation_types.go

@@ -35,6 +35,11 @@ type FederationSpec struct {
 	TrustUserId    bool   `json:"trustUserId,omitempty"`
 	Exchange       string `json:"exchange,omitempty"`
 	Queue          string `json:"queue,omitempty"`
+	// DeletionPolicy defines the behavior of federation in the RabbitMQ cluster when the corresponding custom resource is deleted.
+	// Can be set to 'delete' or 'retain'. Default is 'delete'.
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=delete
+	DeletionPolicy string `json:"deletionPolicy,omitempty"`
 }
 
 // FederationStatus defines the observed state of Federation

api/v1beta1/federation_types_test.go

@@ -25,6 +25,7 @@ var _ = Describe("Federation spec", func() {
 			UriSecret: &corev1.LocalObjectReference{
 				Name: "a-secret",
 			},
+			DeletionPolicy: "delete",
 		}
 
 		federation := Federation{
@@ -122,4 +123,32 @@ var _ = Describe("Federation spec", func() {
 			Expect(k8sClient.Create(ctx, &federation)).To(MatchError(`Federation.rabbitmq.com "invalid-federation" is invalid: spec.ackMode: Unsupported value: "non-existing-ackmode": supported values: "on-confirm", "on-publish", "no-ack"`))
 		})
 	})
+
+	It("creates a federation with non-default DeletionPolicy", func() {
+		federation := Federation{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "federation-with-retain-policy",
+				Namespace: namespace,
+			},
+			Spec: FederationSpec{
+				Name:           "federation-with-retain-policy",
+				DeletionPolicy: "retain",
+				UriSecret: &corev1.LocalObjectReference{
+					Name: "a-secret",
+				},
+				RabbitmqClusterReference: RabbitmqClusterReference{
+					Name: "some-cluster",
+				},
+			},
+		}
+		Expect(k8sClient.Create(ctx, &federation)).To(Succeed())
+		fetched := &Federation{}
+		Expect(k8sClient.Get(ctx, types.NamespacedName{
+			Name:      federation.Name,
+			Namespace: federation.Namespace,
+		}, fetched)).To(Succeed())
+
+		Expect(fetched.Spec.DeletionPolicy).To(Equal("retain"))
+		Expect(fetched.Spec.Name).To(Equal("federation-with-retain-policy"))
+	})
 })

api/v1beta1/federation_webhook_test.go

@@ -115,5 +115,12 @@ var _ = Describe("federation webhook", func() {
 			_, err := newFederation.ValidateUpdate(rootCtx, &federation, newFederation)
 			Expect(err).To(Succeed())
 		})
+
+		It("allows updates on federation.spec.deletionPolicy", func() {
+			newFederation := federation.DeepCopy()
+			newFederation.Spec.DeletionPolicy = "retain"
+			_, err := newFederation.ValidateUpdate(rootCtx, &federation, newFederation)
+			Expect(err).ToNot(HaveOccurred())
+		})
 	})
 })

api/v1beta1/queue_types.go

@@ -45,6 +45,11 @@ type QueueSpec struct {
 	// Required property.
 	// +kubebuilder:validation:Required
 	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
+	// DeletionPolicy defines the behavior of queue in the RabbitMQ cluster when the corresponding custom resource is deleted.
+	// Can be set to 'delete' or 'retain'. Default is 'delete'.
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=delete
+	DeletionPolicy string `json:"deletionPolicy,omitempty"`
 }
 
 // QueueStatus defines the observed state of Queue

api/v1beta1/queue_types_test.go

@@ -17,10 +17,11 @@ var _ = Describe("Queue spec", func() {
 
 	It("creates a queue with default settings", func() {
 		expectedSpec := QueueSpec{
-			Name:       "test-queue",
-			Vhost:      "/",
-			Durable:    false,
-			AutoDelete: false,
+			Name:           "test-queue",
+			Vhost:          "/",
+			Durable:        false,
+			AutoDelete:     false,
+			DeletionPolicy: "delete",
 			RabbitmqClusterReference: RabbitmqClusterReference{
 				Name: "some-cluster",
 			},
@@ -85,4 +86,29 @@ var _ = Describe("Queue spec", func() {
 			}))
 		Expect(fetchedQ.Spec.Arguments.Raw).To(Equal([]byte(`{"yoyo":10}`)))
 	})
+
+	It("creates a queue with non-default DeletionPolicy", func() {
+		q := Queue{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "queue-with-retain-policy",
+				Namespace: namespace,
+			},
+			Spec: QueueSpec{
+				Name:           "queue-with-retain-policy",
+				DeletionPolicy: "retain",
+				RabbitmqClusterReference: RabbitmqClusterReference{
+					Name: "random-cluster",
+				},
+			},
+		}
+		Expect(k8sClient.Create(ctx, &q)).To(Succeed())
+		fetchedQ := &Queue{}
+		Expect(k8sClient.Get(ctx, types.NamespacedName{
+			Name:      q.Name,
+			Namespace: q.Namespace,
+		}, fetchedQ)).To(Succeed())
+
+		Expect(fetchedQ.Spec.DeletionPolicy).To(Equal("retain"))
+		Expect(fetchedQ.Spec.Name).To(Equal("queue-with-retain-policy"))
+	})
 })

api/v1beta1/queue_webhook_test.go

@@ -154,5 +154,12 @@ var _ = Describe("queue webhook", func() {
 			_, err = newQueue.ValidateUpdate(rootCtx, &queue, newQueue)
 			Expect(err).To(MatchError(ContainSubstring("queue arguments cannot be updated")))
 		})
+
+		It("allows updates on queue.spec.deletionPolicy", func() {
+			newQueue := queue.DeepCopy()
+			newQueue.Spec.DeletionPolicy = "retain"
+			_, err := newQueue.ValidateUpdate(rootCtx, &queue, newQueue)
+			Expect(err).ToNot(HaveOccurred())
+		})
 	})
 })

api/v1beta1/shovel_types.go

@@ -84,6 +84,11 @@ type ShovelSpec struct {
 	SourceConsumerArgs *runtime.RawExtension `json:"srcConsumerArgs,omitempty"`
 	// amqp10 configuration; required if srcProtocol is amqp10
 	SourceAddress string `json:"srcAddress,omitempty"`
+	// DeletionPolicy defines the behavior of shovel in the RabbitMQ cluster when the corresponding custom resource is deleted.
+	// Can be set to 'delete' or 'retain'. Default is 'delete'.
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=delete
+	DeletionPolicy string `json:"deletionPolicy,omitempty"`
 }
 
 // ShovelStatus defines the observed state of Shovel

api/v1beta1/shovel_types_test.go

@@ -193,4 +193,36 @@ var _ = Describe("Shovel spec", func() {
 			Expect(k8sClient.Create(ctx, &shovel)).To(MatchError(`Shovel.rabbitmq.com "an-invalid-srcprotocol" is invalid: spec.srcProtocol: Unsupported value: "mqtt": supported values: "amqp091", "amqp10"`))
 		})
 	})
+
+	It("creates a shovel with non-default DeletionPolicy", func() {
+		shovel := Shovel{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "shovel-with-retain-policy",
+				Namespace: namespace,
+			},
+			Spec: ShovelSpec{
+				Name:           "shovel-with-retain-policy",
+				DeletionPolicy: "retain",
+				RabbitmqClusterReference: RabbitmqClusterReference{
+					Name: "some-cluster",
+				},
+				UriSecret: &corev1.LocalObjectReference{
+					Name: "a-secret",
+				},
+			},
+		}
+		Expect(k8sClient.Create(ctx, &shovel)).To(Succeed())
+		fetched := &Shovel{}
+		Expect(k8sClient.Get(ctx, types.NamespacedName{
+			Name:      shovel.Name,
+			Namespace: shovel.Namespace,
+		}, fetched)).To(Succeed())
+
+		Expect(fetched.Spec.DeletionPolicy).To(Equal("retain"))
+		Expect(fetched.Spec.Name).To(Equal("shovel-with-retain-policy"))
+		Expect(fetched.Spec.RabbitmqClusterReference).To(Equal(RabbitmqClusterReference{
+			Name: "some-cluster",
+		}))
+		Expect(fetched.Spec.UriSecret.Name).To(Equal("a-secret"))
+	})
 })

api/v1beta1/shovel_webhook_test.go

@@ -179,5 +179,12 @@ var _ = Describe("shovel webhook", func() {
 			_, err := newShovel.ValidateUpdate(rootCtx, &shovel, newShovel)
 			Expect(err).ToNot(HaveOccurred())
 		})
+
+		It("allows updates on shovel.spec.deletionPolicy", func() {
+			newShovel := shovel.DeepCopy()
+			newShovel.Spec.DeletionPolicy = "retain"
+			_, err := newShovel.ValidateUpdate(rootCtx, &shovel, newShovel)
+			Expect(err).ToNot(HaveOccurred())
+		})
 	})
 })

api/v1beta1/vhost_types.go

@@ -29,6 +29,11 @@ type VhostSpec struct {
 	// Required property.
 	// +kubebuilder:validation:Required
 	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
+	// DeletionPolicy defines the behavior of vhost in the RabbitMQ cluster when the corresponding custom resource is deleted.
+	// Can be set to 'delete' or 'retain'. Default is 'delete'.
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=delete
+	DeletionPolicy string `json:"deletionPolicy,omitempty"`
 }
 
 // VhostStatus defines the observed state of Vhost