extend testing library (uid injection)

Author: Diaphteiros

pkg/testing/complex_environment.go

@@ -9,10 +9,12 @@ import (
 
 	"github.com/onsi/gomega"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/util/uuid"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
 	"github.com/openmcp-project/controller-utils/pkg/logging"
@@ -121,6 +123,7 @@ type ComplexEnvironmentBuilder struct {
 	ClusterInitObjectPaths  map[string][]string
 	ClientCreationCallbacks map[string][]func(client.Client)
 	loggerIsSet             bool
+	InjectUIDs              map[string]bool
 }
 
 type ClusterEnvironment struct {
@@ -163,6 +166,7 @@ func NewComplexEnvironmentBuilder() *ComplexEnvironmentBuilder {
 		ClusterStatusObjects:    map[string][]client.Object{},
 		ClusterInitObjectPaths:  map[string][]string{},
 		ClientCreationCallbacks: map[string][]func(client.Client){},
+		InjectUIDs:              map[string]bool{},
 	}
 }
 
@@ -264,6 +268,16 @@ func (eb *ComplexEnvironmentBuilder) WithAfterClientCreationCallback(name string
 	return eb
 }
 
+// WithUIDs enables UID injection for the specified cluster.
+// All objects that are initially loaded or afterwards created via the client's 'Create' method will have a random UID injected, if they do not already have one.
+// Note that this function registers an interceptor function, which will be overwritten if 'WithFakeClientBuilderCall(..., "WithInterceptorFuncs", ...)' is also called.
+// This would lead to newly created objects not having a UID injected.
+// To avoid this, pass 'InjectUIDOnObjectCreation(...)' into the interceptor.Funcs' Create field. The argument allows to inject your own additional Create logic, if desired.
+func (eb *ComplexEnvironmentBuilder) WithUIDs(name string) *ComplexEnvironmentBuilder {
+	eb.InjectUIDs[name] = true
+	return eb
+}
+
 // WithFakeClientBuilderCall allows to inject method calls to fake.ClientBuilder when the fake clients are created during Build().
 // The fake clients are usually created using WithScheme(...).WithObjects(...).WithStatusSubresource(...).Build().
 // This function allows to inject additional method calls. It is only required for advanced use-cases.
@@ -284,6 +298,8 @@ func (eb *ComplexEnvironmentBuilder) WithFakeClientBuilderCall(name string, meth
 // Build constructs the environment from the builder.
 // Note that this function panics instead of throwing an error,
 // as it is intended to be used in tests, where all information is static anyway.
+//
+//nolint:gocyclo
 func (eb *ComplexEnvironmentBuilder) Build() *ComplexEnvironment {
 	res := eb.internal
 
@@ -335,6 +351,18 @@ func (eb *ComplexEnvironmentBuilder) Build() *ComplexEnvironment {
 			if len(eb.ClusterInitObjects) > 0 {
 				objs = append(objs, eb.ClusterInitObjects[name]...)
 			}
+			if eb.InjectUIDs[name] {
+				// ensure that objects have a uid
+				for _, obj := range objs {
+					if obj.GetUID() == "" {
+						// set a random UID if not already set
+						obj.SetUID(uuid.NewUUID())
+					}
+				}
+				fcb.WithInterceptorFuncs(interceptor.Funcs{
+					Create: InjectUIDOnObjectCreation(nil),
+				})
+			}
 			statusObjs := []client.Object{}
 			statusObjs = append(statusObjs, objs...)
 			statusObjs = append(statusObjs, eb.ClusterStatusObjects[name]...)
@@ -396,3 +424,19 @@ func (eb *ComplexEnvironmentBuilder) Build() *ComplexEnvironment {
 
 	return res
 }
+
+// InjectUIDOnObjectCreation returns an interceptor function for Create which injects a random UID into the object, if it does not already have one.
+// If additionalLogic is nil, the object is created regularly afterwards.
+// Otherwise, additionalLogic is called.
+// If you called 'WithUIDs(...)' on the ComplexEnvironmentBuilder AND 'WithFakeClientBuilderCall(..., "WithInterceptorFuncs", ...)', then you need to pass this function into the interceptor.Funcs' Create field, optionally adding your own creation logic via additionalLogic.
+func InjectUIDOnObjectCreation(additionalLogic func(ctx context.Context, client client.WithWatch, obj client.Object, opts ...client.CreateOption) error) func(ctx context.Context, client client.WithWatch, obj client.Object, opts ...client.CreateOption) error {
+	return func(ctx context.Context, client client.WithWatch, obj client.Object, opts ...client.CreateOption) error {
+		if obj.GetUID() == "" {
+			obj.SetUID(uuid.NewUUID())
+		}
+		if additionalLogic != nil {
+			return additionalLogic(ctx, client, obj, opts...)
+		}
+		return client.Create(ctx, obj, opts...)
+	}
+}

pkg/testing/environment.go

@@ -153,6 +153,16 @@ func (eb *EnvironmentBuilder) WithAfterClientCreationCallback(callback func(clie
 	return eb
 }
 
+// WithUIDs enables UID injection.
+// All objects that are initially loaded or afterwards created via the client's 'Create' method will have a random UID injected, if they do not already have one.
+// Note that this function registers an interceptor function, which will be overwritten if 'WithFakeClientBuilderCall("WithInterceptorFuncs", ...)' is also called.
+// This would lead to newly created objects not having a UID injected.
+// To avoid this, pass 'InjectUIDOnObjectCreation(...)' into the interceptor.Funcs' Create field. The argument allows to inject your own additional Create logic, if desired.
+func (eb *EnvironmentBuilder) WithUIDs() *EnvironmentBuilder {
+	eb.ComplexEnvironmentBuilder.WithUIDs(SimpleEnvironmentDefaultKey)
+	return eb
+}
+
 // WithFakeClientBuilderCall allows to inject method calls to fake.ClientBuilder when the fake client is created during Build().
 // The fake client is usually created using WithScheme(...).WithObjects(...).WithStatusSubresource(...).Build().
 // This function allows to inject additional method calls. It is only required for advanced use-cases.