add optional options argument to NewClusterCacheTracker function

add helper functions to set the options used by the tracker add SetLogger to provide a logger to the tracker add SetClientDisableCacheFor to disable caching of certain objects by the client
kubernetes-sigs · May 27, 2021 · afdcf89 · afdcf89
1 parent 0e1629b
commit afdcf89
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 28 deletions.
diff --git a/controllers/remote/cluster_cache.go b/controllers/remote/cluster_cache.go
@@ -51,21 +51,62 @@ const (
 
 // ClusterCacheTracker manages client caches for workload clusters.
 type ClusterCacheTracker struct {
-	log    logr.Logger
-	client client.Client
-	scheme *runtime.Scheme
+	log                   logr.Logger
+	clientDisableCacheFor []client.Object
+	client                client.Client
+	scheme                *runtime.Scheme
 
 	lock             sync.RWMutex
 	clusterAccessors map[client.ObjectKey]*clusterAccessor
 }
 
+type clusterCacheTrackerOptions struct {
+	log                   logr.Logger
+	clientDisableCacheFor []client.Object
+}
+
+type Option func(*clusterCacheTrackerOptions)
+
+func SetLogger(log logr.Logger) Option {
+	return func(o *clusterCacheTrackerOptions) {
+		o.log = log
+	}
+}
+
+func SetClientDisableCacheFor(objs []client.Object) Option {
+	return func(o *clusterCacheTrackerOptions) {
+		o.clientDisableCacheFor = objs
+	}
+}
+
+func setDefaultOptions(opts *clusterCacheTrackerOptions) {
+	if opts.log == nil {
+		opts.log = ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+	}
+
+	if len(opts.clientDisableCacheFor) == 0 {
+		opts.clientDisableCacheFor = []client.Object{
+			&corev1.ConfigMap{},
+			&corev1.Secret{},
+		}
+	}
+}
+
 // NewClusterCacheTracker creates a new ClusterCacheTracker.
-func NewClusterCacheTracker(log logr.Logger, manager ctrl.Manager) (*ClusterCacheTracker, error) {
+func NewClusterCacheTracker(manager ctrl.Manager, options ...Option) (*ClusterCacheTracker, error) {
+	ccto := &clusterCacheTrackerOptions{}
+	for _, o := range options {
+		o(ccto)
+	}
+
+	setDefaultOptions(ccto)
+
 	return &ClusterCacheTracker{
-		log:              log,
-		client:           manager.GetClient(),
-		scheme:           manager.GetScheme(),
-		clusterAccessors: make(map[client.ObjectKey]*clusterAccessor),
+		log:                   ccto.log,
+		clientDisableCacheFor: ccto.clientDisableCacheFor,
+		client:                manager.GetClient(),
+		scheme:                manager.GetScheme(),
+		clusterAccessors:      make(map[client.ObjectKey]*clusterAccessor),
 	}, nil
 }
 
@@ -164,12 +205,9 @@ func (t *ClusterCacheTracker) newClusterAccessor(ctx context.Context, cluster cl
 	})
 
 	delegatingClient, err := client.NewDelegatingClient(client.NewDelegatingClientInput{
-		CacheReader: cache,
-		Client:      c,
-		UncachedObjects: []client.Object{
-			&corev1.ConfigMap{},
-			&corev1.Secret{},
-		},
+		CacheReader:     cache,
+		Client:          c,
+		UncachedObjects: t.clientDisableCacheFor,
 	})
 	if err != nil {
 		return nil, err

diff --git a/controllers/remote/cluster_cache_healthcheck_test.go b/controllers/remote/cluster_cache_healthcheck_test.go
@@ -71,7 +71,7 @@ func TestClusterCacheHealthCheck(t *testing.T) {
 			k8sClient = mgr.GetClient()
 
 			t.Log("Setting up a ClusterCacheTracker")
-			cct, err = NewClusterCacheTracker(klogr.New(), mgr)
+			cct, err = NewClusterCacheTracker(mgr, SetLogger(klogr.New()))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			t.Log("Creating a namespace for the test")

diff --git a/controllers/remote/cluster_cache_reconciler_test.go b/controllers/remote/cluster_cache_reconciler_test.go
@@ -85,7 +85,7 @@ func TestClusterCacheReconciler(t *testing.T) {
 			g.Expect(err).NotTo(HaveOccurred())
 
 			t.Log("Setting up a ClusterCacheTracker")
-			cct, err = NewClusterCacheTracker(log.NullLogger{}, mgr)
+			cct, err = NewClusterCacheTracker(mgr, SetLogger(log.NullLogger{}))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			t.Log("Creating the ClusterCacheReconciler")

diff --git a/controllers/remote/cluster_cache_tracker_test.go b/controllers/remote/cluster_cache_tracker_test.go
@@ -86,7 +86,7 @@ func TestClusterCacheTracker(t *testing.T) {
 			k8sClient = mgr.GetClient()
 
 			t.Log("Setting up a ClusterCacheTracker")
-			cct, err = NewClusterCacheTracker(log.NullLogger{}, mgr)
+			cct, err = NewClusterCacheTracker(mgr, SetLogger(log.NullLogger{}))
 			g.Expect(err).NotTo(HaveOccurred())
 
 			t.Log("Creating a namespace for the test")

diff --git a/controllers/suite_test.go b/controllers/suite_test.go
@@ -52,8 +52,8 @@ func TestMain(m *testing.M) {
 	// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 	// requiring a connection to a remote cluster
 	tracker, err := remote.NewClusterCacheTracker(
-		log.Log,
 		testEnv.Manager,
+		remote.SetLogger(log.Log),
 	)
 	if err != nil {
 		panic(fmt.Sprintf("unable to create cluster cache tracker: %v", err))

diff --git a/controlplane/kubeadm/internal/cluster_test.go b/controlplane/kubeadm/internal/cluster_test.go
@@ -107,8 +107,8 @@ func TestGetWorkloadCluster(t *testing.T) {
 	badCrtEtcdSecret := etcdSecret.DeepCopy()
 	badCrtEtcdSecret.Data[secret.TLSCrtDataName] = []byte("bad cert")
 	tracker, err := remote.NewClusterCacheTracker(
-		log.Log,
 		testEnv.Manager,
+		remote.SetLogger(log.Log),
 	)
 	g.Expect(err).ToNot(HaveOccurred())
 

diff --git a/controlplane/kubeadm/main.go b/controlplane/kubeadm/main.go
@@ -185,10 +185,7 @@ func setupChecks(mgr ctrl.Manager) {
 func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 	// Set up a ClusterCacheTracker to provide to controllers
 	// requiring a connection to a remote cluster
-	tracker, err := remote.NewClusterCacheTracker(
-		ctrl.Log.WithName("remote").WithName("ClusterCacheTracker"),
-		mgr,
-	)
+	tracker, err := remote.NewClusterCacheTracker(mgr)
 	if err != nil {
 		setupLog.Error(err, "unable to create cluster cache tracker")
 		os.Exit(1)

diff --git a/exp/addons/controllers/suite_test.go b/exp/addons/controllers/suite_test.go
@@ -38,7 +38,7 @@ func TestMain(m *testing.M) {
 	fmt.Println("Creating new test environment")
 	testEnv = helpers.NewTestEnvironment()
 
-	trckr, err := remote.NewClusterCacheTracker(log.NullLogger{}, testEnv.Manager)
+	trckr, err := remote.NewClusterCacheTracker(testEnv.Manager, remote.SetLogger(log.NullLogger{}))
 	if err != nil {
 		panic(fmt.Sprintf("Failed to create new cluster cache tracker: %v", err))
 	}

diff --git a/main.go b/main.go
@@ -224,10 +224,7 @@ func setupChecks(mgr ctrl.Manager) {
 func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 	// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 	// requiring a connection to a remote cluster
-	tracker, err := remote.NewClusterCacheTracker(
-		ctrl.Log.WithName("remote").WithName("ClusterCacheTracker"),
-		mgr,
-	)
+	tracker, err := remote.NewClusterCacheTracker(mgr)
 	if err != nil {
 		setupLog.Error(err, "unable to create cluster cache tracker")
 		os.Exit(1)