模拟boto3 S3客户端方法Python

Question

我试图从boto3 s3客户端对象中模拟一个单一的方法来抛出一个异常。但是我需要这个类的所有其他方法才能正常工作。

这样我就可以测试一个奇异的异常测试，当错误发生时执行upload_part_copy

第一次尝试

import boto3
from mock import patch

with patch('botocore.client.S3.upload_part_copy', side_effect=Exception('Error Uploading')) as mock:
    client = boto3.client('s3')
    # Should return actual result
    o = client.get_object(Bucket='my-bucket', Key='my-key')
    # Should return mocked exception
    e = client.upload_part_copy()

但是，这会产生以下错误：

ImportError: No module named S3

第二次尝试

在查看botocore.client.py源代码后，我发现它做了一些巧妙的事情，而且方法upload\u part\u copy不存在。我发现它似乎调用了BaseClient.\u make\u api\u call，所以我试图模仿它

import boto3
from mock import patch

with patch('botocore.client.BaseClient._make_api_call', side_effect=Exception('Error Uploading')) as mock:
    client = boto3.client('s3')
    # Should return actual result
    o = client.get_object(Bucket='my-bucket', Key='my-key')
    # Should return mocked exception
    e = client.upload_part_copy()

这会引发异常。。。但是在我想要避免的get_对象上。

关于如何只能在upload\u part\u copy方法上抛出异常，有什么想法吗？




Answer 1

下面是一个简单的python单元测试示例，可用于伪造client=boto3.client（'ec2'）api调用。。。

import boto3 

class MyAWSModule():
    def __init__(self):
        client = boto3.client('ec2')
        tags = client.describe_tags(DryRun=False)


class TestMyAWSModule(unittest.TestCase):
    @mock.patch("boto3.client.get_tags")
    @mock.patch("boto3.client")
    def test_open_file_with_existing_file(self, mock_boto_client, mock_describe_tags):
        mock_describe_tags.return_value = mock_get_tags_response
        my_aws_module = MyAWSModule()

        mock_boto_client.assert_call_once('ec2')
        mock_describe_tags.assert_call_once_with(DryRun=False)

mock_get_tags_response = {
    'Tags': [
        {
            'ResourceId': 'string',
            'ResourceType': 'customer-gateway',
            'Key': 'string',
            'Value': 'string'
        },
    ],
'NextToken': 'string'
}

希望这能有所帮助。

Answer 2

我一在这里发帖，就设法想出了一个解决办法。这里是希望它有帮助：）

import botocore
from botocore.exceptions import ClientError
from mock import patch
import boto3

orig = botocore.client.BaseClient._make_api_call

def mock_make_api_call(self, operation_name, kwarg):
    if operation_name == 'UploadPartCopy':
        parsed_response = {'Error': {'Code': '500', 'Message': 'Error Uploading'}}
        raise ClientError(parsed_response, operation_name)
    return orig(self, operation_name, kwarg)

with patch('botocore.client.BaseClient._make_api_call', new=mock_make_api_call):
    client = boto3.client('s3')
    # Should return actual result
    o = client.get_object(Bucket='my-bucket', Key='my-key')
    # Should return mocked exception
    e = client.upload_part_copy()

Jordan Philips还发布了一个使用botocore.stub.Stubber类的伟大解决方案。虽然是一个更干净的解决方案，但我无法嘲笑特定的操作。

Answer 3

Botocore有一个客户端存根，您可以将其用于以下目的：文档。

下面是一个输入错误的例子：

import boto3
from botocore.stub import Stubber

client = boto3.client('s3')
stubber = Stubber(client)
stubber.add_client_error('upload_part_copy')
stubber.activate()

# Will raise a ClientError
client.upload_part_copy()

下面是一个将正常响应放入的示例。此外，stubber现在可以在上下文中使用。需要注意的是，stuber将尽可能验证您提供的响应是否与服务实际返回的内容匹配。这并不完美，但它可以保护您避免插入完全无意义的响应。

import boto3
from botocore.stub import Stubber

client = boto3.client('s3')
stubber = Stubber(client)
list_buckets_response = {
    "Owner": {
        "DisplayName": "name",
        "ID": "EXAMPLE123"
    },
    "Buckets": [{
        "CreationDate": "2016-05-25T16:55:48.000Z",
        "Name": "foo"
    }]
}
expected_params = {}
stubber.add_response('list_buckets', list_buckets_response, expected_params)

with stubber:
    response = client.list_buckets()

assert response == list_buckets_response