dd8b7656da
The boto library was last updated two years ago and has rusted to the point that it's unusable on py312 -- see https://github.com/boto/boto/issues/3951 We should transition all of these tests to boto3 equivalents, but this should help out in the meantime. Related-Bug: #1557260 Related-Bug: #2063367 Change-Id: If95f45371f352c6a2d16be1a3e1b64e265bccfb4
238 lines
9.1 KiB
Python
238 lines
9.1 KiB
Python
# Copyright (c) 2015 OpenStack Foundation
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import logging
|
|
import os
|
|
from six.moves.urllib.parse import urlparse
|
|
import test.functional as tf
|
|
import boto3
|
|
from botocore.exceptions import ClientError
|
|
try:
|
|
from boto.s3.connection import (
|
|
S3Connection,
|
|
OrdinaryCallingFormat,
|
|
S3ResponseError,
|
|
)
|
|
except ImportError:
|
|
S3Connection = OrdinaryCallingFormat = S3ResponseError = None
|
|
import six
|
|
import sys
|
|
import traceback
|
|
|
|
|
|
RETRY_COUNT = 3
|
|
|
|
|
|
if os.environ.get('SWIFT_TEST_QUIET_BOTO_LOGS'):
|
|
logging.getLogger('boto').setLevel(logging.INFO)
|
|
logging.getLogger('botocore').setLevel(logging.INFO)
|
|
logging.getLogger('boto3').setLevel(logging.INFO)
|
|
|
|
|
|
def setUpModule():
|
|
tf.setup_package()
|
|
|
|
|
|
def tearDownModule():
|
|
tf.teardown_package()
|
|
|
|
|
|
class Connection(object):
|
|
"""
|
|
Connection class used for S3 functional testing.
|
|
"""
|
|
def __init__(self, aws_access_key,
|
|
aws_secret_key,
|
|
user_id=None):
|
|
"""
|
|
Initialize method.
|
|
|
|
:param aws_access_key: a string of aws access key
|
|
:param aws_secret_key: a string of aws secret key
|
|
:param user_id: a string consists of TENANT and USER name used for
|
|
asserting Owner ID (not required S3Connection)
|
|
|
|
In default, Connection class will be initialized as tester user
|
|
behaves as:
|
|
user_test_tester = testing .admin
|
|
|
|
"""
|
|
self.aws_access_key = aws_access_key
|
|
self.aws_secret_key = aws_secret_key
|
|
self.user_id = user_id or aws_access_key
|
|
parsed = urlparse(tf.config['s3_storage_url'])
|
|
self.host = parsed.hostname
|
|
self.port = parsed.port
|
|
self.conn = \
|
|
S3Connection(aws_access_key, aws_secret_key,
|
|
is_secure=(parsed.scheme == 'https'),
|
|
host=self.host, port=self.port,
|
|
calling_format=OrdinaryCallingFormat())
|
|
self.conn.auth_region_name = tf.config.get('s3_region', 'us-east-1')
|
|
|
|
def reset(self):
|
|
"""
|
|
Reset all swift environment to keep clean. As a result by calling this
|
|
method, we can assume the backend swift keeps no containers and no
|
|
objects on this connection's account.
|
|
"""
|
|
exceptions = []
|
|
for i in range(RETRY_COUNT):
|
|
try:
|
|
buckets = self.conn.get_all_buckets()
|
|
if not buckets:
|
|
break
|
|
|
|
for bucket in buckets:
|
|
if six.PY2 and not isinstance(bucket.name, bytes):
|
|
bucket.name = bucket.name.encode('utf-8')
|
|
|
|
try:
|
|
for upload in bucket.list_multipart_uploads():
|
|
upload.cancel_upload()
|
|
|
|
for obj in bucket.list_versions():
|
|
if six.PY2:
|
|
if not isinstance(obj.name, bytes):
|
|
obj.name = obj.name.encode('utf-8')
|
|
if obj.version_id is not None and \
|
|
not isinstance(obj.version_id, bytes):
|
|
obj.version_id = \
|
|
obj.version_id.encode('utf-8')
|
|
bucket.delete_key(
|
|
obj.name, version_id=obj.version_id)
|
|
|
|
try:
|
|
self.conn.delete_bucket(bucket.name)
|
|
except ClientError as e:
|
|
err_code = e.response.get('Error', {}).get('Code')
|
|
if err_code != 'BucketNotEmpty':
|
|
raise
|
|
# else, listing consistency issue; try again
|
|
except S3ResponseError as e:
|
|
# 404 means NoSuchBucket, NoSuchKey, or NoSuchUpload
|
|
if e.status != 404:
|
|
raise
|
|
except Exception:
|
|
exceptions.append(''.join(
|
|
traceback.format_exception(*sys.exc_info())))
|
|
if exceptions:
|
|
exceptions.insert(0, 'Too many errors to continue:')
|
|
raise Exception('\n========\n'.join(exceptions))
|
|
|
|
def make_request(self, method, bucket='', obj='', headers=None, body=b'',
|
|
query=None):
|
|
"""
|
|
Wrapper method of S3Connection.make_request.
|
|
|
|
:param method: a string of HTTP request method
|
|
:param bucket: a string of bucket name
|
|
:param obj: a string of object name
|
|
:param headers: a dictionary of headers
|
|
:param body: a string of data binary sent to S3 as a request body
|
|
:param query: a string of HTTP query argument
|
|
|
|
:returns: a tuple of (int(status_code), headers dict, response body)
|
|
"""
|
|
response = \
|
|
self.conn.make_request(method, bucket=bucket, key=obj,
|
|
headers=headers, data=body,
|
|
query_args=query, sender=None,
|
|
override_num_retries=RETRY_COUNT,
|
|
retry_handler=None)
|
|
return (response.status,
|
|
{h.lower(): v for h, v in response.getheaders()},
|
|
response.read())
|
|
|
|
def generate_url_and_headers(self, method, bucket='', obj='',
|
|
expires_in=3600):
|
|
url = self.conn.generate_url(expires_in, method, bucket, obj)
|
|
if os.environ.get('S3_USE_SIGV4') == "True":
|
|
# V4 signatures are known-broken in boto, but we can work around it
|
|
if url.startswith('https://') and not tf.config[
|
|
's3_storage_url'].startswith('https://'):
|
|
url = 'http://' + url[8:]
|
|
if self.port is None:
|
|
return url, {}
|
|
else:
|
|
return url, {'Host': '%(host)s:%(port)d:%(port)d' % {
|
|
'host': self.host, 'port': self.port}}
|
|
return url, {}
|
|
|
|
|
|
def get_boto3_conn(aws_access_key, aws_secret_key):
|
|
endpoint_url = tf.config['s3_storage_url']
|
|
config = boto3.session.Config(s3={'addressing_style': 'path'})
|
|
return boto3.client(
|
|
's3', aws_access_key_id=aws_access_key,
|
|
aws_secret_access_key=aws_secret_key,
|
|
config=config, region_name=tf.config.get('s3_region', 'us-east-1'),
|
|
use_ssl=endpoint_url.startswith('https:'),
|
|
endpoint_url=endpoint_url)
|
|
|
|
|
|
def tear_down_s3(conn):
|
|
"""
|
|
Reset all swift environment to keep clean. As a result by calling this
|
|
method, we can assume the backend swift keeps no containers and no
|
|
objects on this connection's account.
|
|
"""
|
|
exceptions = []
|
|
for i in range(RETRY_COUNT):
|
|
try:
|
|
resp = conn.list_buckets()
|
|
buckets = [bucket['Name'] for bucket in resp.get('Buckets', [])]
|
|
for bucket in buckets:
|
|
try:
|
|
resp = conn.list_multipart_uploads(Bucket=bucket)
|
|
for upload in resp.get('Uploads', []):
|
|
conn.abort_multipart_upload(
|
|
Bucket=bucket,
|
|
Key=upload['Key'],
|
|
UploadId=upload['UploadId'])
|
|
|
|
resp = conn.list_objects(Bucket=bucket)
|
|
for obj in resp.get('Contents', []):
|
|
conn.delete_object(Bucket=bucket, Key=obj['Key'])
|
|
try:
|
|
conn.delete_bucket(Bucket=bucket)
|
|
except ClientError as e:
|
|
err_code = e.response.get('Error', {}).get('Code')
|
|
if err_code != 'BucketNotEmpty':
|
|
raise
|
|
# else, listing consistency issue; try again
|
|
except ClientError as e:
|
|
# 404 means NoSuchBucket, NoSuchKey, or NoSuchUpload
|
|
if e.response['ResponseMetadata']['HTTPStatusCode'] != 404:
|
|
raise
|
|
except Exception:
|
|
exceptions.append(''.join(
|
|
traceback.format_exception(*sys.exc_info())))
|
|
if exceptions:
|
|
exceptions.insert(0, 'Too many errors to continue:')
|
|
raise Exception('\n========\n'.join(exceptions))
|
|
|
|
|
|
# TODO: make sure where this function is used
|
|
def get_admin_connection():
|
|
"""
|
|
Return tester connection behaves as:
|
|
user_test_admin = admin .admin
|
|
"""
|
|
aws_access_key = tf.config['s3_access_key']
|
|
aws_secret_key = tf.config['s3_secret_key']
|
|
user_id = tf.config['s3_access_key']
|
|
return Connection(aws_access_key, aws_secret_key, user_id)
|