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
|
#!/usr/bin/env python3
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0.
import argparse
import json
import boto3
import botocore
import sys
import os
import random
REGION = 'us-west-2'
REGION_EAST_1 = 'us-east-1'
s3 = boto3.resource('s3')
s3_client = boto3.client('s3', region_name=REGION)
s3_client_east1 = boto3.client('s3', region_name=REGION_EAST_1)
MB = 1024*1024
GB = 1024*1024*1024
parser = argparse.ArgumentParser()
parser.add_argument(
'action',
choices=['init', 'clean'],
help='Initialize or clean up the test buckets')
parser.add_argument(
'bucket_name',
nargs='?',
help='The bucket name base to use for the test buckets. If not specified, the $CRT_S3_TEST_BUCKET_NAME will be used, if set. \
Otherwise, a random name will be generated.')
parser.add_argument(
'--large_objects',
action='store_true',
help='enable helper to create pre-existing large objects.')
parser.add_argument(
'--create_public_bucket',
action='store_true',
help='Allow script to create a public bucket. If not specified, the script will not attempt to create a public bucket. \
Note: Some aws-c-s3 tests will fail without public bucket.')
args = parser.parse_args()
if args.bucket_name is not None:
BUCKET_NAME_BASE = args.bucket_name
elif "CRT_S3_TEST_BUCKET_NAME" in os.environ:
BUCKET_NAME_BASE = os.environ['CRT_S3_TEST_BUCKET_NAME']
else:
# Generate a random bucket name
BUCKET_NAME_BASE = 'aws-c-s3-test-bucket-' + str(random.random())[2:8]
PUBLIC_BUCKET_NAME = BUCKET_NAME_BASE + "-public"
# upload an object whose body is identical to an "async error" aka "200 error"
ASYNC_ERROR_XML = (
'<?xml version="1.0" encoding="UTF-8"?>\n'
'<Error>'
'<Code>InternalError</Code>'
'<Message>We encountered an internal error. Please try again.</Message>'
'<RequestId>656c76696e6727732072657175657374</RequestId>'
'<HostId>Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg==</HostId>'
'</Error>'
)
def create_bytes(size):
return bytes(size)
def put_pre_existing_objects(size_or_body, keyname, bucket=BUCKET_NAME_BASE,
sse=None, public_read=False, content_type=None,
client=s3_client):
print(f"s3://{bucket}/{keyname} - Uploading...")
if size_or_body == 0:
client.put_object(Bucket=bucket, Key=keyname)
return
if isinstance(size_or_body, int):
body = create_bytes(size_or_body)
else:
body = size_or_body
args = {'Bucket': bucket, 'Key': keyname, 'Body': body}
if sse == 'aes256':
args['ServerSideEncryption'] = 'AES256'
elif sse == 'aes256-c':
random_key = os.urandom(32)
args['SSECustomerKey'] = random_key
args['SSECustomerAlgorithm'] = 'AES256'
elif sse == 'kms':
args['ServerSideEncryption'] = 'aws:kms'
args['SSEKMSKeyId'] = 'alias/aws/s3'
if public_read:
args['ACL'] = 'public-read'
if content_type:
args['ContentType'] = content_type
try:
client.put_object(**args)
except botocore.exceptions.ClientError as e:
if public_read and e.response['Error']['Code'] == 'AccessDenied':
print("Check your account level S3 settings, public access may be blocked.")
raise
# Calls client.create_bucket(**kwargs)
# Suppresses "BucketAlreadyExists" errors
def create_bucket(client, **kwargs):
try:
print(f"s3://{kwargs['Bucket']} - Creating bucket...")
client.create_bucket(**kwargs)
except botocore.exceptions.ClientError as e:
if e.response['Error']['Code'] in ('BucketAlreadyOwnedByYou', 'BucketAlreadyExists'):
return
raise e
def create_bucket_with_lifecycle(availability_zone=None, client=s3_client, region=REGION):
if availability_zone is not None:
bucket_config = {
'Location': {
'Type': 'AvailabilityZone',
'Name': availability_zone
},
'Bucket': {
'Type': 'Directory',
'DataRedundancy': 'SingleAvailabilityZone'
}
}
bucket_name = BUCKET_NAME_BASE+f"--{availability_zone}--x-s3"
else:
bucket_config = {'LocationConstraint': region}
bucket_name = BUCKET_NAME_BASE
create_bucket(client,
Bucket=bucket_name,
CreateBucketConfiguration=bucket_config)
print(f"s3://{bucket_name} - Configuring bucket...")
if availability_zone is not None:
# https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-lifecycle.html#directory-bucket-lifecycle-differences
# S3 express requires a bucket policy to allow session-based access to perform lifecycle actions
account_id = boto3.client(
'sts').get_caller_identity().get('Account')
bucket_policy = {
"Version": "2008-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "lifecycle.s3.amazonaws.com"
},
"Action": "s3express:CreateSession",
"Condition": {
"StringEquals": {
"s3express:SessionMode": "ReadWrite"
}
},
"Resource": [
f"arn:aws:s3express:{region}:{account_id}:bucket/{bucket_name}"
]
}
]
}
client.put_bucket_policy(
Bucket=bucket_name, Policy=json.dumps(bucket_policy))
client.put_bucket_lifecycle_configuration(
Bucket=bucket_name,
LifecycleConfiguration={
'Rules': [
{
'ID': 'Abort all incomplete multipart uploads after 1 day',
'Status': 'Enabled',
'Filter': {'Prefix': ''}, # blank string means all
'AbortIncompleteMultipartUpload': {'DaysAfterInitiation': 1},
},
{
'ID': 'Objects under upload directory expire after 1 day',
'Status': 'Enabled',
'Filter': {'Prefix': 'upload/'},
'Expiration': {'Days': 1},
},
]})
put_pre_existing_objects(
10*MB, 'pre-existing-10MB', bucket=bucket_name, client=client)
if args.large_objects:
put_pre_existing_objects(
2*GB, 'pre-existing-2GB', bucket=bucket_name, client=client)
if availability_zone is None:
put_pre_existing_objects(
10*MB, 'pre-existing-10MB-aes256-c', sse='aes256-c', bucket=bucket_name)
put_pre_existing_objects(
10*MB, 'pre-existing-10MB-aes256', sse='aes256', bucket=bucket_name)
put_pre_existing_objects(
10*MB, 'pre-existing-10MB-kms', sse='kms', bucket=bucket_name)
put_pre_existing_objects(
1*MB, 'pre-existing-1MB', bucket=bucket_name)
put_pre_existing_objects(
1*MB, 'pre-existing-1MB-@', bucket=bucket_name)
put_pre_existing_objects(
0, 'pre-existing-empty', bucket=bucket_name)
put_pre_existing_objects(
ASYNC_ERROR_XML, 'pre-existing-async-error-xml', bucket=bucket_name, content_type='application/xml')
if args.large_objects:
put_pre_existing_objects(
256*MB, 'pre-existing-256MB', bucket=bucket_name)
put_pre_existing_objects(
256*MB, 'pre-existing-256MB-@', bucket=bucket_name)
put_pre_existing_objects(
2*GB, 'pre-existing-2GB-@', bucket=bucket_name)
else:
print("Skipping large objects, run with --large_objects if you need these.")
def create_bucket_with_public_object():
create_bucket(s3_client,
Bucket=PUBLIC_BUCKET_NAME,
CreateBucketConfiguration={'LocationConstraint': REGION},
ObjectOwnership='ObjectWriter'
)
print(f"s3://{PUBLIC_BUCKET_NAME} - Configuring bucket...")
s3_client.put_public_access_block(
Bucket=PUBLIC_BUCKET_NAME,
PublicAccessBlockConfiguration={
'BlockPublicAcls': False,
}
)
put_pre_existing_objects(
1*MB, 'pre-existing-1MB', bucket=PUBLIC_BUCKET_NAME, public_read=True)
def cleanup(bucket_name, availability_zone=None, client=s3_client):
if availability_zone is not None:
bucket_name = bucket_name+f"--{availability_zone}--x-s3"
print(f"s3://{bucket_name}/* - Listing objects...")
try:
objects = client.list_objects_v2(Bucket=bucket_name)["Contents"]
except botocore.exceptions.ClientError as e:
if e.response['Error']['Code'] == 'NoSuchBucket':
print(f"s3://{bucket_name} - Did not exist. Moving on...")
return
objects = list(map(lambda x: {"Key": x["Key"]}, objects))
if objects:
print(f"s3://{bucket_name}/* - Deleting {len(objects)} objects...")
client.delete_objects(Bucket=bucket_name, Delete={"Objects": objects})
print(f"s3://{bucket_name} - Deleting bucket...")
client.delete_bucket(Bucket=bucket_name)
if args.action == 'init':
create_bucket_with_lifecycle("use1-az4", s3_client_east1, "us-east-1")
create_bucket_with_lifecycle("usw2-az1")
create_bucket_with_lifecycle()
if args.create_public_bucket:
create_bucket_with_public_object()
else:
print("Skipping public bucket, run with --create_public_bucket if you need these.")
if os.environ.get('CRT_S3_TEST_BUCKET_NAME') != BUCKET_NAME_BASE:
print(
f"*** Set the environment variable $CRT_S3_TEST_BUCKET_NAME to {BUCKET_NAME_BASE} before running the tests ***")
elif args.action == 'clean':
if "CRT_S3_TEST_BUCKET_NAME" not in os.environ and args.bucket_name is None:
exit("Set the environment variable CRT_S3_TEST_BUCKET_NAME before clean up, or pass in bucket_name as argument.")
cleanup(BUCKET_NAME_BASE, "use1-az4", s3_client_east1)
cleanup(BUCKET_NAME_BASE, "usw2-az1")
cleanup(BUCKET_NAME_BASE)
cleanup(PUBLIC_BUCKET_NAME)
|