ROX-28223: Pause-reconcile handler

pkg/reconciler/reconciler.go

@@ -83,13 +83,13 @@ type Reconciler struct {
 	maxReleaseHistory                *int
 	skipPrimaryGVKSchemeRegistration bool
 	controllerSetupFuncs             []ControllerSetupFunc
+	pauseHandler                     PauseReconcileHandlerFunc
 
-	annotSetupOnce           sync.Once
-	annotations              map[string]struct{}
-	installAnnotations       map[string]annotation.Install
-	upgradeAnnotations       map[string]annotation.Upgrade
-	uninstallAnnotations     map[string]annotation.Uninstall
-	pauseReconcileAnnotation string
+	annotSetupOnce       sync.Once
+	annotations          map[string]struct{}
+	installAnnotations   map[string]annotation.Install
+	upgradeAnnotations   map[string]annotation.Upgrade
+	uninstallAnnotations map[string]annotation.Uninstall
 }
 
 // New creates a new Reconciler that reconciles custom resources that define a
@@ -440,18 +440,35 @@ func WithUninstallAnnotations(as ...annotation.Uninstall) Option {
 	}
 }
 
-// WithPauseReconcileAnnotation is an Option that sets
-// a PauseReconcile annotation. If the Custom Resource watched by this
-// reconciler has the given annotation, and its value is set to `true`,
-// then reconciliation for this CR will not be performed until this annotation
-// is removed.
-func WithPauseReconcileAnnotation(annotationName string) Option {
+// PauseReconcileHandlerFunc defines a function type that determines whether reconciliation should be paused
+// for a given custom resource
+type PauseReconcileHandlerFunc func(ctx context.Context, obj *unstructured.Unstructured) (bool, error)
+
+// WithPauseReconcileHandler is an Option that sets a PauseReconcile handler, which is a function that
+// that determines whether reconciliation should be paused for the custom resource watched by this reconciler.
+//
+// Example usage: WithPauseReconcileHandler(PauseReconcileIfAnnotationTrue("my.domain/pause-reconcile"))
+func WithPauseReconcileHandler(handler PauseReconcileHandlerFunc) Option {
 	return func(r *Reconciler) error {
-		r.pauseReconcileAnnotation = annotationName
+		r.pauseHandler = handler
 		return nil
 	}
 }
 
+// PauseReconcileIfAnnotationTrue returns a PauseReconcileHandlerFunc that pauses reconciliation if the given
+// annotation is present and set to "true"
+func PauseReconcileIfAnnotationTrue(annotationName string) PauseReconcileHandlerFunc {
+	return func(ctx context.Context, obj *unstructured.Unstructured) (bool, error) {
+		if v, ok := obj.GetAnnotations()[annotationName]; ok {
+			if v == "true" {
+				return true, nil
+			}
+		}
+
+		return false, nil
+	}
+}
+
 // WithPreHook is an Option that configures the reconciler to run the given
 // PreHook just before performing any actions (e.g. install, upgrade, uninstall,
 // or reconciliation).
@@ -604,21 +621,22 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Re
 		}
 	}()
 
-	if r.pauseReconcileAnnotation != "" {
-		if v, ok := obj.GetAnnotations()[r.pauseReconcileAnnotation]; ok {
-			if v == "true" {
-				log.Info(fmt.Sprintf("Resource has '%s' annotation set to 'true', reconcile paused.", r.pauseReconcileAnnotation))
-				u.UpdateStatus(
-					updater.EnsureCondition(conditions.Paused(corev1.ConditionTrue, conditions.ReasonPauseReconcileAnnotationTrue, "")),
-					updater.EnsureConditionUnknown(conditions.TypeIrreconcilable),
-					updater.EnsureConditionUnknown(conditions.TypeDeployed),
-					updater.EnsureConditionUnknown(conditions.TypeInitialized),
-					updater.EnsureConditionUnknown(conditions.TypeReleaseFailed),
-					updater.EnsureDeployedRelease(nil),
-				)
-				return ctrl.Result{}, nil
-			}
-		}
+	paused, err := r.pauseHandler(ctx, obj)
+	if err != nil {
+		log.Error(err, "pause reconcile handler failed")
+	}
+
+	if paused {
+		log.Info("Reconcile is paused for this resource.")
+		u.UpdateStatus(
+			updater.EnsureCondition(conditions.Paused(corev1.ConditionTrue, conditions.ReasonPauseReconcileAnnotationTrue, "")),
+			updater.EnsureConditionUnknown(conditions.TypeIrreconcilable),
+			updater.EnsureConditionUnknown(conditions.TypeDeployed),
+			updater.EnsureConditionUnknown(conditions.TypeInitialized),
+			updater.EnsureConditionUnknown(conditions.TypeReleaseFailed),
+			updater.EnsureDeployedRelease(nil),
+		)
+		return ctrl.Result{}, nil
 	}
 
 	u.UpdateStatus(updater.EnsureCondition(conditions.Paused(corev1.ConditionFalse, "", "")))

pkg/reconciler/reconciler_test.go

@@ -394,13 +394,6 @@ var _ = Describe("Reconciler", func() {
 				}))
 			})
 		})
-		_ = Describe("WithPauseReconcileAnnotation", func() {
-			It("should set the pauseReconcileAnnotation field to the annotation name", func() {
-				a := "my.domain/pause-reconcile"
-				Expect(WithPauseReconcileAnnotation(a)(r)).To(Succeed())
-				Expect(r.pauseReconcileAnnotation).To(Equal(a))
-			})
-		})
 		_ = Describe("WithPreHook", func() {
 			It("should set a reconciler prehook", func() {
 				called := false
@@ -542,7 +535,7 @@ var _ = Describe("Reconciler", func() {
 						WithInstallAnnotations(annotation.InstallDescription{}),
 						WithUpgradeAnnotations(annotation.UpgradeDescription{}),
 						WithUninstallAnnotations(annotation.UninstallDescription{}),
-						WithPauseReconcileAnnotation("my.domain/pause-reconcile"),
+						WithPauseReconcileHandler(PauseReconcileIfAnnotationTrue("my.domain/pause-reconcile")),
 						WithOverrideValues(map[string]string{
 							"image.repository": "custom-nginx",
 						}),
@@ -557,7 +550,7 @@ var _ = Describe("Reconciler", func() {
 						WithInstallAnnotations(annotation.InstallDescription{}),
 						WithUpgradeAnnotations(annotation.UpgradeDescription{}),
 						WithUninstallAnnotations(annotation.UninstallDescription{}),
-						WithPauseReconcileAnnotation("my.domain/pause-reconcile"),
+						WithPauseReconcileHandler(PauseReconcileIfAnnotationTrue("my.domain/pause-reconcile")),
 						WithOverrideValues(map[string]string{
 							"image.repository": "custom-nginx",
 						}),