forked from gruntwork-io/terratest
/
s3.go
398 lines (326 loc) · 12 KB
/
s3.go
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
package aws
import (
"bytes"
"strings"
"testing"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/s3"
"github.com/aws/aws-sdk-go/service/s3/s3manager"
"github.com/gruntwork-io/terratest/modules/logger"
"github.com/stretchr/testify/require"
)
// FindS3BucketWithTag finds the name of the S3 bucket in the given region with the given tag key=value.
func FindS3BucketWithTag(t *testing.T, awsRegion string, key string, value string) string {
bucket, err := FindS3BucketWithTagE(t, awsRegion, key, value)
require.NoError(t, err)
return bucket
}
// FindS3BucketWithTagE finds the name of the S3 bucket in the given region with the given tag key=value.
func FindS3BucketWithTagE(t *testing.T, awsRegion string, key string, value string) (string, error) {
s3Client, err := NewS3ClientE(t, awsRegion)
if err != nil {
return "", err
}
resp, err := s3Client.ListBuckets(&s3.ListBucketsInput{})
if err != nil {
return "", err
}
for _, bucket := range resp.Buckets {
tagResponse, err := s3Client.GetBucketTagging(&s3.GetBucketTaggingInput{Bucket: bucket.Name})
if err != nil {
if !strings.Contains(err.Error(), "AuthorizationHeaderMalformed") &&
!strings.Contains(err.Error(), "BucketRegionError") &&
!strings.Contains(err.Error(), "NoSuchTagSet") {
return "", err
}
}
for _, tag := range tagResponse.TagSet {
if *tag.Key == key && *tag.Value == value {
logger.Logf(t, "Found S3 bucket %s with tag %s=%s", *bucket.Name, key, value)
return *bucket.Name, nil
}
}
}
return "", nil
}
// GetS3ObjectContents fetches the contents of the object in the given bucket with the given key and return it as a string.
func GetS3ObjectContents(t *testing.T, awsRegion string, bucket string, key string) string {
contents, err := GetS3ObjectContentsE(t, awsRegion, bucket, key)
require.NoError(t, err)
return contents
}
// GetS3ObjectContentsE fetches the contents of the object in the given bucket with the given key and return it as a string.
func GetS3ObjectContentsE(t *testing.T, awsRegion string, bucket string, key string) (string, error) {
s3Client, err := NewS3ClientE(t, awsRegion)
if err != nil {
return "", err
}
res, err := s3Client.GetObject(&s3.GetObjectInput{
Bucket: &bucket,
Key: &key,
})
if err != nil {
return "", err
}
buf := new(bytes.Buffer)
_, err = buf.ReadFrom(res.Body)
if err != nil {
return "", err
}
contents := buf.String()
logger.Logf(t, "Read contents from s3://%s/%s", bucket, key)
return contents, nil
}
// CreateS3Bucket creates an S3 bucket in the given region with the given name. Note that S3 bucket names must be globally unique.
func CreateS3Bucket(t *testing.T, region string, name string) {
err := CreateS3BucketE(t, region, name)
require.NoError(t, err)
}
// CreateS3BucketE creates an S3 bucket in the given region with the given name. Note that S3 bucket names must be globally unique.
func CreateS3BucketE(t *testing.T, region string, name string) error {
logger.Logf(t, "Creating bucket %s in %s", name, region)
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
params := &s3.CreateBucketInput{
Bucket: aws.String(name),
}
_, err = s3Client.CreateBucket(params)
return err
}
// PutS3BucketPolicy applies an IAM resource policy to a given S3 bucket to create it's bucket policy
func PutS3BucketPolicy(t *testing.T, region string, bucketName string, policyJSONString string) {
err := PutS3BucketPolicyE(t, region, bucketName, policyJSONString)
require.NoError(t, err)
}
// PutS3BucketPolicyE applies an IAM resource policy to a given S3 bucket to create it's bucket policy
func PutS3BucketPolicyE(t *testing.T, region string, bucketName string, policyJSONString string) error {
logger.Logf(t, "Applying bucket policy for bucket %s in %s", bucketName, region)
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
input := &s3.PutBucketPolicyInput{
Bucket: aws.String(bucketName),
Policy: aws.String(policyJSONString),
}
_, err = s3Client.PutBucketPolicy(input)
return err
}
// PutS3BucketVersioning creates an S3 bucket versioning configuration in the given region against the given bucket name, WITHOUT requiring MFA to remove versioning.
func PutS3BucketVersioning(t *testing.T, region string, bucketName string) {
err := PutS3BucketVersioningE(t, region, bucketName)
require.NoError(t, err)
}
// PutS3BucketVersioningE creates an S3 bucket versioning configuration in the given region against the given bucket name, WITHOUT requiring MFA to remove versioning.
func PutS3BucketVersioningE(t *testing.T, region string, bucketName string) error {
logger.Logf(t, "Creating bucket versioning configuration for bucket %s in %s", bucketName, region)
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
input := &s3.PutBucketVersioningInput{
Bucket: aws.String(bucketName),
VersioningConfiguration: &s3.VersioningConfiguration{
MFADelete: aws.String("Disabled"),
Status: aws.String("Enabled"),
},
}
_, err = s3Client.PutBucketVersioning(input)
return err
}
// DeleteS3Bucket destroys the S3 bucket in the given region with the given name.
func DeleteS3Bucket(t *testing.T, region string, name string) {
err := DeleteS3BucketE(t, region, name)
require.NoError(t, err)
}
// DeleteS3BucketE destroys the S3 bucket in the given region with the given name.
func DeleteS3BucketE(t *testing.T, region string, name string) error {
logger.Logf(t, "Deleting bucket %s in %s", region, name)
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
params := &s3.DeleteBucketInput{
Bucket: aws.String(name),
}
_, err = s3Client.DeleteBucket(params)
return err
}
// EmptyS3BucketE removes the contents of an S3 bucket in the given region with the given name.
func EmptyS3Bucket(t *testing.T, region string, name string) {
err := EmptyS3BucketE(t, region, name)
require.NoError(t, err)
}
// EmptyS3BucketE removes the contents of an S3 bucket in the given region with the given name.
func EmptyS3BucketE(t *testing.T, region string, name string) error {
logger.Logf(t, "Emptying bucket %s in %s", name, region)
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
params := &s3.ListObjectVersionsInput{
Bucket: aws.String(name),
}
for {
// Requesting a batch of objects from s3 bucket
bucketObjects, err := s3Client.ListObjectVersions(params)
if err != nil {
return err
}
//Checks if the bucket is already empty
if len((*bucketObjects).Versions) == 0 {
logger.Logf(t, "Bucket %s is already empty", name)
return nil
}
//creating an array of pointers of ObjectIdentifier
objectsToDelete := make([]*s3.ObjectIdentifier, 0, 1000)
for _, object := range (*bucketObjects).Versions {
obj := s3.ObjectIdentifier{
Key: object.Key,
VersionId: object.VersionId,
}
objectsToDelete = append(objectsToDelete, &obj)
}
//Creating JSON payload for bulk delete
deleteArray := s3.Delete{Objects: objectsToDelete}
deleteParams := &s3.DeleteObjectsInput{
Bucket: aws.String(name),
Delete: &deleteArray,
}
//Running the Bulk delete job (limit 1000)
_, err = s3Client.DeleteObjects(deleteParams)
if err != nil {
return err
}
if *(*bucketObjects).IsTruncated { //if there are more objects in the bucket, IsTruncated = true
// params.Marker = (*deleteParams).Delete.Objects[len((*deleteParams).Delete.Objects)-1].Key
params.KeyMarker = bucketObjects.NextKeyMarker
logger.Logf(t, "Requesting next batch | %s", *(params.KeyMarker))
} else { //if all objects in the bucket have been cleaned up.
break
}
}
logger.Logf(t, "Bucket %s is now empty", name)
return err
}
// GetS3BucketVersioning fetches the given bucket's versioning configuration status and returns it as a string
func GetS3BucketVersioning(t *testing.T, awsRegion string, bucket string) string {
versioningStatus, err := GetS3BucketVersioningE(t, awsRegion, bucket)
require.NoError(t, err)
return versioningStatus
}
// GetS3BucketVersioningE fetches the given bucket's versioning configuration status and returns it as a string
func GetS3BucketVersioningE(t *testing.T, awsRegion string, bucket string) (string, error) {
s3Client, err := NewS3ClientE(t, awsRegion)
if err != nil {
return "", err
}
res, err := s3Client.GetBucketVersioning(&s3.GetBucketVersioningInput{
Bucket: &bucket,
})
if err != nil {
return "", err
}
return aws.StringValue(res.Status), nil
}
// GetS3BucketPolicy fetches the given bucket's resource policy and returns it as a string
func GetS3BucketPolicy(t *testing.T, awsRegion string, bucket string) string {
bucketPolicy, err := GetS3BucketPolicyE(t, awsRegion, bucket)
require.NoError(t, err)
return bucketPolicy
}
// GetS3BucketPolicyE fetches the given bucket's resource policy and returns it as a string
func GetS3BucketPolicyE(t *testing.T, awsRegion string, bucket string) (string, error) {
s3Client, err := NewS3ClientE(t, awsRegion)
if err != nil {
return "", err
}
res, err := s3Client.GetBucketPolicy(&s3.GetBucketPolicyInput{
Bucket: &bucket,
})
if err != nil {
return "", err
}
return aws.StringValue(res.Policy), nil
}
// AssertS3BucketExists checks if the given S3 bucket exists in the given region and fail the test if it does not.
func AssertS3BucketExists(t *testing.T, region string, name string) {
err := AssertS3BucketExistsE(t, region, name)
require.NoError(t, err)
}
// AssertS3BucketExistsE checks if the given S3 bucket exists in the given region and return an error if it does not.
func AssertS3BucketExistsE(t *testing.T, region string, name string) error {
s3Client, err := NewS3ClientE(t, region)
if err != nil {
return err
}
params := &s3.HeadBucketInput{
Bucket: aws.String(name),
}
_, err = s3Client.HeadBucket(params)
return err
}
// AssertS3BucketVersioningExists checks if the given S3 bucket has a versioning configuration enabled and returns an error if it does not.
func AssertS3BucketVersioningExists(t *testing.T, region string, bucketName string) {
err := AssertS3BucketVersioningExistsE(t, region, bucketName)
require.NoError(t, err)
}
// AssertS3BucketVersioningExistsE checks if the given S3 bucket has a versioning configuration enabled and returns an error if it does not.
func AssertS3BucketVersioningExistsE(t *testing.T, region string, bucketName string) error {
status, err := GetS3BucketVersioningE(t, region, bucketName)
if err != nil {
return err
}
if status == "Enabled" {
return nil
} else {
return NewBucketVersioningNotEnabledError(bucketName, region, status)
}
}
// AssertS3BucketPolicyExists checks if the given S3 bucket has a resource policy attached and returns an error if it does not
func AssertS3BucketPolicyExists(t *testing.T, region string, bucketName string) {
err := AssertS3BucketPolicyExistsE(t, region, bucketName)
require.NoError(t, err)
}
// AssertS3BucketPolicyExistsE checks if the given S3 bucket has a resource policy attached and returns an error if it does not
func AssertS3BucketPolicyExistsE(t *testing.T, region string, bucketName string) error {
policy, err := GetS3BucketPolicyE(t, region, bucketName)
if err != nil {
return err
}
if policy == "" {
return NewNoBucketPolicyError(bucketName, region, policy)
} else {
return nil
}
}
// NewS3Client creates an S3 client.
func NewS3Client(t *testing.T, region string) *s3.S3 {
client, err := NewS3ClientE(t, region)
require.NoError(t, err)
return client
}
// NewS3ClientE creates an S3 client.
func NewS3ClientE(t *testing.T, region string) (*s3.S3, error) {
sess, err := NewAuthenticatedSession(region)
if err != nil {
return nil, err
}
return s3.New(sess), nil
}
// NewS3Uploader creates an S3 Uploader.
func NewS3Uploader(t *testing.T, region string) *s3manager.Uploader {
uploader, err := NewS3UploaderE(t, region)
require.NoError(t, err)
return uploader
}
// NewS3UploaderE creates an S3 Uploader.
func NewS3UploaderE(t *testing.T, region string) (*s3manager.Uploader, error) {
sess, err := NewAuthenticatedSession(region)
if err != nil {
return nil, err
}
return s3manager.NewUploader(sess), nil
}