expand metadata mutator for finalizers and owner references

docs/libs/resource.md

@@ -9,12 +9,15 @@ Create or update a `ConfigMap`, a `ServiceAccount` and a `Deployment` using the
 
 ```go
 type myDeploymentMutator struct {
+	meta MetadataMutator
 }
 
 var _ resource.Mutator[*appsv1.Deployment] = &myDeploymentMutator{}
 
-func newDeploymentMutator() resources.Mutator[*appsv1.Deployment] {
-	return &MyDeploymentMutator{}
+func newDeploymentMutator() resource.Mutator[*appsv1.Deployment] {
+	return &MyDeploymentMutator{
+		meta: NewMetadataMutator()
+	}
 }
 
 func (m *MyDeploymentMutator) String() string {
@@ -38,17 +41,22 @@ func (m *MyDeploymentMutator) Mutate(deployment *appsv1.Deployment) error {
 			Image: "test-image:latest",
 		},
 	}
-	return nil
+	return m.meta.Mutate(deployment)
+}
+
+func (m *MyDeploymentMutator) MetadataMutator() resource.MetadataMutator {
+	return m.meta
 }
 
 
 func ReconcileResources(ctx context.Context, client client.Client) error {
-	configMapResource := resource.NewConfigMap("my-configmap", "my-namespace", map[string]string{
+	configMapResource := resource.NewConfigMapMutator("my-configmap", "my-namespace")
+	configMapResource.MetadataMutator().WithLabels(map[string]string{
 		"label1": "value1",
 		"label2": "value2",
-	}, nil)
+	})
 
-	serviceAccountResource := resource.NewServiceAccount("my-serviceaccount", "my-namespace", nil, nil)
+	serviceAccountResource := resource.NewServiceAccountMutator("my-serviceaccount", "my-namespace")
 
 	myDeploymentMutator := newDeploymentMutator()
 

pkg/crds/crds.go

@@ -57,7 +57,9 @@ func (m *CRDManager) CreateOrUpdateCRDs(ctx context.Context, log *logging.Logger
 		if log != nil {
 			log.Info("creating/updating CRD", "name", crd.Name, "cluster", c.ID())
 		}
-		err = resources.CreateOrUpdateResource(ctx, c.Client(), resources.NewCRDMutator(crd, crd.Labels, crd.Annotations))
+		m := resources.NewCRDMutator(crd)
+		m.MetadataMutator().WithLabels(crd.Labels).WithAnnotations(crd.Annotations)
+		err = resources.CreateOrUpdateResource(ctx, c.Client(), m)
 		errs = errors.Join(errs, err)
 	}
 

pkg/resources/clusterrole.go

@@ -3,25 +3,23 @@ package resources
 import (
 	"fmt"
 
-	"sigs.k8s.io/controller-runtime/pkg/client"
-
 	v1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 type ClusterRoleMutator struct {
 	Name  string
 	Rules []v1.PolicyRule
-	meta  Mutator[client.Object]
+	meta  MetadataMutator
 }
 
 var _ Mutator[*v1.ClusterRole] = &ClusterRoleMutator{}
 
-func NewClusterRoleMutator(name string, rules []v1.PolicyRule, labels map[string]string, annotations map[string]string) Mutator[*v1.ClusterRole] {
+func NewClusterRoleMutator(name string, rules []v1.PolicyRule) Mutator[*v1.ClusterRole] {
 	return &ClusterRoleMutator{
 		Name:  name,
 		Rules: rules,
-		meta:  NewMetadataMutator(labels, annotations),
+		meta:  NewMetadataMutator(),
 	}
 }
 
@@ -45,3 +43,7 @@ func (m *ClusterRoleMutator) Mutate(r *v1.ClusterRole) error {
 	r.Rules = m.Rules
 	return m.meta.Mutate(r)
 }
+
+func (m *ClusterRoleMutator) MetadataMutator() MetadataMutator {
+	return m.meta
+}

pkg/resources/clusterrole_test.go

@@ -48,7 +48,8 @@ var _ = Describe("ClusterRoleMutator", func() {
 		annotations = map[string]string{"annotation1": "value1"}
 
 		// Create a cluster role mutator
-		mutator = resources.NewClusterRoleMutator("test-clusterrole", rules, labels, annotations)
+		mutator = resources.NewClusterRoleMutator("test-clusterrole", rules)
+		mutator.MetadataMutator().WithLabels(labels).WithAnnotations(annotations)
 	})
 
 	It("should create an empty cluster role with correct metadata", func() {

pkg/resources/clusterrolebinding.go

@@ -3,8 +3,6 @@ package resources
 import (
 	"fmt"
 
-	"sigs.k8s.io/controller-runtime/pkg/client"
-
 	v1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -13,17 +11,17 @@ type ClusterRoleBindingMutator struct {
 	ClusterRoleBindingName string
 	RoleRef                v1.RoleRef
 	Subjects               []v1.Subject
-	meta                   Mutator[client.Object]
+	meta                   MetadataMutator
 }
 
 var _ Mutator[*v1.ClusterRoleBinding] = &ClusterRoleBindingMutator{}
 
-func NewClusterRoleBindingMutator(clusterRoleBindingName string, subjects []v1.Subject, roleRef v1.RoleRef, labels map[string]string, annotations map[string]string) Mutator[*v1.ClusterRoleBinding] {
+func NewClusterRoleBindingMutator(clusterRoleBindingName string, subjects []v1.Subject, roleRef v1.RoleRef) Mutator[*v1.ClusterRoleBinding] {
 	return &ClusterRoleBindingMutator{
 		ClusterRoleBindingName: clusterRoleBindingName,
 		RoleRef:                roleRef,
 		Subjects:               subjects,
-		meta:                   NewMetadataMutator(labels, annotations),
+		meta:                   NewMetadataMutator(),
 	}
 }
 
@@ -48,3 +46,7 @@ func (m *ClusterRoleBindingMutator) Mutate(r *v1.ClusterRoleBinding) error {
 	r.Subjects = m.Subjects
 	return m.meta.Mutate(r)
 }
+
+func (m *ClusterRoleBindingMutator) MetadataMutator() MetadataMutator {
+	return m.meta
+}

pkg/resources/clusterrolebinding_test.go

@@ -50,7 +50,8 @@ var _ = Describe("ClusterRoleBindingMutator", func() {
 		annotations = map[string]string{"annotation1": "value1"}
 
 		// Create a cluster role binding mutator
-		mutator = resources.NewClusterRoleBindingMutator("test-clusterrolebinding", subjects, roleRef, labels, annotations)
+		mutator = resources.NewClusterRoleBindingMutator("test-clusterrolebinding", subjects, roleRef)
+		mutator.MetadataMutator().WithLabels(labels).WithAnnotations(annotations)
 	})
 
 	It("should create an empty cluster role binding with correct metadata", func() {

pkg/resources/configmap.go

@@ -5,24 +5,23 @@ import (
 
 	core "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 type ConfigMapMutator struct {
 	Name      string
 	Namespace string
 	Data      map[string]string
-	meta      Mutator[client.Object]
+	meta      MetadataMutator
 }
 
 var _ Mutator[*core.ConfigMap] = &ConfigMapMutator{}
 
-func NewConfigMapMutator(name, namespace string, data map[string]string, labels map[string]string, annotations map[string]string) Mutator[*core.ConfigMap] {
+func NewConfigMapMutator(name, namespace string, data map[string]string) Mutator[*core.ConfigMap] {
 	return &ConfigMapMutator{
 		Name:      name,
 		Namespace: namespace,
 		Data:      data,
-		meta:      NewMetadataMutator(labels, annotations),
+		meta:      NewMetadataMutator(),
 	}
 }
 
@@ -53,3 +52,7 @@ func (m *ConfigMapMutator) Mutate(cm *core.ConfigMap) error {
 	}
 	return m.meta.Mutate(cm)
 }
+
+func (m *ConfigMapMutator) MetadataMutator() MetadataMutator {
+	return m.meta
+}

pkg/resources/configmap_test.go

@@ -42,7 +42,8 @@ var _ = Describe("ConfigMapMutator", func() {
 		annotations = map[string]string{"annotation1": "value1"}
 
 		// Create a ConfigMap mutator
-		mutator = resources.NewConfigMapMutator("test-configmap", "test-namespace", data, labels, annotations)
+		mutator = resources.NewConfigMapMutator("test-configmap", "test-namespace", data)
+		mutator.MetadataMutator().WithLabels(labels).WithAnnotations(annotations)
 	})
 
 	It("should create an empty ConfigMap with correct metadata", func() {

pkg/resources/crd.go

@@ -3,21 +3,19 @@ package resources
 import (
 	"fmt"
 
-	"sigs.k8s.io/controller-runtime/pkg/client"
-
 	apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 type crdMutator struct {
 	crd  *apiextv1.CustomResourceDefinition
-	meta Mutator[client.Object]
+	meta MetadataMutator
 }
 
 var _ Mutator[*apiextv1.CustomResourceDefinition] = &crdMutator{}
 
-func NewCRDMutator(crd *apiextv1.CustomResourceDefinition, labels map[string]string, annotations map[string]string) Mutator[*apiextv1.CustomResourceDefinition] {
-	return &crdMutator{crd: crd, meta: NewMetadataMutator(labels, annotations)}
+func NewCRDMutator(crd *apiextv1.CustomResourceDefinition) Mutator[*apiextv1.CustomResourceDefinition] {
+	return &crdMutator{crd: crd, meta: NewMetadataMutator()}
 }
 
 func (m *crdMutator) String() string {
@@ -40,3 +38,7 @@ func (m *crdMutator) Mutate(r *apiextv1.CustomResourceDefinition) error {
 	m.crd.Spec.DeepCopyInto(&r.Spec)
 	return m.meta.Mutate(r)
 }
+
+func (m *crdMutator) MetadataMutator() MetadataMutator {
+	return m.meta
+}

pkg/resources/crd_test.go

@@ -61,7 +61,8 @@ var _ = Describe("CRDMutator", func() {
 		}
 
 		// Create a CRD mutator
-		mutator = resources.NewCRDMutator(crd, labels, annotations)
+		mutator = resources.NewCRDMutator(crd)
+		mutator.MetadataMutator().WithLabels(labels).WithAnnotations(annotations)
 	})
 
 	It("should create an empty CRD with correct metadata", func() {

pkg/resources/metadata.go

@@ -1,21 +1,52 @@
 package resources
 
 import (
+	"maps"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 type metadataMutator struct {
-	Labels      map[string]string
-	Annotations map[string]string
+	Labels          map[string]string
+	Annotations     map[string]string
+	OwnerReferences []metav1.OwnerReference
+	Finalizers      []string
+}
+
+type MetadataMutator interface {
+	Mutator[client.Object]
+	WithOwnerReferences(ownerReferences []metav1.OwnerReference) MetadataMutator
+	WithFinalizers(finalizers []string) MetadataMutator
+	WithLabels(labels map[string]string) MetadataMutator
+	WithAnnotations(annotations map[string]string) MetadataMutator
 }
 
 var _ Mutator[client.Object] = &metadataMutator{}
+var _ MetadataMutator = &metadataMutator{}
 
-func NewMetadataMutator(labels map[string]string, annotations map[string]string) Mutator[client.Object] {
-	return &metadataMutator{
-		Labels:      labels,
-		Annotations: annotations,
-	}
+func NewMetadataMutator() MetadataMutator {
+	return &metadataMutator{}
+}
+
+func (m *metadataMutator) WithLabels(labels map[string]string) MetadataMutator {
+	m.Labels = labels
+	return m
+}
+
+func (m *metadataMutator) WithAnnotations(annotations map[string]string) MetadataMutator {
+	m.Annotations = annotations
+	return m
+}
+
+func (m *metadataMutator) WithOwnerReferences(ownerReferences []metav1.OwnerReference) MetadataMutator {
+	m.OwnerReferences = ownerReferences
+	return m
+}
+
+func (m *metadataMutator) WithFinalizers(finalizers []string) MetadataMutator {
+	m.Finalizers = finalizers
+	return m
 }
 
 func (m *metadataMutator) String() string {
@@ -31,19 +62,62 @@ func (m *metadataMutator) Mutate(res client.Object) error {
 		if res.GetLabels() == nil {
 			res.SetLabels(make(map[string]string))
 		}
-		for k, v := range m.Labels {
-			res.GetLabels()[k] = v
-		}
+		maps.Copy(res.GetLabels(), m.Labels)
 	}
 
 	if m.Annotations != nil {
 		if res.GetAnnotations() == nil {
 			res.SetAnnotations(make(map[string]string))
 		}
+		maps.Copy(res.GetAnnotations(), m.Annotations)
+	}
+
+	if m.OwnerReferences != nil {
+		// ensure that all owner references in m are also in res
+		if len(res.GetOwnerReferences()) == 0 {
+			res.SetOwnerReferences(make([]metav1.OwnerReference, len(m.OwnerReferences)))
+			for i, ownerRef := range m.OwnerReferences {
+				res.GetOwnerReferences()[i] = *ownerRef.DeepCopy()
+			}
+		} else {
+			for _, ownerRef := range m.OwnerReferences {
+				found := false
+				for _, existingRef := range res.GetOwnerReferences() {
+					if ownerRef.UID == existingRef.UID {
+						found = true
+						break
+					}
+				}
+				if !found {
+					res.SetOwnerReferences(append(res.GetOwnerReferences(), *ownerRef.DeepCopy()))
+				}
+			}
+		}
+	}
 
-		for k, v := range m.Annotations {
-			res.GetAnnotations()[k] = v
+	if m.Finalizers != nil {
+		if len(res.GetFinalizers()) == 0 {
+			res.SetFinalizers(make([]string, len(m.Finalizers)))
+			copy(res.GetFinalizers(), m.Finalizers)
+		} else {
+			for _, fin := range m.Finalizers {
+				found := false
+				for _, existingFin := range res.GetFinalizers() {
+					if fin == existingFin {
+						found = true
+						break
+					}
+				}
+				if !found {
+					res.SetFinalizers(append(res.GetFinalizers(), fin))
+				}
+			}
 		}
 	}
+
 	return nil
 }
+
+func (m *metadataMutator) MetadataMutator() MetadataMutator {
+	return m
+}