干净地模拟 Django 单元测试的远程服务器和 API答案

【问题标题】：Cleanly Mocking Remote Servers and APIs for Django Unittests干净地模拟 Django 单元测试的远程服务器和 API
【发布时间】：2013-05-29 14:08:17
【问题描述】：

我有一个似乎无法解决的棘手问题。我是目前正在为 django 自定义身份验证后端编写单元测试。在我们的系统我们实际上有两个后端：一个是内置的 django 后端以及将请求发送到基于 Java 的 API 的自定义后端以 XML 的形式返回用户信息。现在，我正在写单元测试所以我不想在系统之外发送请求那，我不想测试Java API，所以我的问题是我怎么能绕过这个并以最强大的方式模拟副作用。

我正在测试的功能是这样的，其中 url 设置值只是 Java 服务器的基本 url 验证用户名和密码数据并返回xml，服务值为只是构建 url 查询的一些魔法，它对我们：

@staticmethod
def get_info_from_api_with_un_pw(username, password, service=12345):
    url = settings.AUTHENTICATE_URL_VIA_PASSWORD
    if AUTH_FIELD == "username":
        params = {"nick": username, "password": password}
    elif AUTH_FIELD == "email":
        params = {"email": username, "password": password}
    params["service"] = service
    encoded_params = urlencode([(k, smart_str(v, "latin1")) for k, v in params.items()])
    try:
        # get the user's data from the api
        xml = urlopen(url + encoded_params).read()
        userinfo = dict((e.tag, smart_unicode(e.text, strings_only=True))
                        for e in ET.fromstring(xml).getchildren())
        if "nil" in userinfo:
            return userinfo
        else:
            return None

所以，我们得到 xml，将其解析为 dict，如果存在键 nil 然后我们可以返回字典并继续快乐和认证。显然，一种解决方案就是找到一种方法来以某种方式覆盖或对xml变量中的逻辑进行monkeypatch，我找到了这个答案：

How can one mock/stub python module like urllib

我试图实现类似的东西，但那里的细节非常粗略，我似乎无法正常工作。

我还捕获了 xml 响应并将其放入测试文件夹，旨在找到一种将其用作模拟的方法传递给测试函数的 url 参数的响应，像这样的东西会覆盖网址：

@override_settings(AUTHENTICATE_URL_VIA_PASSWORD=(os.path.join(os.path.dirname(__file__), "{0}".format("response.xml"))))
def test_get_user_info_username(self):
    self.backend = RemoteAuthBackend()
    self.backend.get_info_from_api_with_un_pw("user", "pass")

但这也需要考虑到函数定义，（即“url + encoded_params”）。再次，我可以重命名响应文件与连接的 url 相同，但这正在变成与其说是对功能的良好单元测试，不如说是“作弊”，整体有了这些解决方案，事情变得越来越脆弱，而且它实际上只是一个固定装置，这也是我想避免的事情，如果完全有可能。

我还想知道是否有办法在 django 开发服务器上提供 xml，然后将函数指向那里？这似乎是一个更明智的解决方案，但大量的谷歌搜索并没有给我任何线索，如果这样的事情是可能的或可取的，即使这样我也不认为这将是在开发环境之外运行的测试。

所以，理想情况下，我需要能够以某种方式模拟“服务器”以在函数调用中代替 Java API，或者以某种方式提供服务设置一些函数可以作为其 url 打开的 xml 有效负载，或者从测试本身对函数进行monkeypatch，或者...

模拟库是否有合适的工具来做这些事情？

http://www.voidspace.org.uk/python/mock

所以，这个问题有两点 1）我想解决我的问题以干净的方式解决特定问题，更重要的是2）什么是干净地编写 Django 单元测试的最佳实践依赖于数据、cookies等来进行远程用户身份验证您的域之外的 API？

【问题讨论】：

标签： python django api unit-testing mocking

【解决方案1】：

如果使用得当，模拟库应该可以工作。我更喜欢 minimock 库，并且我编写了一个小的基本单元测试用例 (minimocktest) 来帮助解决这个问题。

如果您想将此测试用例与 Django 集成以测试urllib，您可以这样做：

from minimocktest import MockTestCase
from django.test import TestCase
from django.test.client import Client

class DjangoTestCase(TestCase, MockTestCase):
    '''
    A TestCase class that combines minimocktest and django.test.TestCase
    '''

    def _pre_setup(self):
        MockTestCase.setUp(self)
        TestCase._pre_setup(self)
        # optional: shortcut client handle for quick testing
        self.client = Client()

    def _post_teardown(self):
        TestCase._post_teardown(self)
        MockTestCase.tearDown(self)

现在你可以使用这个测试用例而不是直接使用 Django 测试用例了：

class MySimpleTestCase(DjangoTestCase):
    def setUp(self):
        self.file = StringIO.StringIO('MiniMockTest')
        self.file.close = self.Mock('file_close_function')
    def test_urldump_dumpsContentProperly(self):
        self.mock('urllib2.urlopen', returns=self.file)
        self.assertEquals(urldump('http://pykler.github.com'), 'MiniMockTest')
        self.assertSameTrace('\n'.join([
            "Called urllib2.urlopen('http://pykler.github.com')",
            "Called file_close_function()",
        ]))
        urllib2.urlopen('anything')
        self.mock('urllib2.urlopen', returns=self.file, tracker=None)
        urllib2.urlopen('this is not tracked')
        self.assertTrace("Called urllib2.urlopen('anything')")
        self.assertTrace("Called urllib2.urlopen('this is mocked but not tracked')", includes=False)
        self.assertSameTrace('\n'.join([
            "Called urllib2.urlopen('http://pykler.github.com')",
            "Called file_close_function()",
            "Called urllib2.urlopen('anything')",
        ]))

【讨论】：

在您的情况下，您需要模拟以下内容：import models; self.mock('models.urlopen')，因为您似乎在模型文件from urllib import urlopen 中按如下方式导入了它。
啊，太好了，看来这样的嘲讽只是门票。非常感谢！

【解决方案2】：

这是我最终记录下来的解决方案的基础知识。我最终使用了 Mock 库本身而不是 Mockito，但想法是一样的：

from mock import patch

@override_settings(AUTHENTICATE_LOGIN_FIELD="username")
@patch("mymodule.auth_backend.urlopen")
def test_get_user_info_username(self, urlopen_override):
    response = "file://" + os.path.join(os.path.dirname(__file__), "{0}".format("response.xml"))
    # mock patch replaces API call
    urlopen_override.return_value = urlopen(response)
    # call the patched object
    userinfo = RemoteAuthBackend.get_info_from_api_with_un_pw("user", "pass")
    assert_equal(type(userinfo), dict)
    assert_equal(userinfo["nick"], "user")
    assert_equal(userinfo["pass"], "pass")

【讨论】：