Handle controller name validation in testing

Author: JoelSpeed

pkg/controller/machine/controller.go

@@ -121,11 +121,6 @@ func newReconciler(mgr manager.Manager, actuator Actuator, gate featuregate.Muta
 	return r
 }
 
-// add adds a new Controller to mgr with r as the reconcile.Reconciler
-func add(mgr manager.Manager, r reconcile.Reconciler, controllerName string) error {
-	return addWithOpts(mgr, controller.Options{Reconciler: r}, controllerName)
-}
-
 // add adds a new Controller to mgr with r as the reconcile.Reconciler
 func addWithOpts(mgr manager.Manager, opts controller.Options, controllerName string) error {
 	// Create a new controller

pkg/controller/machine/machine_controller_test.go

@@ -26,12 +26,14 @@ import (
 	"golang.org/x/net/context"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/ptr"
 
 	machinev1resourcebuilder "github.com/openshift/cluster-api-actuator-pkg/testutils/resourcebuilder/machine/v1beta1"
 	"github.com/openshift/cluster-control-plane-machine-set-operator/test/e2e/framework"
 	testutils "github.com/openshift/machine-api-operator/pkg/util/testing"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/metrics/server"
@@ -64,7 +66,10 @@ var _ = Describe("Machine Reconciler", func() {
 		act := newTestActuator()
 		reconciler := newReconciler(mgr, act, gate)
 
-		Expect(add(mgr, reconciler, "testing")).To(Succeed())
+		Expect(addWithOpts(mgr, controller.Options{
+			Reconciler:         reconciler,
+			SkipNameValidation: ptr.To(true),
+		}, "testing")).To(Succeed())
 
 		var mgrCtx context.Context
 		mgrCtx, mgrCtxCancel = context.WithCancel(ctx)

pkg/controller/machineset/controller.go

@@ -73,7 +73,7 @@ var (
 // The Manager will set fields on the Controller and Start it when the Manager is Started.
 func Add(mgr manager.Manager, opts manager.Options, gate featuregate.MutableFeatureGate) error {
 	r := newReconciler(mgr, gate)
-	return add(mgr, r, r.MachineToMachineSets)
+	return addWithOpts(mgr, controller.Options{Reconciler: r}, r.MachineToMachineSets)
 }
 
 // newReconciler returns a new reconcile.Reconciler.
@@ -86,9 +86,9 @@ func newReconciler(mgr manager.Manager, gate featuregate.MutableFeatureGate) *Re
 }
 
 // add adds a new Controller to mgr with r as the reconcile.Reconciler.
-func add(mgr manager.Manager, r reconcile.Reconciler, mapFn handler.TypedMapFunc[*machinev1.Machine, reconcile.Request]) error {
+func addWithOpts(mgr manager.Manager, opts controller.Options, mapFn handler.TypedMapFunc[*machinev1.Machine, reconcile.Request]) error {
 	// Create a new controller.
-	c, err := controller.New(controllerName, mgr, controller.Options{Reconciler: r})
+	c, err := controller.New(controllerName, mgr, opts)
 	if err != nil {
 		return err
 	}

pkg/controller/machineset/machineset_controller_test.go

@@ -30,7 +30,9 @@ import (
 	testutils "github.com/openshift/machine-api-operator/pkg/util/testing"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 
@@ -64,7 +66,10 @@ var _ = Describe("MachineSet Reconciler", func() {
 		By("Setting up a new reconciler")
 		reconciler := newReconciler(mgr, gate)
 
-		Expect(add(mgr, reconciler, reconciler.MachineToMachineSets)).To(Succeed())
+		Expect(addWithOpts(mgr, controller.Options{
+			Reconciler:         reconciler,
+			SkipNameValidation: ptr.To(true),
+		}, reconciler.MachineToMachineSets)).To(Succeed())
 
 		var mgrCtx context.Context
 		mgrCtx, mgrCtxCancel = context.WithCancel(ctx)

pkg/controller/vsphere/machineset/controller_test.go

@@ -28,6 +28,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/tools/record"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/log"
@@ -53,7 +54,9 @@ var _ = Describe("Reconciler", func() {
 			Client: mgr.GetClient(),
 			Log:    log.Log,
 		}
-		Expect(r.SetupWithManager(mgr, controller.Options{})).To(Succeed())
+		Expect(r.SetupWithManager(mgr, controller.Options{
+			SkipNameValidation: ptr.To(true),
+		})).To(Succeed())
 
 		fakeRecorder = record.NewFakeRecorder(1)
 		r.recorder = fakeRecorder