moto/tests/test_s3/test_s3_file_handles.py
2024-01-27 19:38:09 +00:00

335 lines
12 KiB
Python

import copy
import gc
import warnings
from functools import wraps
from unittest import SkipTest, TestCase
import boto3
from moto import mock_aws, settings
from moto.dynamodb.models import DynamoDBBackend
from moto.s3 import models as s3model
from moto.s3 import s3_backends
from moto.s3.responses import S3Response
from tests import DEFAULT_ACCOUNT_ID
TEST_BUCKET = "my-bucket"
TEST_BUCKET_VERSIONED = "versioned-bucket"
TEST_KEY = "my-key"
def verify_zero_warnings(func):
@wraps(func)
def wrapped(*args, **kwargs):
with warnings.catch_warnings(record=True) as warning_list:
warnings.simplefilter("always", ResourceWarning) # add filter
resp = func(*args, **kwargs)
# Get the TestClass reference, and reset any S3Backends that
# we've created as part of that class.
(class_ref,) = args
for obj in class_ref.__dict__:
if isinstance(obj, s3model.S3Backend):
obj.reset()
# Now collect garbage, which will throw any warnings if there
# are unclosed FileHandles.
gc.collect()
warning_types = [type(warn.message) for warn in warning_list]
assert ResourceWarning not in warning_types
return resp
return wrapped
class TestS3FileHandleClosures(TestCase):
"""Verifies filehandles are properly closed after specific actions.
Large Uploads are written to disk for performance reasons.
"""
def setUp(self) -> None:
if not settings.TEST_DECORATOR_MODE:
raise SkipTest("No point in testing ServerMode, we're not using boto3")
self.s3_client = s3_backends[DEFAULT_ACCOUNT_ID]["global"]
self.s3_client.create_bucket(TEST_BUCKET, "us-west-1")
self.s3_client.create_bucket(TEST_BUCKET_VERSIONED, "us-west-1")
self.s3_client.put_object(TEST_BUCKET, TEST_KEY, "x" * 10_000_000)
def tearDown(self) -> None:
for bucket_name in (
TEST_BUCKET,
TEST_BUCKET_VERSIONED,
):
keys = list(self.s3_client.get_bucket(bucket_name).keys.keys())
for key in keys:
self.s3_client.delete_object(bucket_name, key)
self.s3_client.delete_bucket(bucket_name)
@verify_zero_warnings
def test_upload_large_file(self):
# Verify that we can create an object, as done in the setUp-method
# Do not create any other objects, as it will taint the state that we're testing
pass
@verify_zero_warnings
def test_delete_large_file(self):
self.s3_client.delete_object(bucket_name=TEST_BUCKET, key_name=TEST_KEY)
@verify_zero_warnings
def test_overwriting_file(self):
self.s3_client.put_object(TEST_BUCKET, TEST_KEY, "b" * 10_000_000)
@verify_zero_warnings
def test_versioned_file(self):
self.s3_client.put_bucket_versioning(TEST_BUCKET, "Enabled")
self.s3_client.put_object(TEST_BUCKET, TEST_KEY, "b" * 10_000_000)
@verify_zero_warnings
def test_copy_object(self):
key = self.s3_client.get_object(TEST_BUCKET, TEST_KEY)
self.s3_client.copy_object(
src_key=key, dest_bucket_name=TEST_BUCKET, dest_key_name="key-2"
)
@verify_zero_warnings
def test_part_upload(self):
multipart_id = self.s3_client.create_multipart_upload(
bucket_name=TEST_BUCKET,
key_name="mp-key",
metadata={},
storage_type="STANDARD",
tags=[],
acl=None,
sse_encryption=None,
kms_key_id=None,
)
self.s3_client.upload_part(
bucket_name=TEST_BUCKET,
multipart_id=multipart_id,
part_id=1,
value="b" * 10_000_000,
)
@verify_zero_warnings
def test_overwriting_part_upload(self):
multipart_id = self.s3_client.create_multipart_upload(
bucket_name=TEST_BUCKET,
key_name="mp-key",
metadata={},
storage_type="STANDARD",
tags=[],
acl=None,
sse_encryption=None,
kms_key_id=None,
)
self.s3_client.upload_part(
bucket_name=TEST_BUCKET,
multipart_id=multipart_id,
part_id=1,
value="b" * 10_000_000,
)
self.s3_client.upload_part(
bucket_name=TEST_BUCKET,
multipart_id=multipart_id,
part_id=1,
value="c" * 10_000_000,
)
@verify_zero_warnings
def test_aborting_part_upload(self):
multipart_id = self.s3_client.create_multipart_upload(
bucket_name=TEST_BUCKET,
key_name="mp-key",
metadata={},
storage_type="STANDARD",
tags=[],
acl=None,
sse_encryption=None,
kms_key_id=None,
)
self.s3_client.upload_part(
bucket_name=TEST_BUCKET,
multipart_id=multipart_id,
part_id=1,
value="b" * 10_000_000,
)
self.s3_client.abort_multipart_upload(
bucket_name=TEST_BUCKET, multipart_id=multipart_id
)
@verify_zero_warnings
def test_completing_part_upload(self):
multipart_id = self.s3_client.create_multipart_upload(
bucket_name=TEST_BUCKET,
key_name="mp-key",
metadata={},
storage_type="STANDARD",
tags=[],
acl=None,
sse_encryption=None,
kms_key_id=None,
)
etag = self.s3_client.upload_part(
bucket_name=TEST_BUCKET,
multipart_id=multipart_id,
part_id=1,
value="b" * 10_000_000,
).etag
mp_body = (
"<CompleteMultipartUpload "
'xmlns="http://s3.amazonaws.com/doc/2006-03-01/">'
f"<Part><ETag>{etag}</ETag><PartNumber>1</PartNumber></Part>"
"</CompleteMultipartUpload>"
)
body = S3Response()._complete_multipart_body(mp_body)
self.s3_client.complete_multipart_upload(
bucket_name=TEST_BUCKET, multipart_id=multipart_id, body=body
)
@verify_zero_warnings
def test_single_versioned_upload(self):
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
@verify_zero_warnings
def test_overwrite_versioned_upload(self):
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
@verify_zero_warnings
def test_multiple_versions_upload(self):
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "y" * 10_000_000)
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "z" * 10_000_000)
@verify_zero_warnings
def test_delete_versioned_upload(self):
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
self.s3_client.delete_object(bucket_name=TEST_BUCKET, key_name=TEST_KEY)
@verify_zero_warnings
def test_delete_specific_version(self):
self.s3_client.put_object(TEST_BUCKET_VERSIONED, TEST_KEY, "x" * 10_000_000)
key = self.s3_client.put_object(
TEST_BUCKET_VERSIONED, TEST_KEY, "y" * 10_000_000
)
self.s3_client.delete_object(
bucket_name=TEST_BUCKET, key_name=TEST_KEY, version_id=key._version_id
)
@verify_zero_warnings
def test_reset_other_backend(self):
dbase = DynamoDBBackend("us-west-1", "1234")
# This used to empty the entire list of `model_instances`, which
# can contain FakeKey-references.
# Verify that we can reset an unrelated backend, without throwing
# away FakeKey-references that still need to be disposed.
dbase.reset()
class TestS3FileHandleClosuresUsingMocks(TestCase):
def setUp(self) -> None:
if not settings.TEST_DECORATOR_MODE:
raise SkipTest("No point in testing ServerMode, we're not using boto3")
self.s3_client = boto3.client("s3", "us-east-1")
@verify_zero_warnings
@mock_aws
def test_use_decorator(self):
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_object(Bucket="foo", Key="bar", Body="stuff")
@verify_zero_warnings
@mock_aws
def test_use_decorator_and_context_mngt(self):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_object(Bucket="foo", Key="bar", Body="stuff")
@verify_zero_warnings
def test_use_multiple_context_managers(self):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_object(Bucket="foo", Key="bar", Body="stuff")
with mock_aws():
pass
@verify_zero_warnings
def test_create_multipart(self):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_object(Bucket="foo", Key="k1", Body="stuff")
mpart = self.s3_client.create_multipart_upload(Bucket="foo", Key="key2")
self.s3_client.upload_part(
Body=b"hello",
PartNumber=1,
Bucket="foo",
Key="key2",
UploadId=mpart["UploadId"],
)
with mock_aws():
pass
@verify_zero_warnings
def test_overwrite_file(self):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_object(Bucket="foo", Key="k1", Body="stuff")
self.s3_client.put_object(Bucket="foo", Key="k1", Body="b" * 10_000_000)
with mock_aws():
pass
@verify_zero_warnings
def test_delete_object_with_version(self):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_bucket_versioning(
Bucket="foo",
VersioningConfiguration={"Status": "Enabled", "MFADelete": "Disabled"},
)
version = self.s3_client.put_object(Bucket="foo", Key="b", Body="s")[
"VersionId"
]
self.s3_client.delete_object(Bucket="foo", Key="b", VersionId=version)
@verify_zero_warnings
def test_update_versioned_object__while_looping(self):
for _ in (1, 2):
with mock_aws():
self.s3_client.create_bucket(Bucket="foo")
self.s3_client.put_bucket_versioning(
Bucket="foo",
VersioningConfiguration={
"Status": "Enabled",
"MFADelete": "Disabled",
},
)
self.s3_client.put_object(Bucket="foo", Key="bar", Body="stuff")
self.s3_client.put_object(Bucket="foo", Key="bar", Body="stuff2")
def test_verify_key_can_be_copied_after_disposing():
# https://github.com/getmoto/moto/issues/5588
# Multithreaded bug where:
# - User: calls list_object_versions
# - Moto creates a list of all keys
# - User: deletes a key
# - Moto iterates over the previously created list, that contains i
# a now-deleted key, and creates a copy of it
#
# This test verifies the copy-operation succeeds, it will just not
# have any data.
key = s3model.FakeKey(
name="test", bucket_name="bucket", value="sth", account_id=DEFAULT_ACCOUNT_ID
)
assert not key._value_buffer.closed
key.dispose()
assert key._value_buffer.closed
copied_key = copy.copy(key)
assert copied_key.value == b""