如何模拟 boto3 客户端对象/调用

Question

我正在尝试模拟一个特定的 boto3 函数。我的模块 Cleanup 导入 boto3。 Cleanup 还有一个类，“cleaner”。在初始化期间，cleaner 创建一个 ec2 客户端：

self.ec2_client = boto3.client('ec2')

我要模拟ec2客户端方法：desribe_tags()，python说的是：

<bound method EC2.describe_tags of <botocore.client.EC2 object at 0x7fd98660add0>>

我得到的最远的结果是在我的测试文件中导入 botocore 并尝试：

mock.patch(Cleaner.botocore.client.EC2.describe_tags)

失败：

AttributeError: 'module' object has no attribute 'EC2'

如何模拟这个方法？

清理看起来像：

import boto3
class cleaner(object):
    def __init__(self):
        self.ec2_client = boto3.client('ec2')

ec2_client 对象是具有 desribe_tags() 方法的对象。它是一个 botocore.client.EC2 对象，但我从不直接导入 botocore。

Answer 1

trying to mock a different method for the S3 client时我找到了解决方案

import botocore
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 == 'DescribeTags':
        # Your Operation here!
        print(kwarg)
    return orig(self, operation_name, kwarg)

with patch('botocore.client.BaseClient._make_api_call', new=mock_make_api_call):
    client = boto3.client('ec2')
    # Calling describe tags will perform your mocked operation e.g. print args
    e = client.describe_tags()

希望对你有帮助:)

Answer 2

你应该嘲笑你在哪里测试。因此，如果您正在测试您的 cleaner 类（我建议您在此处使用 PEP8 标准，并使其成为 Cleaner），那么您想要模拟您正在测试的位置。所以，你的补丁实际上应该是 something 沿线：

class SomeTest(Unittest.TestCase):
    @mock.patch('path.to.Cleaner.boto3.client', return_value=Mock())
    def setUp(self, boto_client_mock):
        self.cleaner_client = boto_client_mock.return_value

    def your_test(self):
        # call the method you are looking to test here

        # simple test to check that the method you are looking to mock was called
        self.cleaner_client.desribe_tags.assert_called_with()

我建议通读mocking documentation，其中有很多例子可以做你想做的事