如何在单元测试中正确修补boto3呼叫

时间:2019-07-16 21:31:31

标签: python unit-testing mocking boto3

我是Python单元测试的新手,我想模拟对boto3 3rd party库的调用。这是我的简化代码:

real_code.py:

import boto3

def temp_get_variable(var_name):
  return boto3.client('ssm').get_parameter(Name=var_name)['Parameter']['Value']

test_real_code.py:

import unittest
from datetime import datetime
from unittest.mock import patch

import real_code

class TestRealCode(unittest.TestCase):

    @patch('patching_config.boto3.client')
    def test_get_variable(self, mock_boto_client):

        response = {
            'Parameter': {
                'Name': 'MyTestParameterName',
                'Type': 'String',
                'Value': 'myValue',
                'Version': 123,
                'Selector': 'asdf',
                'SourceResult': 'asdf',
                'LastModifiedDate': datetime(2019, 7, 16),
                'ARN': 'asdf'
            }
        }

        mock_boto_client.get_variable.return_value = response

        result_value = real_code.get_variable("MyTestParameterName")

        self.assertEqual("myValue", result_value)

当我运行它时,测试失败

Expected :myValue
Actual   :<MagicMock name='client().get_parameter().__getitem__().__getitem__()' id='2040071816528'>

我在做什么错?我认为通过设置mock_boto_client.get_variable.return_value = response可以模拟呼叫并返回我的罐头响应。我不明白为什么我得到了MagicMock对象而不是我试图设置的返回值。我想设置测试,以便在使用特定参数调用get_parameter时,该模拟返回我在测试中指定的固定响应。

1 个答案:

答案 0 :(得分:0)

您的测试代码有两个问题。首先是当您的模拟对象mock_boto_client调用时,它将返回一个新的模拟对象。这意味着正在调用get_parameter()的对象与您尝试在其上设置返回值的对象不同。您可以使用以下命令将其返回:

mock_boto_client.return_value = mock_boto_client

您还可以使用其他模拟对象:

foo = MagicMock()
mock_boto_client.return_value = foo

第二个问题是您在模拟错误的方法调用。 mock_boto_client.get_variable.return_value应该是mock_boto_client.get_parameter.return_value。这是已更新且可以正常运行的测试:

import unittest
from datetime import datetime
from unittest.mock import patch

import real_code

class TestRealCode(unittest.TestCase):

    @patch('boto3.client')
    def test_get_variable(self, mock_boto_client):

        response = {
            'Parameter': {
                'Name': 'MyTestParameterName',
                'Type': 'String',
                'Value': 'myValue',
                'Version': 123,
                'Selector': 'asdf',
                'SourceResult': 'asdf',
                'LastModifiedDate': datetime(2019, 7, 16),
                'ARN': 'asdf'
            }
        }

        mock_boto_client.return_value = mock_boto_client
        mock_boto_client.get_parameter.return_value = response

        result_value = real_code.get_variable("MyTestParameterName")

        self.assertEqual("myValue", result_value)