Fix StatefulSetPartitionReconciler event filtering (#879)

* Add predicates tests for StatefulSetPartitionReconciler event filtering

Signed-off-by: sho-iizuka <sho-iizuka@cybozu.co.jp>

* Prevent the partition controller from reconciling non-MOCO StatefulSets

Signed-off-by: sho-iizuka <sho-iizuka@cybozu.co.jp>

---------

Signed-off-by: sho-iizuka <sho-iizuka@cybozu.co.jp>

Author: arosh

controllers/partition_controller.go

@@ -107,6 +107,20 @@ func (r *StatefulSetPartitionReconciler) Reconcile(ctx context.Context, req reco
 }
 
 func (r *StatefulSetPartitionReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	stsPrct := partitionControllerPredicate()
+	podPrct := partitionControllerPredicate()
+
+	return ctrl.NewControllerManagedBy(mgr).
+		For(&appsv1.StatefulSet{}, builder.WithPredicates(stsPrct)).
+		Owns(&corev1.Pod{}, builder.WithPredicates(podPrct)).
+		WithOptions(
+			controller.Options{MaxConcurrentReconciles: r.MaxConcurrentReconciles},
+		).
+		Complete(r)
+}
+
+// partitionControllerPredicate filters StatefulSets and Pods managed by MOCO.
+func partitionControllerPredicate() predicate.Funcs {
 	// Predicate function for StatefulSets and Pods. They have a prefixed name and specific labels.
 	prctFunc := func(o client.Object) bool {
 		if !strings.HasPrefix(o.GetName(), "moco-") {
@@ -123,23 +137,12 @@ func (r *StatefulSetPartitionReconciler) SetupWithManager(mgr ctrl.Manager) erro
 		return true
 	}
 
-	stsPrct := predicate.Funcs{
-		UpdateFunc: func(e event.UpdateEvent) bool { return prctFunc(e.ObjectNew) },
-		CreateFunc: func(e event.CreateEvent) bool { return prctFunc(e.Object) },
+	return predicate.Funcs{
+		UpdateFunc:  func(e event.UpdateEvent) bool { return prctFunc(e.ObjectNew) },
+		CreateFunc:  func(e event.CreateEvent) bool { return prctFunc(e.Object) },
+		DeleteFunc:  func(e event.DeleteEvent) bool { return prctFunc(e.Object) },
+		GenericFunc: func(e event.GenericEvent) bool { return prctFunc(e.Object) },
 	}
-
-	podPrct := predicate.Funcs{
-		UpdateFunc: func(e event.UpdateEvent) bool { return prctFunc(e.ObjectNew) },
-		CreateFunc: func(e event.CreateEvent) bool { return prctFunc(e.Object) },
-	}
-
-	return ctrl.NewControllerManagedBy(mgr).
-		For(&appsv1.StatefulSet{}, builder.WithPredicates(stsPrct)).
-		Owns(&corev1.Pod{}, builder.WithPredicates(podPrct)).
-		WithOptions(
-			controller.Options{MaxConcurrentReconciles: r.MaxConcurrentReconciles},
-		).
-		Complete(r)
 }
 
 // isRolloutReady returns true if the StatefulSet is ready for rolling update.

controllers/partition_controller_test.go

@@ -23,6 +23,7 @@ import (
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/config"
+	"sigs.k8s.io/controller-runtime/pkg/event"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 )
 
@@ -329,3 +330,55 @@ var _ = Describe("StatefulSet reconciler", func() {
 		)
 	})
 })
+
+var _ = Describe("StatefulSetPartitionReconciler predicates", func() {
+	DescribeTable("should filter events",
+		func(obj client.Object, expect bool) {
+			prct := partitionControllerPredicate()
+			Expect(prct.Update(event.UpdateEvent{ObjectNew: obj})).To(Equal(expect))
+			Expect(prct.Create(event.CreateEvent{Object: obj})).To(Equal(expect))
+			Expect(prct.Delete(event.DeleteEvent{Object: obj})).To(Equal(expect))
+			Expect(prct.Generic(event.GenericEvent{Object: obj})).To(Equal(expect))
+		},
+		Entry("statefulset with moco labels", &appsv1.StatefulSet{ObjectMeta: metav1.ObjectMeta{
+			Name: "moco-test",
+			Labels: map[string]string{
+				constants.LabelAppName:      constants.AppNameMySQL,
+				constants.LabelAppCreatedBy: constants.AppCreator,
+			},
+		}}, true),
+		Entry("pod with moco labels", &corev1.Pod{ObjectMeta: metav1.ObjectMeta{
+			Name: "moco-test-0",
+			Labels: map[string]string{
+				constants.LabelAppName:      constants.AppNameMySQL,
+				constants.LabelAppCreatedBy: constants.AppCreator,
+			},
+		}}, true),
+		Entry("statefulset without prefix", &appsv1.StatefulSet{ObjectMeta: metav1.ObjectMeta{
+			Name: "test",
+			Labels: map[string]string{
+				constants.LabelAppName:      constants.AppNameMySQL,
+				constants.LabelAppCreatedBy: constants.AppCreator,
+			},
+		}}, false),
+		Entry("statefulset without app label", &appsv1.StatefulSet{ObjectMeta: metav1.ObjectMeta{
+			Name: "moco-test",
+			Labels: map[string]string{
+				constants.LabelAppCreatedBy: constants.AppCreator,
+			},
+		}}, false),
+		Entry("statefulset without creator label", &appsv1.StatefulSet{ObjectMeta: metav1.ObjectMeta{
+			Name: "moco-test",
+			Labels: map[string]string{
+				constants.LabelAppName: constants.AppNameMySQL,
+			},
+		}}, false),
+		Entry("statefulset with wrong labels", &appsv1.StatefulSet{ObjectMeta: metav1.ObjectMeta{
+			Name: "moco-test",
+			Labels: map[string]string{
+				constants.LabelAppName:      constants.AppNameMySQL,
+				constants.LabelAppCreatedBy: "other",
+			},
+		}}, false),
+	)
+})