怎样在执行Django单元测试时禁用第三方API?

2024-03-28 22:02:40 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在尝试针对Django中运行针对第三方API的操作的代码构建一些单元测试。具体来说,我正在与MailChimp同步一些用户数据,并使用一个实现MailChimp API的库。在

我有一个自定义类MailChimpAPI,它基本上是我所使用的Python库的一个精简包装器。以下是代码的一些相关部分:

class MailChimpAPI(object):
    """
    A wrapper for implementing business logic and exception handling around
    the PyChimp API
    """
    ...

    def __init__(self, api_key, primary_list_id, merge_keys, use_secure=True, timeout=None):
        ...

        # setup api
        self.api_key = api_key
        self.api = PyChimp(self.api_key)

        ...

    ...


    def _call(self, method_name, args=[], kwargs={}):
        """Calls the PyChimp API directly"""
        result = getattr(self.api, method_name)(*args, **kwargs)
        if self.api.errorCode:
            self._raise_mailchimp_exception()
        else:
            return result

    ...

我删去了(…)实现业务逻辑等的大部分代码,但这里突出的一点是,我将api属性设置为__init__()中PyChimp(第三方库)的一个实例,并且对该库的所有实际调用都是在_call()函数中进行的。在

我对单元测试有点陌生,所以我很难找到解决这个问题的最佳方法。我的一个想法是在类之外实例化PyChimp库并将其传递给构造函数。另一个想法是在测试中,我可以模拟_call方法,这样它就不会命中实际的库。在

我面临的第一个问题是,显然,我不想针对实际的API执行任何测试代码。所以我试图找出最好的方法来“存根”或“模拟”那个API,这样在测试期间对它的调用不会真正执行。理想情况下,我希望在Django测试套件中运行所有测试时都能看到这个模拟API。例如,我正在探索在通过post_save信号创建用户帐户时,将用户同步到MailChimp的可能性。出于这个原因,我显然不希望在Django身份验证应用程序中运行的测试触发实际的API。在

我希望Django有一些全局设置/拆卸钩子或信号,我可以处理,但似乎没有任何东西。在

在测试过程中,有人对如何用一个假装的API干净地替换一个“live”API有什么建议吗?还是我完全错了?在

我很有信心我能找到一个解决方案,但是如果有人愿意分享一些关于解决这类问题的“最佳”方法的智慧,那就太好了。在


Tags: thedjango方法key代码用户selfapi
2条回答

在Python中“模拟”函数调用的最好方法是使用mock库。另外,如果您使用nose作为单元测试框架,那么一个值得考虑的插件是nose-blockage,它可以确保如果您的测试没有正确地模拟出所有内容,就不会有API调用通过。在

最好的方法可能如您所建议的那样,在外部创建api对象并将其传递给构造函数。这将允许您轻松地替换api类进行测试。在

您可以创建一个MockPyChimp类,它的方法与实际的PyChimp api相同。通过这种方式,您可以轻松地在测试中重用相同的模拟类。在

我对python/django单元测试不太熟悉,因此无法建议任何特定的库来帮助实现这一点,但我假设存在某种模拟库或类似的库。在

相关问题 更多 >