Add mocktest module (#255)

.golangci.yml

@@ -220,6 +220,11 @@ issues:
     - path: controller/suite_test.go
       linters:
         - gci
+    # Exclude goimports check for controller tests that import both mocktest and ginkgo/gomega as dot imports.
+    # goimports wants mocktest as a dot import in a separate group, but gci wants them in the same group.
+    - path: controller/.*_controller_test.go
+      linters:
+        - goimports
 
     # These are performance optimisations rather than style issues per se.
     # They warn when function arguments or range values copy a lot of memory

Makefile

@@ -141,7 +141,7 @@ docs:
 
 .PHONY: test
 test: generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(CACHE_BIN) -p path)" go test -race -timeout 60s `go list ./... | grep -v ./mock`  -coverprofile cover.out.tmp
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(CACHE_BIN) -p path)" go test -race -timeout 60s `go list ./... | grep -v ./mock$$`  -coverprofile cover.out.tmp
 	grep -v "zz_generated.deepcopy.go" cover.out.tmp > cover.out
 	rm cover.out.tmp
 

cloud/scope/client.go

@@ -59,12 +59,6 @@ type LinodeObjectStorageClient interface {
 	DeleteObjectStorageKey(ctx context.Context, keyID int) error
 }
 
-type LinodeObjectStorageClientBuilder func(apiKey string) (LinodeObjectStorageClient, error)
-
-func CreateLinodeObjectStorageClient(apiKey string) (LinodeObjectStorageClient, error) {
-	return CreateLinodeClient(apiKey)
-}
-
-type k8sClient interface {
+type K8sClient interface {
 	client.Client
 }

cloud/scope/cluster.go

@@ -30,7 +30,7 @@ import (
 
 // ClusterScopeParams defines the input parameters used to create a new Scope.
 type ClusterScopeParams struct {
-	Client        k8sClient
+	Client        K8sClient
 	Cluster       *clusterv1.Cluster
 	LinodeCluster *infrav1alpha1.LinodeCluster
 }
@@ -82,7 +82,7 @@ func NewClusterScope(ctx context.Context, apiKey string, params ClusterScopePara
 
 // ClusterScope defines the basic context for an actuator to operate upon.
 type ClusterScope struct {
-	client        k8sClient
+	client        K8sClient
 	PatchHelper   *patch.Helper
 	LinodeClient  LinodeNodeBalancerClient
 	Cluster       *clusterv1.Cluster

cloud/scope/cluster_test.go

@@ -102,7 +102,7 @@ func TestClusterScopeMethods(t *testing.T) {
 	tests := []struct {
 		name    string
 		fields  fields
-		expects func(mock *mock.Mockk8sClient)
+		expects func(mock *mock.MockK8sClient)
 	}{
 		{
 			name: "Success - finalizer should be added to the Linode Cluster object",
@@ -114,7 +114,7 @@ func TestClusterScopeMethods(t *testing.T) {
 					},
 				},
 			},
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Scheme().DoAndReturn(func() *runtime.Scheme {
 					s := runtime.NewScheme()
 					infrav1alpha1.AddToScheme(s)
@@ -134,7 +134,7 @@ func TestClusterScopeMethods(t *testing.T) {
 					},
 				},
 			},
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Scheme().DoAndReturn(func() *runtime.Scheme {
 					s := runtime.NewScheme()
 					infrav1alpha1.AddToScheme(s)
@@ -151,7 +151,7 @@ func TestClusterScopeMethods(t *testing.T) {
 			ctrl := gomock.NewController(t)
 			defer ctrl.Finish()
 
-			mockK8sClient := mock.NewMockk8sClient(ctrl)
+			mockK8sClient := mock.NewMockK8sClient(ctrl)
 
 			testcase.expects(mockK8sClient)
 
@@ -188,7 +188,7 @@ func TestNewClusterScope(t *testing.T) {
 		name          string
 		args          args
 		expectedError error
-		expects       func(mock *mock.Mockk8sClient)
+		expects       func(mock *mock.MockK8sClient)
 	}{
 		{
 			name: "Success - Pass in valid args and get a valid ClusterScope",
@@ -200,7 +200,7 @@ func TestNewClusterScope(t *testing.T) {
 				},
 			},
 			expectedError: nil,
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Scheme().DoAndReturn(func() *runtime.Scheme {
 					s := runtime.NewScheme()
 					infrav1alpha1.AddToScheme(s)
@@ -226,7 +226,7 @@ func TestNewClusterScope(t *testing.T) {
 				},
 			},
 			expectedError: nil,
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Scheme().DoAndReturn(func() *runtime.Scheme {
 					s := runtime.NewScheme()
 					infrav1alpha1.AddToScheme(s)
@@ -250,7 +250,7 @@ func TestNewClusterScope(t *testing.T) {
 				params: ClusterScopeParams{},
 			},
 			expectedError: fmt.Errorf("cluster is required when creating a ClusterScope"),
-			expects:       func(mock *mock.Mockk8sClient) {},
+			expects:       func(mock *mock.MockK8sClient) {},
 		},
 		{
 			name: "Error - patchHelper returns error. Checking error handle for when new patchHelper is invoked",
@@ -262,7 +262,7 @@ func TestNewClusterScope(t *testing.T) {
 				},
 			},
 			expectedError: fmt.Errorf("failed to init patch helper:"),
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Scheme().Return(runtime.NewScheme())
 			},
 		},
@@ -284,7 +284,7 @@ func TestNewClusterScope(t *testing.T) {
 				},
 			},
 			expectedError: fmt.Errorf("credentials from secret ref: get credentials secret test/example: failed to get secret"),
-			expects: func(mock *mock.Mockk8sClient) {
+			expects: func(mock *mock.MockK8sClient) {
 				mock.EXPECT().Get(gomock.Any(), gomock.Any(), gomock.Any()).Return(fmt.Errorf("failed to get secret"))
 			},
 		},
@@ -298,7 +298,7 @@ func TestNewClusterScope(t *testing.T) {
 				},
 			},
 			expectedError: fmt.Errorf("failed to create linode client: missing Linode API key"),
-			expects:       func(mock *mock.Mockk8sClient) {},
+			expects:       func(mock *mock.MockK8sClient) {},
 		},
 	}
 
@@ -310,7 +310,7 @@ func TestNewClusterScope(t *testing.T) {
 			ctrl := gomock.NewController(t)
 			defer ctrl.Finish()
 
-			mockK8sClient := mock.NewMockk8sClient(ctrl)
+			mockK8sClient := mock.NewMockK8sClient(ctrl)
 
 			testcase.expects(mockK8sClient)
 

cloud/scope/common.go

@@ -33,7 +33,7 @@ func CreateLinodeClient(apiKey string) (*linodego.Client, error) {
 	return &linodeClient, nil
 }
 
-func getCredentialDataFromRef(ctx context.Context, crClient k8sClient, credentialsRef corev1.SecretReference, defaultNamespace string) ([]byte, error) {
+func getCredentialDataFromRef(ctx context.Context, crClient K8sClient, credentialsRef corev1.SecretReference, defaultNamespace string) ([]byte, error) {
 	secretRef := client.ObjectKey{
 		Name:      credentialsRef.Name,
 		Namespace: credentialsRef.Namespace,

cloud/scope/common_test.go

@@ -164,7 +164,7 @@ func TestGetCredentialDataFromRef(t *testing.T) {
 			defer ctrl.Finish()
 
 			// Create an instance of the mock K8sClient
-			mockClient := mock.NewMockk8sClient(ctrl)
+			mockClient := mock.NewMockK8sClient(ctrl)
 
 			// Setup Expected behaviour
 			mockClient.EXPECT().Get(gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(testCase.args.funcBehavior)

cloud/scope/machine.go

@@ -15,15 +15,15 @@ import (
 )
 
 type MachineScopeParams struct {
-	Client        k8sClient
+	Client        K8sClient
 	Cluster       *clusterv1.Cluster
 	Machine       *clusterv1.Machine
 	LinodeCluster *infrav1alpha1.LinodeCluster
 	LinodeMachine *infrav1alpha1.LinodeMachine
 }
 
 type MachineScope struct {
-	Client        k8sClient
+	Client        K8sClient
 	PatchHelper   *patch.Helper
 	Cluster       *clusterv1.Cluster
 	Machine       *clusterv1.Machine
@@ -34,7 +34,7 @@ type MachineScope struct {
 
 func validateMachineScopeParams(params MachineScopeParams) error {
 	if params.Cluster == nil {
-		return errors.New("custer is required when creating a MachineScope")
+		return errors.New("cluster is required when creating a MachineScope")
 	}
 	if params.Machine == nil {
 		return errors.New("machine is required when creating a MachineScope")
@@ -77,7 +77,7 @@ func NewMachineScope(ctx context.Context, apiKey string, params MachineScopePara
 	if credentialRef != nil {
 		data, err := getCredentialDataFromRef(ctx, params.Client, *credentialRef, defaultNamespace)
 		if err != nil {
-			return nil, fmt.Errorf("credentials from cluster secret ref: %w", err)
+			return nil, fmt.Errorf("credentials from secret ref: %w", err)
 		}
 		apiKey = string(data)
 	}