Update controller predicates to make them more flexible and independe…

…nt (#343)
hashicorp · Feb 26, 2024 · cfff91f · cfff91f
1 parent acae4c2
commit cfff91f
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 5 deletions.
diff --git a/controllers/agentpool_controller.go b/controllers/agentpool_controller.go
@@ -22,6 +22,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	"github.com/go-logr/logr"
 	tfc "github.com/hashicorp/go-tfe"
@@ -112,7 +113,7 @@ func (r *AgentPoolReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 func (r *AgentPoolReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appv1alpha2.AgentPool{}).
-		WithEventFilter(handlePredicates()).
+		WithEventFilter(predicate.Or(genericPredicates())).
 		Complete(r)
 }
 

diff --git a/controllers/module_controller.go b/controllers/module_controller.go
@@ -23,6 +23,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	"github.com/go-logr/logr"
 	"github.com/hashicorp/go-slug"
@@ -133,7 +134,7 @@ func (r *ModuleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
 func (r *ModuleReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appv1alpha2.Module{}).
-		WithEventFilter(handlePredicates()).
+		WithEventFilter(predicate.Or(genericPredicates())).
 		Complete(r)
 }
 

diff --git a/controllers/predicates.go b/controllers/predicates.go
@@ -10,7 +10,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
-func handlePredicates() predicate.Predicate {
+// genericPredicates return predicates that are common for all controllers.
+// Controller specific predicates should be named <CONTROLLER-NAME>Predicates.
+// For example: workspacePredicates().
+func genericPredicates() predicate.Predicate {
 	return predicate.Funcs{
 		CreateFunc: func(e event.CreateEvent) bool {
 			return true

diff --git a/controllers/project_controller.go b/controllers/project_controller.go
@@ -23,6 +23,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	appv1alpha2 "github.com/hashicorp/terraform-cloud-operator/api/v1alpha2"
 )
@@ -171,7 +172,7 @@ func (r *ProjectReconciler) getTerraformClient(ctx context.Context, p *projectIn
 func (r *ProjectReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appv1alpha2.Project{}).
-		WithEventFilter(handlePredicates()).
+		WithEventFilter(predicate.Or(genericPredicates())).
 		Complete(r)
 }
 

diff --git a/controllers/workspace_controller.go b/controllers/workspace_controller.go
@@ -21,6 +21,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	"github.com/go-logr/logr"
 
@@ -119,7 +120,7 @@ func (r *WorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 func (r *WorkspaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appv1alpha2.Workspace{}).
-		WithEventFilter(handlePredicates()).
+		WithEventFilter(predicate.Or(genericPredicates())).
 		Complete(r)
 }