Merge pull request #6318 from sbueringer/pr-drop-unused-logger

🌱 ClusterCacheTracker: drop unused Log field
kubernetes-sigs · Mar 28, 2022 · d61b7b9 · d61b7b9
2 parents 514e2aa + 4ce8299
commit d61b7b9
Show file tree

Hide file tree

Showing 9 changed files with 2 additions and 10 deletions.
diff --git a/controllers/remote/cluster_cache_reconciler.go b/controllers/remote/cluster_cache_reconciler.go
@@ -34,6 +34,7 @@ import (
 // ClusterCacheReconciler is responsible for stopping remote cluster caches when
 // the cluster for the remote cache is being deleted.
 type ClusterCacheReconciler struct {
+	// Deprecated: this field is unused and will be dropped in an upcoming release.
 	Log     logr.Logger
 	Client  client.Client
 	Tracker *ClusterCacheTracker
@@ -44,6 +45,7 @@ type ClusterCacheReconciler struct {
 
 func (r *ClusterCacheReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, options controller.Options) error {
 	err := ctrl.NewControllerManagedBy(mgr).
+		Named("remote/clustercache").
 		For(&clusterv1.Cluster{}).
 		WithOptions(options).
 		WithEventFilter(predicates.ResourceHasFilterLabel(ctrl.LoggerFrom(ctx), r.WatchFilterValue)).

diff --git a/controllers/remote/cluster_cache_reconciler_test.go b/controllers/remote/cluster_cache_reconciler_test.go
@@ -21,14 +21,12 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/go-logr/logr"
 	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
-	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
@@ -93,7 +91,6 @@ func TestClusterCacheReconciler(t *testing.T) {
 
 			t.Log("Creating the ClusterCacheReconciler")
 			r := &ClusterCacheReconciler{
-				Log:     logr.New(log.NullLogSink{}),
 				Client:  mgr.GetClient(),
 				Tracker: cct,
 			}

diff --git a/controlplane/kubeadm/main.go b/controlplane/kubeadm/main.go
@@ -238,7 +238,6 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 	}
 	if err := (&remote.ClusterCacheReconciler{
 		Client:           mgr.GetClient(),
-		Log:              ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 		Tracker:          tracker,
 		WatchFilterValue: watchFilterValue,
 	}).SetupWithManager(ctx, mgr, concurrency(kubeadmControlPlaneConcurrency)); err != nil {

diff --git a/internal/controllers/cluster/suite_test.go b/internal/controllers/cluster/suite_test.go
@@ -77,7 +77,6 @@ func TestMain(m *testing.M) {
 		}
 		if err := (&remote.ClusterCacheReconciler{
 			Client:  mgr.GetClient(),
-			Log:     ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 			Tracker: tracker,
 		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))

diff --git a/internal/controllers/machine/suite_test.go b/internal/controllers/machine/suite_test.go
@@ -80,7 +80,6 @@ func TestMain(m *testing.M) {
 		}
 		if err := (&remote.ClusterCacheReconciler{
 			Client:  mgr.GetClient(),
-			Log:     ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 			Tracker: tracker,
 		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))

diff --git a/internal/controllers/machinedeployment/suite_test.go b/internal/controllers/machinedeployment/suite_test.go
@@ -84,7 +84,6 @@ func TestMain(m *testing.M) {
 		}
 		if err := (&remote.ClusterCacheReconciler{
 			Client:  mgr.GetClient(),
-			Log:     ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 			Tracker: tracker,
 		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))

diff --git a/internal/controllers/machinehealthcheck/suite_test.go b/internal/controllers/machinehealthcheck/suite_test.go
@@ -80,7 +80,6 @@ func TestMain(m *testing.M) {
 		}
 		if err := (&remote.ClusterCacheReconciler{
 			Client:  mgr.GetClient(),
-			Log:     ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 			Tracker: tracker,
 		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))

diff --git a/internal/controllers/machineset/suite_test.go b/internal/controllers/machineset/suite_test.go
@@ -84,7 +84,6 @@ func TestMain(m *testing.M) {
 		}
 		if err := (&remote.ClusterCacheReconciler{
 			Client:  mgr.GetClient(),
-			Log:     ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 			Tracker: tracker,
 		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))

diff --git a/main.go b/main.go
@@ -283,7 +283,6 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 	}
 	if err := (&remote.ClusterCacheReconciler{
 		Client:           mgr.GetClient(),
-		Log:              ctrl.Log.WithName("remote").WithName("ClusterCacheReconciler"),
 		Tracker:          tracker,
 		WatchFilterValue: watchFilterValue,
 	}).SetupWithManager(ctx, mgr, concurrency(clusterConcurrency)); err != nil {