Merge branch 'ajwalker/mockery-constructors' into 'main'

Use mockery constructors in tests

See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/5581

Merged-by: Arran Walker <[email protected]>
Approved-by: Hannes Hörl <[email protected]>

Author: saracen

cache/adapter_test.go

@@ -41,7 +41,7 @@ func makeTestFactory(test factorizeTestCase) Factory {
 }
 
 func TestCreateAdapter(t *testing.T) {
-	adapterMock := new(MockAdapter)
+	adapterMock := NewMockAdapter(t)
 
 	tests := map[string]factorizeTestCase{
 		"adapter doesn't exist": {
@@ -79,7 +79,7 @@ func TestCreateAdapter(t *testing.T) {
 			_ = factories.Register(
 				"additional-adapter",
 				func(config *common.CacheConfig, timeout time.Duration, objectName string) (Adapter, error) {
-					return new(MockAdapter), nil
+					return NewMockAdapter(t), nil
 				})
 
 			config := &common.CacheConfig{

cache/azure/adapter_test.go

@@ -69,10 +69,10 @@ func prepareMockedCredentialsResolverInitializer(tc adapterOperationInvalidConfi
 	}
 }
 
-func prepareMockedCredentialsResolverForInvalidConfig(adapter *azureAdapter, tc adapterOperationInvalidConfigTestCase) {
-	cr := &mockCredentialsResolver{}
+func prepareMockedCredentialsResolverForInvalidConfig(t *testing.T, adapter *azureAdapter, tc adapterOperationInvalidConfigTestCase) {
+	cr := newMockCredentialsResolver(t)
 
-	resolveCall := cr.On("Resolve")
+	resolveCall := cr.On("Resolve").Maybe()
 	if tc.credentialsResolverResolveError {
 		resolveCall.Return(fmt.Errorf("test error"))
 	} else {
@@ -86,7 +86,7 @@ func prepareMockedCredentialsResolverForInvalidConfig(adapter *azureAdapter, tc
 
 	// Always return an account key signer to avoid metadata lookups
 	signer, err := newAccountKeySigner(config.Azure)
-	cr.On("Signer").Return(signer, err)
+	cr.On("Signer").Return(signer, err).Maybe()
 
 	adapter.credentialsResolver = cr
 }
@@ -100,7 +100,7 @@ func testGoCloudURLWithInvalidConfig(
 	expectedErrorMessage string,
 ) {
 	t.Run(name, func(t *testing.T) {
-		prepareMockedCredentialsResolverForInvalidConfig(adapter, tc)
+		prepareMockedCredentialsResolverForInvalidConfig(t, adapter, tc)
 
 		u, err := operation(context.Background(), true)
 
@@ -126,7 +126,7 @@ func testUploadEnvWithInvalidConfig(
 	operation func(context.Context) (map[string]string, error),
 ) {
 	t.Run(name, func(t *testing.T) {
-		prepareMockedCredentialsResolverForInvalidConfig(adapter, tc)
+		prepareMockedCredentialsResolverForInvalidConfig(t, adapter, tc)
 
 		u, err := operation(context.Background())
 		assert.NoError(t, err)
@@ -223,21 +223,6 @@ type adapterOperationTestCase struct {
 	expectedError string
 }
 
-func prepareMockedCredentialsResolver(adapter *azureAdapter) func(t *testing.T) {
-	config := defaultAzureCache()
-	signer, err := newAccountKeySigner(config.Azure)
-
-	cr := &mockCredentialsResolver{}
-	cr.On("Resolve").Return(nil)
-	cr.On("Signer").Return(signer, err)
-
-	adapter.credentialsResolver = cr
-
-	return func(t *testing.T) {
-		cr.AssertExpectations(t)
-	}
-}
-
 func prepareMockedSignedURLGenerator(
 	t *testing.T,
 	tc adapterOperationTestCase,

cache/cache_test.go

@@ -27,12 +27,10 @@ type cacheOperationTest struct {
 	expectedOutput         []string
 }
 
-func prepareFakeCreateAdapter(t *testing.T, operationName string, tc cacheOperationTest) func() {
-	assertAdapterExpectations := func(t mock.TestingT) bool { return true }
-
+func prepareFakeCreateAdapter(t *testing.T, operationName string, tc cacheOperationTest) {
 	var cacheAdapter Adapter
 	if tc.adapterExists {
-		a := new(MockAdapter)
+		a := NewMockAdapter(t)
 
 		if tc.adapterURL.URL != nil {
 			if operationName == "GetGoCloudURL" {
@@ -41,8 +39,6 @@ func prepareFakeCreateAdapter(t *testing.T, operationName string, tc cacheOperat
 				a.On(operationName, mock.Anything).Return(tc.adapterURL)
 			}
 		}
-
-		assertAdapterExpectations = a.AssertExpectations
 		cacheAdapter = a
 	}
 
@@ -56,10 +52,9 @@ func prepareFakeCreateAdapter(t *testing.T, operationName string, tc cacheOperat
 		return cacheAdapter, cacheAdapterCreationError
 	}
 
-	return func() {
+	t.Cleanup(func() {
 		createAdapter = oldCreateAdapter
-		assertAdapterExpectations(t)
-	}
+	})
 }
 
 func prepareFakeBuild(tc cacheOperationTest) *common.Build {
@@ -95,8 +90,7 @@ func testCacheOperation(
 		ctx := context.Background()
 		hook := test.NewGlobal()
 
-		cleanupCreateAdapter := prepareFakeCreateAdapter(t, operationName, tc)
-		defer cleanupCreateAdapter()
+		prepareFakeCreateAdapter(t, operationName, tc)
 
 		build := prepareFakeBuild(tc)
 		generatedURL := operation(ctx, build, tc.key)

cache/credentials_adapter_test.go

@@ -38,7 +38,7 @@ func makeTestCredentialsFactory(test credentialsFactoryTestCase) CredentialsFact
 }
 
 func TestCreateCredentialsAdapter(t *testing.T) {
-	adapterMock := new(MockCredentialsAdapter)
+	adapterMock := NewMockCredentialsAdapter(t)
 
 	tests := map[string]credentialsFactoryTestCase{
 		"adapter doesn't exist": {
@@ -76,7 +76,7 @@ func TestCreateCredentialsAdapter(t *testing.T) {
 			_ = credentialsFactories.Register(
 				"additional-adapter",
 				func(config *common.CacheConfig) (CredentialsAdapter, error) {
-					return new(MockCredentialsAdapter), nil
+					return NewMockCredentialsAdapter(t), nil
 				})
 
 			config := &common.CacheConfig{

cache/gcs/adapter_test.go

@@ -77,7 +77,7 @@ type adapterOperationInvalidConfigTestCase struct {
 	expectedError string
 }
 
-func prepareMockedCredentialsResolverInitializer(tc adapterOperationInvalidConfigTestCase) func() {
+func prepareMockedCredentialsResolverInitializer(t *testing.T, tc adapterOperationInvalidConfigTestCase) {
 	oldCredentialsResolverInitializer := credentialsResolverInitializer
 	credentialsResolverInitializer = func(config *common.CacheGCSConfig) (*defaultCredentialsResolver, error) {
 		if tc.errorOnCredentialsResolverInitialization {
@@ -87,15 +87,15 @@ func prepareMockedCredentialsResolverInitializer(tc adapterOperationInvalidConfi
 		return newDefaultCredentialsResolver(config)
 	}
 
-	return func() {
+	t.Cleanup(func() {
 		credentialsResolverInitializer = oldCredentialsResolverInitializer
-	}
+	})
 }
 
-func prepareMockedCredentialsResolverForInvalidConfig(adapter *gcsAdapter, tc adapterOperationInvalidConfigTestCase) {
-	cr := &mockCredentialsResolver{}
+func prepareMockedCredentialsResolverForInvalidConfig(t *testing.T, adapter *gcsAdapter, tc adapterOperationInvalidConfigTestCase) {
+	cr := newMockCredentialsResolver(t)
 
-	resolveCall := cr.On("Resolve")
+	resolveCall := cr.On("Resolve").Maybe()
 	if tc.credentialsResolverResolveError {
 		resolveCall.Return(fmt.Errorf("test error"))
 	} else {
@@ -105,11 +105,11 @@ func prepareMockedCredentialsResolverForInvalidConfig(adapter *gcsAdapter, tc ad
 	cr.On("Credentials").Return(&common.CacheGCSCredentials{
 		AccessID:   tc.accessID,
 		PrivateKey: tc.privateKey,
-	})
+	}).Maybe()
 
 	cr.On("SignBytesFunc", mock.Anything).Return(func(payload []byte) ([]byte, error) {
 		return []byte("output"), nil
-	})
+	}).Maybe()
 
 	adapter.credentialsResolver = cr
 }
@@ -122,7 +122,7 @@ func testAdapterOperationWithInvalidConfig(
 	operation func(context.Context) cache.PresignedURL,
 ) {
 	t.Run(name, func(t *testing.T) {
-		prepareMockedCredentialsResolverForInvalidConfig(adapter, tc)
+		prepareMockedCredentialsResolverForInvalidConfig(t, adapter, tc)
 		hook := test.NewGlobal()
 
 		u := operation(context.Background())
@@ -167,8 +167,7 @@ func TestAdapterOperation_InvalidConfig(t *testing.T) {
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
-			cleanupCredentialsResolverInitializerMock := prepareMockedCredentialsResolverInitializer(tc)
-			defer cleanupCredentialsResolverInitializerMock()
+			prepareMockedCredentialsResolverInitializer(t, tc)
 
 			config := defaultGCSCache()
 			if tc.noGCSConfig {
@@ -217,8 +216,8 @@ func mockSignBytesFunc(_ context.Context) func([]byte) ([]byte, error) {
 	}
 }
 
-func prepareMockedCredentialsResolver(adapter *gcsAdapter, tc adapterOperationTestCase) func(t *testing.T) {
-	cr := &mockCredentialsResolver{}
+func prepareMockedCredentialsResolver(t *testing.T, adapter *gcsAdapter, tc adapterOperationTestCase) {
+	cr := newMockCredentialsResolver(t)
 	cr.On("Resolve").Return(nil)
 
 	pk := privateKey
@@ -232,10 +231,6 @@ func prepareMockedCredentialsResolver(adapter *gcsAdapter, tc adapterOperationTe
 	})
 
 	adapter.credentialsResolver = cr
-
-	return func(t *testing.T) {
-		cr.AssertExpectations(t)
-	}
 }
 
 func prepareMockedSignedURLGenerator(
@@ -271,9 +266,7 @@ func testAdapterOperation(
 	operation func(context.Context) cache.PresignedURL,
 ) {
 	t.Run(name, func(t *testing.T) {
-		cleanupCredentialsResolverMock := prepareMockedCredentialsResolver(adapter, tc)
-		defer cleanupCredentialsResolverMock(t)
-
+		prepareMockedCredentialsResolver(t, adapter, tc)
 		prepareMockedSignedURLGenerator(t, tc, expectedMethod, expectedContentType, adapter)
 		hook := test.NewGlobal()
 

cache/gcs/credentials_resolver_test.go

@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 	"testing"
 
 	"cloud.google.com/go/iam/credentials/apiv1/credentialspb"
@@ -31,43 +32,6 @@ type credentialsResolverTestCase struct {
 	expectedCredentials            *common.CacheGCSCredentials
 }
 
-func prepareStubbedCredentialsFile(t *testing.T, testCase credentialsResolverTestCase) func() {
-	cleanup := func() {}
-
-	if testCase.credentialsFileContent != nil {
-		file, err := os.CreateTemp("", "gcp-credentials-file")
-		require.NoError(t, err)
-
-		cleanup = func() {
-			os.Remove(file.Name())
-		}
-
-		testCase.config.CredentialsFile = file.Name()
-
-		switch {
-		case testCase.credentialsFileDoesNotExist:
-			os.Remove(file.Name())
-		case testCase.credentialsFileWithInvalidJSON:
-			_, err = file.Write([]byte("a"))
-			require.NoError(t, err)
-
-			err = file.Close()
-			require.NoError(t, err)
-		default:
-			data, err := json.Marshal(testCase.credentialsFileContent)
-			require.NoError(t, err)
-
-			_, err = file.Write(data)
-			require.NoError(t, err)
-
-			err = file.Close()
-			require.NoError(t, err)
-		}
-	}
-
-	return cleanup
-}
-
 func getCredentialsConfig(accessID string, privateKey string) *common.CacheGCSConfig {
 	return &common.CacheGCSConfig{
 		CacheGCSCredentials: common.CacheGCSCredentials{
@@ -155,11 +119,25 @@ func TestDefaultCredentialsResolver(t *testing.T) {
 
 	for name, testCase := range cases {
 		t.Run(name, func(t *testing.T) {
-			cleanupCredentialsFileMock := prepareStubbedCredentialsFile(t, testCase)
-			defer cleanupCredentialsFileMock()
+			if testCase.credentialsFileContent != nil {
+				pathname := filepath.Join(t.TempDir(), "gcp-credentials-file")
+
+				testCase.config.CredentialsFile = pathname
+
+				switch {
+				case testCase.credentialsFileDoesNotExist:
+					// no-op
+				case testCase.credentialsFileWithInvalidJSON:
+					require.NoError(t, os.WriteFile(pathname, []byte("a"), 0o600))
+				default:
+					data, err := json.Marshal(testCase.credentialsFileContent)
+					require.NoError(t, err)
+					require.NoError(t, os.WriteFile(pathname, data, 0o600))
+				}
+			}
 
-			mc := &MockMetadataClient{}
-			metadataCall := mc.On("Email", mock.Anything)
+			mc := NewMockMetadataClient(t)
+			metadataCall := mc.On("Email", mock.Anything).Maybe()
 			if testCase.metadataServerError {
 				metadataCall.Return("", fmt.Errorf("test error"))
 			} else {
@@ -211,8 +189,8 @@ func TestSignBytesOperation(t *testing.T) {
 
 			sbr := credentialspb.SignBlobResponse{SignedBlob: tc.output}
 
-			icc := &MockIamCredentialsClient{}
-			signBlobCall := icc.On("SignBlob", mock.Anything, mock.Anything)
+			icc := NewMockIamCredentialsClient(t)
+			signBlobCall := icc.On("SignBlob", mock.Anything, mock.Anything).Maybe()
 			cr, _ := newDefaultCredentialsResolver(config)
 			if tc.returnError == nil {
 				cr.credentialsClient = icc

cache/s3/adapter_test.go

@@ -61,8 +61,8 @@ type cacheOperationTest struct {
 	expectedUploadHeaders http.Header
 }
 
-func onFakeMinioURLGenerator(tc cacheOperationTest) func() {
-	client := new(mockMinioClient)
+func onFakeMinioURLGenerator(t *testing.T, tc cacheOperationTest) {
+	client := newMockMinioClient(t)
 
 	var err error
 	if tc.errorOnURLPresigning {
@@ -74,7 +74,7 @@ func onFakeMinioURLGenerator(tc cacheOperationTest) func() {
 			"PresignHeader", mock.Anything, mock.Anything, mock.Anything,
 			mock.Anything, mock.Anything, mock.Anything, mock.Anything,
 		).
-		Return(tc.presignedURL, err)
+		Return(tc.presignedURL, err).Maybe()
 
 	oldNewMinioURLGenerator := newMinioClient
 	newMinioClient = func(s3 *common.CacheS3Config) (minioClient, error) {
@@ -84,9 +84,9 @@ func onFakeMinioURLGenerator(tc cacheOperationTest) func() {
 		return client, nil
 	}
 
-	return func() {
+	t.Cleanup(func() {
 		newMinioClient = oldNewMinioURLGenerator
-	}
+	})
 }
 
 func testCacheOperation(
@@ -97,8 +97,7 @@ func testCacheOperation(
 	cacheConfig *common.CacheConfig,
 ) {
 	t.Run(operationName, func(t *testing.T) {
-		cleanupMinioURLGeneratorMock := onFakeMinioURLGenerator(tc)
-		defer cleanupMinioURLGeneratorMock()
+		onFakeMinioURLGenerator(t, tc)
 
 		adapter, err := New(cacheConfig, defaultTimeout, objectName)