1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
|
//go:build !integration
// +build !integration
package s3
import (
"errors"
"testing"
"github.com/minio/minio-go/v7/pkg/credentials"
"github.com/minio/minio-go/v7"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitlab-runner/common"
)
type minioClientInitializationTest struct {
errorOnInitialization bool
configurationFactory func() *common.CacheConfig
serverAddress string
expectedToUseIAM bool
expectedInsecure bool
}
func TestMinioClientInitialization(t *testing.T) {
tests := map[string]minioClientInitializationTest{
"error-on-initialization": {
errorOnInitialization: true,
configurationFactory: defaultCacheFactory,
},
"all-credentials-empty": {
configurationFactory: emptyCredentialsCacheFactory,
expectedToUseIAM: true,
},
"serverAddress-empty": {
configurationFactory: emptyServerAddressFactory,
expectedToUseIAM: true,
},
"accessKey-empty": {
configurationFactory: emptyAccessKeyFactory,
expectedToUseIAM: true,
},
"secretKey-empty": {
configurationFactory: emptySecretKeyFactory,
expectedToUseIAM: true,
},
"only-ServerAddress-defined": {
configurationFactory: onlyServerAddressFactory,
expectedToUseIAM: true,
serverAddress: "s3.customurl.com",
},
"only-AccessKey-defined": {
configurationFactory: onlyAccessKeyFactory,
expectedToUseIAM: true,
},
"only-SecretKey-defined": {
configurationFactory: onlySecretKeyFactory,
expectedToUseIAM: true,
},
"should-use-explicit-credentials": {
configurationFactory: defaultCacheFactory,
},
"should-use-explicit-credentials-with-insecure": {
configurationFactory: insecureCacheFactory,
expectedInsecure: true,
},
}
for testName, test := range tests {
t.Run(testName, func(t *testing.T) {
cleanupMinioMock := runOnFakeMinio(t, test)
defer cleanupMinioMock()
cleanupMinioCredentialsMock := runOnFakeMinioWithCredentials(t, test)
defer cleanupMinioCredentialsMock()
cacheConfig := test.configurationFactory()
client, err := newMinioClient(cacheConfig.S3)
if test.errorOnInitialization {
assert.Error(t, err, "test error")
return
}
require.NoError(t, err)
assert.NotNil(t, client)
})
}
}
func insecureCacheFactory() *common.CacheConfig {
cacheConfig := defaultCacheFactory()
cacheConfig.S3.Insecure = true
return cacheConfig
}
func emptyCredentialsCacheFactory() *common.CacheConfig {
cacheConfig := defaultCacheFactory()
cacheConfig.S3.ServerAddress = ""
cacheConfig.S3.AccessKey = ""
cacheConfig.S3.SecretKey = ""
return cacheConfig
}
func emptyServerAddressFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.AccessKey = "TOKEN"
cacheConfig.S3.SecretKey = "TOKEN"
return cacheConfig
}
func emptyAccessKeyFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.ServerAddress = "s3.amazonaws.com"
cacheConfig.S3.SecretKey = "TOKEN"
return cacheConfig
}
func emptySecretKeyFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.ServerAddress = "s3.amazonaws.com"
cacheConfig.S3.AccessKey = "TOKEN"
return cacheConfig
}
func onlyServerAddressFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.ServerAddress = "s3.customurl.com"
return cacheConfig
}
func onlyAccessKeyFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.AccessKey = "TOKEN"
return cacheConfig
}
func onlySecretKeyFactory() *common.CacheConfig {
cacheConfig := emptyCredentialsCacheFactory()
cacheConfig.S3.SecretKey = "TOKEN"
return cacheConfig
}
func runOnFakeMinio(t *testing.T, test minioClientInitializationTest) func() {
oldNewMinio := newMinio
newMinio = func(endpoint string, opts *minio.Options) (*minio.Client, error) {
if test.expectedToUseIAM {
t.Error("Should not use regular minio client initializer")
}
if test.errorOnInitialization {
return nil, errors.New("test error")
}
if test.expectedInsecure {
assert.False(t, opts.Secure)
} else {
assert.True(t, opts.Secure)
}
client, err := minio.New(endpoint, opts)
require.NoError(t, err)
return client, nil
}
return func() {
newMinio = oldNewMinio
}
}
func runOnFakeMinioWithCredentials(t *testing.T, test minioClientInitializationTest) func() {
oldNewMinioWithCredentials := newMinioWithIAM
newMinioWithIAM =
func(serverAddress, bucketLocation string) (*minio.Client, error) {
if !test.expectedToUseIAM {
t.Error("Should not use minio with IAM client initializator")
}
assert.Equal(t, "location", bucketLocation)
if test.serverAddress == "" {
assert.Equal(t, DefaultAWSS3Server, serverAddress)
} else {
assert.Equal(t, test.serverAddress, serverAddress)
}
if test.errorOnInitialization {
return nil, errors.New("test error")
}
client, err := minio.New(serverAddress, &minio.Options{
Creds: credentials.NewIAM(""),
Secure: true,
Transport: &bucketLocationTripper{
bucketLocation: bucketLocation,
},
})
require.NoError(t, err)
return client, nil
}
return func() {
newMinioWithIAM = oldNewMinioWithCredentials
}
}
|