library improvements (from implementing Landscape controller of Gardener ClusterProvider)

Author: Diaphteiros

pkg/clusters/cluster.go

@@ -40,6 +40,13 @@ func (c *Cluster) WithConfigPath(cfgPath string) *Cluster {
 	return c
 }
 
+// WithRestConfig allows to set the REST config manually.
+// Returns the cluster for chaining.
+func (c *Cluster) WithRESTConfig(cfg *rest.Config) *Cluster {
+	c.restCfg = cfg
+	return c
+}
+
 // RegisterConfigPathFlag adds a flag '--<id>-cluster' for the cluster's config path to the given flag set.
 // Panics if the cluster's id is not set.
 func (c *Cluster) RegisterConfigPathFlag(flags *flag.FlagSet) {
@@ -117,7 +124,7 @@ func (c *Cluster) InitializeClient(scheme *runtime.Scheme) error {
 	if err != nil {
 		return fmt.Errorf("failed to create '%s' cluster client: %w", c.ID(), err)
 	}
-	clu, err := cluster.New(c.restCfg, func(o *cluster.Options) { o.Scheme = scheme })
+	clu, err := cluster.New(c.restCfg, func(o *cluster.Options) { o.Scheme = scheme; o.Cache.Scheme = scheme })
 	if err != nil {
 		return fmt.Errorf("failed to create '%s' cluster Cluster representation: %w", c.ID(), err)
 	}

pkg/conditions/updater_test.go

@@ -7,6 +7,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
 	. "github.com/openmcp-project/controller-utils/pkg/testing/matchers"
 
 	"github.com/openmcp-project/controller-utils/pkg/conditions"

pkg/controller/annotation_label.go

@@ -103,7 +103,6 @@ func EnsureLabel(ctx context.Context, c client.Client, obj client.Object, labelK
 }
 
 // ensureMetadataEntry is the common base method for EnsureAnnotation and EnsureLabel.
-// This is mainly exposed for testing purposes, usually it is statically known whether an annotation or label is to be modified and the respective method should be used.
 func ensureMetadataEntry(mType metadataEntryType, ctx context.Context, c client.Client, obj client.Object, key, value string, patch bool, mode ...ModifyMetadataEntryMode) error {
 	modeDelete := false
 	modeOverwrite := false

pkg/controller/predicates.go

@@ -10,6 +10,47 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
+//////////////////
+/// CONVERSION ///
+//////////////////
+
+// ToTypedPredicate wraps a predicate.Predicate (which is an alias for predicate.TypedPredicate[client.Object]) into a predicate.TypedPredicate[Obj].
+func ToTypedPredicate[Obj client.Object](p predicate.Predicate) predicate.TypedPredicate[Obj] {
+	return &typedPredicateConverter[Obj]{internal: p}
+}
+
+type typedPredicateConverter[Obj client.Object] struct {
+	internal predicate.Predicate
+}
+
+var _ predicate.TypedPredicate[client.Object] = &typedPredicateConverter[client.Object]{}
+
+func (t *typedPredicateConverter[Obj]) Create(e event.TypedCreateEvent[Obj]) bool {
+	return t.internal.Create(event.TypedCreateEvent[client.Object]{
+		Object: e.Object,
+	})
+}
+
+func (t *typedPredicateConverter[Obj]) Delete(e event.TypedDeleteEvent[Obj]) bool {
+	return t.internal.Delete(event.TypedDeleteEvent[client.Object]{
+		Object:             e.Object,
+		DeleteStateUnknown: e.DeleteStateUnknown,
+	})
+}
+
+func (t *typedPredicateConverter[Obj]) Generic(e event.TypedGenericEvent[Obj]) bool {
+	return t.internal.Generic(event.TypedGenericEvent[client.Object]{
+		Object: e.Object,
+	})
+}
+
+func (t *typedPredicateConverter[Obj]) Update(e event.TypedUpdateEvent[Obj]) bool {
+	return t.internal.Update(event.TypedUpdateEvent[client.Object]{
+		ObjectOld: e.ObjectOld,
+		ObjectNew: e.ObjectNew,
+	})
+}
+
 /////////////////////////////////////
 /// DELETION TIMESTAMP PREDICATES ///
 /////////////////////////////////////

pkg/controller/utils.go

@@ -5,6 +5,8 @@ import (
 	"encoding/base32"
 	"reflect"
 	"strings"
+
+	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 const (
@@ -35,3 +37,17 @@ func IsNil(i any) bool {
 	}
 	return false
 }
+
+// ObjectKey returns a client.ObjectKey for the given name and optionally namespace.
+// The first argument is the name of the object.
+// An optional second argument contains the namespace. All further arguments are ignored.
+func ObjectKey(name string, maybeNamespace ...string) client.ObjectKey {
+	namespace := ""
+	if len(maybeNamespace) > 0 {
+		namespace = maybeNamespace[0]
+	}
+	return client.ObjectKey{
+		Namespace: namespace,
+		Name:      name,
+	}
+}

pkg/testing/utils.go

@@ -71,20 +71,6 @@ func RequestFromStrings(name string, maybeNamespace ...string) reconcile.Request
 	}
 }
 
-// ObjectKey returns a client.ObjectKey for the given name and optionally namespace.
-// The first argument is the name of the object.
-// An optional second argument contains the namespace. All further arguments are ignored.
-func ObjectKey(name string, maybeNamespace ...string) client.ObjectKey {
-	namespace := ""
-	if len(maybeNamespace) > 0 {
-		namespace = maybeNamespace[0]
-	}
-	return client.ObjectKey{
-		Namespace: namespace,
-		Name:      name,
-	}
-}
-
 // LoadObject reads a file and unmarshals it into the given object.
 // obj must be a non-nil pointer.
 func LoadObject(obj any, paths ...string) error {