From 20640d549e70639f68aa3a6878bdd790727014bd Mon Sep 17 00:00:00 2001 From: dxinyuan Date: Wed, 20 Sep 2023 20:17:05 +0800 Subject: [PATCH] Refactor context for vsphereclusteridentity_controller --- controllers/controllers_suite_test.go | 2 +- controllers/vsphereclusteridentity_controller.go | 12 ++++++------ .../vsphereclusteridentity_controller_test.go | 3 --- main.go | 2 +- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/controllers/controllers_suite_test.go b/controllers/controllers_suite_test.go index 71b8bb2b12..656d1d64ea 100644 --- a/controllers/controllers_suite_test.go +++ b/controllers/controllers_suite_test.go @@ -102,7 +102,7 @@ func setup() { if err := AddVMControllerToManager(testEnv.GetContext(), testEnv.Manager, tracker, controllerOpts); err != nil { panic(fmt.Sprintf("unable to setup VsphereVM controller: %v", err)) } - if err := AddVsphereClusterIdentityControllerToManager(testEnv.GetContext(), testEnv.Manager, controllerOpts); err != nil { + if err := AddVsphereClusterIdentityControllerToManager(ctx, testEnv.GetContext(), testEnv.Manager, controllerOpts); err != nil { panic(fmt.Sprintf("unable to setup VSphereClusterIdentity controller: %v", err)) } if err := AddVSphereDeploymentZoneControllerToManager(ctx, testEnv.GetContext(), testEnv.Manager, controllerOpts); err != nil { diff --git a/controllers/vsphereclusteridentity_controller.go b/controllers/vsphereclusteridentity_controller.go index 2fd7e049f3..573b4e5d8d 100644 --- a/controllers/vsphereclusteridentity_controller.go +++ b/controllers/vsphereclusteridentity_controller.go @@ -54,18 +54,18 @@ var ( // +kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=vsphereclusteridentities/status,verbs=get;update;patch // +kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch;create;patch;update;delete -func AddVsphereClusterIdentityControllerToManager(controllerCtx *capvcontext.ControllerManagerContext, mgr manager.Manager, options controller.Options) error { +func AddVsphereClusterIdentityControllerToManager(ctx context.Context, controllerManagerCtx *capvcontext.ControllerManagerContext, mgr manager.Manager, options controller.Options) error { var ( controllerNameShort = fmt.Sprintf("%s-controller", strings.ToLower(identityControlledTypeName)) - controllerNameLong = fmt.Sprintf("%s/%s/%s", controllerCtx.Namespace, controllerCtx.Name, controllerNameShort) + controllerNameLong = fmt.Sprintf("%s/%s/%s", controllerManagerCtx.Namespace, controllerManagerCtx.Name, controllerNameShort) ) // Build the controller context. controllerContext := &capvcontext.ControllerContext{ - ControllerManagerContext: controllerCtx, + ControllerManagerContext: controllerManagerCtx, Name: controllerNameShort, Recorder: record.New(mgr.GetEventRecorderFor(controllerNameLong)), - Logger: controllerCtx.Logger.WithName(controllerNameShort), + Logger: controllerManagerCtx.Logger.WithName(controllerNameShort), } reconciler := clusterIdentityReconciler{ControllerContext: controllerContext} @@ -73,7 +73,7 @@ func AddVsphereClusterIdentityControllerToManager(controllerCtx *capvcontext.Con return ctrl.NewControllerManagedBy(mgr). For(identityControlledType). WithOptions(options). - WithEventFilter(predicates.ResourceNotPausedAndHasFilterLabel(ctrl.LoggerFrom(controllerCtx), controllerCtx.WatchFilterValue)). + WithEventFilter(predicates.ResourceNotPausedAndHasFilterLabel(ctrl.LoggerFrom(ctx), controllerManagerCtx.WatchFilterValue)). Complete(reconciler) } @@ -85,7 +85,7 @@ func (r clusterIdentityReconciler) Reconcile(ctx context.Context, req reconcile. // TODO(gab-satchi) consider creating a context for the clusterIdentity // Get VSphereClusterIdentity identity := &infrav1.VSphereClusterIdentity{} - if err := r.Client.Get(r, req.NamespacedName, identity); err != nil { + if err := r.Client.Get(ctx, req.NamespacedName, identity); err != nil { if apierrors.IsNotFound(err) { r.Logger.V(4).Info("VSphereClusterIdentity not found, won't reconcile", "key", req.NamespacedName) return reconcile.Result{}, nil diff --git a/controllers/vsphereclusteridentity_controller_test.go b/controllers/vsphereclusteridentity_controller_test.go index 043559eaa1..820750316a 100644 --- a/controllers/vsphereclusteridentity_controller_test.go +++ b/controllers/vsphereclusteridentity_controller_test.go @@ -17,8 +17,6 @@ limitations under the License. package controllers import ( - "context" - . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" corev1 "k8s.io/api/core/v1" @@ -31,7 +29,6 @@ import ( ) var _ = Describe("VSphereClusterIdentity Reconciler", func() { - ctx := context.Background() controllerNamespace := testEnv.Manager.GetContext().Namespace Context("Reconcile Normal", func() { diff --git a/main.go b/main.go index 88552737ff..ceaefb9e35 100644 --- a/main.go +++ b/main.go @@ -363,7 +363,7 @@ func setupVAPIControllers(ctx context.Context, controllerCtx *capvcontext.Contro if err := controllers.AddVMControllerToManager(controllerCtx, mgr, tracker, concurrency(vSphereVMConcurrency)); err != nil { return err } - if err := controllers.AddVsphereClusterIdentityControllerToManager(controllerCtx, mgr, concurrency(vSphereClusterIdentityConcurrency)); err != nil { + if err := controllers.AddVsphereClusterIdentityControllerToManager(ctx, controllerCtx, mgr, concurrency(vSphereClusterIdentityConcurrency)); err != nil { return err }