Merge pull request #3981 from vincepri/cr070

🌱 Update Controller Runtime to v0.7.0-alpha.8
kubernetes-sigs · Dec 3, 2020 · ca2cf1a · ca2cf1a
2 parents 8441b28 + b21d303
commit ca2cf1a
Show file tree

Hide file tree

Showing 29 changed files with 150 additions and 121 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -24,6 +24,8 @@ issues:
   exclude:
     - Using the variable on range scope `(tc)|(rt)|(tt)|(test)|(testcase)|(testCase)` in function literal
     - "G108: Profiling endpoint is automatically exposed on /debug/pprof"
+    - "fake.NewFakeClientWithScheme is deprecated: Please use NewClientBuilder instead."
+    - "fake.NewFakeClient is deprecated: Please use NewClientBuilder instead."
 run:
   timeout: 10m
   skip-files:

diff --git a/bootstrap/kubeadm/internal/locking/control_plane_init_mutex_test.go b/bootstrap/kubeadm/internal/locking/control_plane_init_mutex_test.go
@@ -65,27 +65,27 @@ func TestControlPlaneInitMutex_Lock(t *testing.T) {
 		{
 			name: "should successfully acquire lock if the config cannot be found",
 			client: &fakeClient{
-				Client:   fake.NewFakeClientWithScheme(scheme),
+				Client:   fake.NewClientBuilder().WithScheme(scheme).Build(),
 				getError: apierrors.NewNotFound(schema.GroupResource{Group: "", Resource: "configmaps"}, fmt.Sprintf("%s-controlplane", uid)),
 			},
 			shouldAcquire: true,
 		},
 		{
 			name: "should not acquire lock if already exits",
 			client: &fakeClient{
-				Client: fake.NewFakeClientWithScheme(scheme, &corev1.ConfigMap{
+				Client: fake.NewClientBuilder().WithScheme(scheme).WithObjects(&corev1.ConfigMap{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      configMapName(clusterName),
 						Namespace: clusterNamespace,
 					},
-				}),
+				}).Build(),
 			},
 			shouldAcquire: false,
 		},
 		{
 			name: "should not acquire lock if cannot create config map",
 			client: &fakeClient{
-				Client:      fake.NewFakeClientWithScheme(scheme),
+				Client:      fake.NewClientBuilder().WithScheme(scheme).Build(),
 				getError:    apierrors.NewNotFound(schema.GroupResource{Group: "", Resource: "configmaps"}, configMapName(clusterName)),
 				createError: errors.New("create error"),
 			},
@@ -94,7 +94,7 @@ func TestControlPlaneInitMutex_Lock(t *testing.T) {
 		{
 			name: "should not acquire lock if config map already exists while creating",
 			client: &fakeClient{
-				Client:      fake.NewFakeClientWithScheme(scheme),
+				Client:      fake.NewClientBuilder().WithScheme(scheme).Build(),
 				getError:    apierrors.NewNotFound(schema.GroupResource{Group: "", Resource: "configmaps"}, fmt.Sprintf("%s-controlplane", uid)),
 				createError: apierrors.NewAlreadyExists(schema.GroupResource{Group: "", Resource: "configmaps"}, fmt.Sprintf("%s-controlplane", uid)),
 			},
@@ -151,30 +151,30 @@ func TestControlPlaneInitMutex_UnLock(t *testing.T) {
 		{
 			name: "should release lock by deleting config map",
 			client: &fakeClient{
-				Client: fake.NewFakeClientWithScheme(scheme),
+				Client: fake.NewClientBuilder().WithScheme(scheme).Build(),
 			},
 			shouldRelease: true,
 		},
 		{
 			name: "should not release lock if cannot delete config map",
 			client: &fakeClient{
-				Client:      fake.NewFakeClientWithScheme(scheme, configMap),
+				Client:      fake.NewClientBuilder().WithScheme(scheme).WithObjects(configMap).Build(),
 				deleteError: errors.New("delete error"),
 			},
 			shouldRelease: false,
 		},
 		{
 			name: "should release lock if config map does not exist",
 			client: &fakeClient{
-				Client:   fake.NewFakeClientWithScheme(scheme),
+				Client:   fake.NewClientBuilder().WithScheme(scheme).Build(),
 				getError: apierrors.NewNotFound(schema.GroupResource{Group: "", Resource: "configmaps"}, fmt.Sprintf("%s-controlplane", uid)),
 			},
 			shouldRelease: true,
 		},
 		{
 			name: "should not release lock if error while getting config map",
 			client: &fakeClient{
-				Client:   fake.NewFakeClientWithScheme(scheme),
+				Client:   fake.NewClientBuilder().WithScheme(scheme).Build(),
 				getError: errors.New("get error"),
 			},
 			shouldRelease: false,
@@ -217,13 +217,13 @@ func TestInfoLines_Lock(t *testing.T) {
 	g.Expect(err).NotTo(HaveOccurred())
 
 	c := &fakeClient{
-		Client: fake.NewFakeClientWithScheme(scheme, &corev1.ConfigMap{
+		Client: fake.NewClientBuilder().WithScheme(scheme).WithObjects(&corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
 				Name:      configMapName(clusterName),
 				Namespace: clusterNamespace,
 			},
 			Data: map[string]string{semaphoreInformationKey: string(b)},
-		}),
+		}).Build(),
 	}
 
 	logtester := &logtests{

diff --git a/bootstrap/kubeadm/main.go b/bootstrap/kubeadm/main.go
@@ -36,7 +36,6 @@ import (
 	"sigs.k8s.io/cluster-api/cmd/version"
 	expv1 "sigs.k8s.io/cluster-api/exp/api/v1alpha4"
 	"sigs.k8s.io/cluster-api/feature"
-	"sigs.k8s.io/cluster-api/util"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	// +kubebuilder:scaffold:imports
@@ -133,7 +132,6 @@ func main() {
 		RetryPeriod:        &leaderElectionRetryPeriod,
 		Namespace:          watchNamespace,
 		SyncPeriod:         &syncPeriod,
-		NewClient:          util.ManagerDelegatingClientFunc,
 		Port:               webhookPort,
 	})
 	if err != nil {

diff --git a/bootstrap/util/configowner_test.go b/bootstrap/util/configowner_test.go
@@ -64,7 +64,7 @@ func TestGetConfigOwner(t *testing.T) {
 			},
 		}
 
-		c := fake.NewFakeClientWithScheme(scheme, myMachine)
+		c := fake.NewClientBuilder().WithScheme(scheme).WithObjects(myMachine).Build()
 		obj := &bootstrapv1.KubeadmConfig{
 			ObjectMeta: metav1.ObjectMeta{
 				OwnerReferences: []metav1.OwnerReference{
@@ -107,7 +107,7 @@ func TestGetConfigOwner(t *testing.T) {
 			},
 		}
 
-		c := fake.NewFakeClientWithScheme(scheme, myPool)
+		c := fake.NewClientBuilder().WithScheme(scheme).WithObjects(myPool).Build()
 		obj := &bootstrapv1.KubeadmConfig{
 			ObjectMeta: metav1.ObjectMeta{
 				OwnerReferences: []metav1.OwnerReference{
@@ -132,7 +132,7 @@ func TestGetConfigOwner(t *testing.T) {
 
 	t.Run("return an error when not found", func(t *testing.T) {
 		g := NewWithT(t)
-		c := fake.NewFakeClientWithScheme(scheme)
+		c := fake.NewClientBuilder().WithScheme(scheme).Build()
 		obj := &bootstrapv1.KubeadmConfig{
 			ObjectMeta: metav1.ObjectMeta{
 				OwnerReferences: []metav1.OwnerReference{
@@ -152,7 +152,7 @@ func TestGetConfigOwner(t *testing.T) {
 
 	t.Run("return nothing when there is no owner", func(t *testing.T) {
 		g := NewWithT(t)
-		c := fake.NewFakeClientWithScheme(scheme)
+		c := fake.NewClientBuilder().WithScheme(scheme).Build()
 		obj := &bootstrapv1.KubeadmConfig{
 			ObjectMeta: metav1.ObjectMeta{
 				OwnerReferences: []metav1.OwnerReference{},

diff --git a/cmd/clusterctl/internal/test/fake_proxy.go b/cmd/clusterctl/internal/test/fake_proxy.go
@@ -75,8 +75,7 @@ func (f *FakeProxy) NewClient() (client.Client, error) {
 	if f.cs != nil {
 		return f.cs, nil
 	}
-	f.cs = fake.NewFakeClientWithScheme(FakeScheme, f.objs...)
-
+	f.cs = fake.NewClientBuilder().WithScheme(FakeScheme).WithObjects(f.objs...).Build()
 	return f.cs, nil
 }
 

diff --git a/controllers/cluster_controller_phases_test.go b/controllers/cluster_controller_phases_test.go
@@ -131,9 +131,9 @@ func TestClusterReconcilePhases(t *testing.T) {
 				var c client.Client
 				if tt.infraRef != nil {
 					infraConfig := &unstructured.Unstructured{Object: tt.infraRef}
-					c = fake.NewFakeClientWithScheme(scheme.Scheme, external.TestGenericInfrastructureCRD.DeepCopy(), tt.cluster, infraConfig)
+					c = fake.NewClientBuilder().WithObjects(external.TestGenericInfrastructureCRD.DeepCopy(), tt.cluster, infraConfig).Build()
 				} else {
-					c = fake.NewFakeClientWithScheme(scheme.Scheme, external.TestGenericInfrastructureCRD.DeepCopy(), tt.cluster)
+					c = fake.NewClientBuilder().WithObjects(external.TestGenericInfrastructureCRD.DeepCopy(), tt.cluster).Build()
 				}
 				r := &ClusterReconciler{
 					Client: c,

diff --git a/controllers/machine_controller_noderef_test.go b/controllers/machine_controller_noderef_test.go
@@ -68,7 +68,7 @@ func TestGetNodeReference(t *testing.T) {
 		},
 	}
 
-	client := fake.NewFakeClientWithScheme(scheme.Scheme, nodeList...)
+	client := fake.NewClientBuilder().WithObjects(nodeList...).Build()
 
 	testCases := []struct {
 		name       string

diff --git a/controllers/machinedeployment_controller_test.go b/controllers/machinedeployment_controller_test.go
@@ -461,7 +461,7 @@ func TestMachineSetToDeployments(t *testing.T) {
 
 	g.Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
 	r := &MachineDeploymentReconciler{
-		Client:   fake.NewFakeClientWithScheme(scheme.Scheme, machineDeplopymentList...),
+		Client:   fake.NewClientBuilder().WithObjects(machineDeplopymentList...).Build(),
 		recorder: record.NewFakeRecorder(32),
 	}
 
@@ -527,7 +527,7 @@ func TestGetMachineDeploymentsForMachineSet(t *testing.T) {
 
 	g.Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
 	r := &MachineDeploymentReconciler{
-		Client:   fake.NewFakeClientWithScheme(scheme.Scheme, append(machineDeploymentList, &ms1, &ms2)...),
+		Client:   fake.NewClientBuilder().WithObjects(append(machineDeploymentList, &ms1, &ms2)...).Build(),
 		recorder: record.NewFakeRecorder(32),
 	}
 
@@ -687,7 +687,7 @@ func TestGetMachineSetsForDeployment(t *testing.T) {
 			g.Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
 
 			r := &MachineDeploymentReconciler{
-				Client:   fake.NewFakeClientWithScheme(scheme.Scheme, machineSetList...),
+				Client:   fake.NewClientBuilder().WithObjects(machineSetList...).Build(),
 				recorder: record.NewFakeRecorder(32),
 			}
 

diff --git a/controllers/machinehealthcheck_targets_test.go b/controllers/machinehealthcheck_targets_test.go
@@ -131,7 +131,7 @@ func TestGetTargetsFromMHC(t *testing.T) {
 			gs := NewGomegaWithT(t)
 
 			gs.Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
-			k8sClient := fake.NewFakeClientWithScheme(scheme.Scheme, tc.toCreate...)
+			k8sClient := fake.NewClientBuilder().WithObjects(tc.toCreate...).Build()
 
 			// Create a test reconciler
 			reconciler := &MachineHealthCheckReconciler{

diff --git a/controllers/machineset_controller_test.go b/controllers/machineset_controller_test.go
@@ -484,7 +484,7 @@ func TestMachineSetToMachines(t *testing.T) {
 	g.Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
 
 	r := &MachineSetReconciler{
-		Client: fake.NewFakeClientWithScheme(scheme.Scheme, append(machineSetList, &m, &m2, &m3)...),
+		Client: fake.NewClientBuilder().WithObjects(append(machineSetList, &m, &m2, &m3)...).Build(),
 	}
 
 	for _, tc := range testsCases {

diff --git a/controllers/remote/cluster_cache.go b/controllers/remote/cluster_cache.go
@@ -68,28 +68,6 @@ func NewClusterCacheTracker(log logr.Logger, manager ctrl.Manager) (*ClusterCach
 	}, nil
 }
 
-// NewTestClusterCacheTracker creates a new fake ClusterCacheTracker that can be used by unit tests with fake client.
-func NewTestClusterCacheTracker(log logr.Logger, cl client.Client, scheme *runtime.Scheme, objKey client.ObjectKey, watchObjects ...string) *ClusterCacheTracker {
-	testCacheTracker := &ClusterCacheTracker{
-		log:              log,
-		client:           cl,
-		scheme:           scheme,
-		clusterAccessors: make(map[client.ObjectKey]*clusterAccessor),
-	}
-
-	delegatingClient := client.NewDelegatingClient(client.NewDelegatingClientInput{
-		CacheReader: cl,
-		Client:      cl,
-	})
-	testCacheTracker.clusterAccessors[objKey] = &clusterAccessor{
-
-		cache:            nil,
-		delegatingClient: delegatingClient,
-		watches:          sets.NewString(watchObjects...),
-	}
-	return testCacheTracker
-}
-
 // GetClient returns a cached client for the given cluster.
 func (t *ClusterCacheTracker) GetClient(ctx context.Context, cluster client.ObjectKey) (client.Client, error) {
 	t.lock.Lock()
@@ -199,10 +177,13 @@ func (t *ClusterCacheTracker) newClusterAccessor(ctx context.Context, cluster cl
 		cfg:     config,
 	})
 
-	delegatingClient := client.NewDelegatingClient(client.NewDelegatingClientInput{
+	delegatingClient, err := client.NewDelegatingClient(client.NewDelegatingClientInput{
 		CacheReader: cache,
 		Client:      c,
 	})
+	if err != nil {
+		return nil, err
+	}
 
 	return &clusterAccessor{
 		cache:            cache,

diff --git a/controllers/remote/cluster_cache_fake.go b/controllers/remote/cluster_cache_fake.go
@@ -0,0 +1,50 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package remote
+
+import (
+	"github.com/go-logr/logr"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/util/sets"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+// NewTestClusterCacheTracker creates a new fake ClusterCacheTracker that can be used by unit tests with fake client.
+func NewTestClusterCacheTracker(log logr.Logger, cl client.Client, scheme *runtime.Scheme, objKey client.ObjectKey, watchObjects ...string) *ClusterCacheTracker {
+	testCacheTracker := &ClusterCacheTracker{
+		log:              log,
+		client:           cl,
+		scheme:           scheme,
+		clusterAccessors: make(map[client.ObjectKey]*clusterAccessor),
+	}
+
+	delegatingClient, err := client.NewDelegatingClient(client.NewDelegatingClientInput{
+		CacheReader: cl,
+		Client:      cl,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	testCacheTracker.clusterAccessors[objKey] = &clusterAccessor{
+
+		cache:            nil,
+		delegatingClient: delegatingClient,
+		watches:          sets.NewString(watchObjects...),
+	}
+	return testCacheTracker
+}
diff --git a/controlplane/kubeadm/internal/workload_cluster_coredns_test.go b/controlplane/kubeadm/internal/workload_cluster_coredns_test.go
@@ -27,7 +27,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/client-go/kubernetes/scheme"
 	cabpkv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha4"
 	kubeadmv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/types/v1beta1"
 	controlplanev1 "sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha4"
@@ -480,7 +479,7 @@ func TestUpdateCoreDNSCorefile(t *testing.T) {
 	t.Run("returns error if migrate failed to update corefile", func(t *testing.T) {
 		g := NewWithT(t)
 		objs := []client.Object{depl, cm}
-		fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, objs...)
+		fakeClient := fake.NewClientBuilder().WithObjects(objs...).Build()
 		fakeMigrator := &fakeMigrator{
 			migrateErr: errors.New("failed to migrate"),
 		}
@@ -512,7 +511,7 @@ func TestUpdateCoreDNSCorefile(t *testing.T) {
 		// Not including the deployment so as to fail early and verify that
 		// the intermediate config map update occurred
 		objs := []client.Object{cm}
-		fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, objs...)
+		fakeClient := fake.NewClientBuilder().WithObjects(objs...).Build()
 		fakeMigrator := &fakeMigrator{
 			migratedCorefile: "updated-core-file",
 		}
@@ -544,7 +543,7 @@ func TestUpdateCoreDNSCorefile(t *testing.T) {
 
 		g := NewWithT(t)
 		objs := []client.Object{depl, cm}
-		fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, objs...)
+		fakeClient := fake.NewClientBuilder().WithObjects(objs...).Build()
 		fakeMigrator := &fakeMigrator{
 			migratedCorefile: "updated-core-file",
 		}
@@ -747,7 +746,7 @@ func TestGetCoreDNSInfo(t *testing.T) {
 		for _, tt := range tests {
 			t.Run(tt.name, func(t *testing.T) {
 				g := NewWithT(t)
-				fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, tt.objs...)
+				fakeClient := fake.NewClientBuilder().WithObjects(tt.objs...).Build()
 				w := &Workload{
 					Client: fakeClient,
 				}
@@ -857,7 +856,7 @@ scheduler: {}`,
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)
-			fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, tt.objs...)
+			fakeClient := fake.NewClientBuilder().WithObjects(tt.objs...).Build()
 			w := &Workload{
 				Client: fakeClient,
 			}
@@ -961,7 +960,7 @@ func TestUpdateCoreDNSDeployment(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)
-			fakeClient := fake.NewFakeClientWithScheme(scheme.Scheme, tt.objs...)
+			fakeClient := fake.NewClientBuilder().WithObjects(tt.objs...).Build()
 
 			w := &Workload{
 				Client: fakeClient,