使用python模拟库与Django Rest Framework API交互的测试功能

时间:2018-09-13 12:08:06

标签: python django unit-testing mocking

我想对与使用Django Rest Framework构建的API交互的模块进行单元测试。为此,我正在使用python模拟库。由于我没有使用模拟程序来测试与API交互的经验,所以我遇到了问题。

将对象发送到API端点的函数是以下(简称):

def send_experiment_to_portal(experiment: Experiment):
    rest = RestApiClient()

    if not rest.active:
        return None

    # general params
    params = {"nes_id": str(experiment.id),
              "title": experiment.title,
              "description": experiment.description,
              "data_acquisition_done":
                  str(experiment.data_acquisition_is_concluded),
              "project_url": experiment.source_code_url,
              "ethics_committee_url": experiment.ethics_committee_project_url
              }

    action_keys = ['experiments', 'create']

    portal_experiment = rest.client.action(
        rest.schema, action_keys, params=params,
    )

return portal_experiment

RestAPIClient是向API进行身份验证的类:

class RestApiClient(object):
    client = None
    schema = None
    active = False

    def __init__(self):
        auth = coreapi.auth.BasicAuthentication(
            username=settings.PORTAL_API['USER'],
            password=settings.PORTAL_API['PASSWORD']
        )
        self.client = coreapi.Client(auth=auth)

        try:
            url = settings.PORTAL_API['URL'] + \
                  (
                      ':' + settings.PORTAL_API['PORT'] if
                      settings.PORTAL_API['PORT'] else ''
                  ) \
                  + '/api/schema/'

            self.schema = self.client.get(url)
            self.active = True
        except:
            self.active = False

RestApiClient类正在使用coreapi客户端模块连接到API。

因此,最后,我从测试开始,如果params中的rest.client.action参数具有API使用python模拟库预见的键/值。

我开始像这样编写初始测试:

class PortalAPITest(TestCase):

    @patch('experiment.portal.RestApiClient')
    def test_send_experiment_to_portal(self, mockRestApiClientClass):
        research_project = ObjectsFactory.create_research_project()
        experiment = ObjectsFactory.create_experiment(research_project)

        result = send_experiment_to_portal(experiment)

因此,当我调试测试时,查看send_experiment_to_portal函数rest.client.action.call_args的内部值为:

call(<MagicMock name='RestApiClient().schema' id='139922756141240'>, ['expreiments', 'create'], params={'description': 'Descricao do Experimento-Update', 'ethics_committee_url': None, 'project_url': None, 'title': 'Experimento-Update', 'nes_id': '37', 'data_acquisition_done': 'False'})

但是mockRestApiClientClass.client.action.call_argsNone。我怀疑我做错了。我应该模拟rest.client.action而不是RestApiClient类。

尝试使用result值也不起作用。

结果的值为

<MagicMock name='RestApiClient().client.action()' id='139821809672144'>

result.call_args也是None

但是该怎么做呢?如何在rest函数外部获取模拟send_experiment_to_portal实例?

1 个答案:

答案 0 :(得分:1)

奋斗了几天后,我找到了解决方法。

模拟sys.path返回类的模拟,而不是其值,即mainss()变量的值。我们从模拟对象中获得RestApiClient值,调用rest

因此,我们必须呼叫rest而不是return_value

这样做,我们可以访问mockRestApiClientClass.return_value内部调用的mockRestApiClientClass方法和属性,然后 rest具有与send_experiment_end_message_to_portal函数上下文中观察到的mockRestApiClientClass.return_value.client.action.call_args内容相同的内容。