python - 为 Django 单元测试干净地模拟远程服务器和 API

Question

我有一个棘手的问题，我似乎无法解决。我是目前正在为 Django 自定义身份验证后端编写单元测试。在我们的system 我们实际上有两个后端:一个是内置的 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，将其解析为字典，如果存在键 nil然后我们可以返回字典并进行快乐和认证。显然，一个解决方案就是找到一种方法以某种方式覆盖或monkeypatch xml 变量中的逻辑，我找到了这个答案:

How can one mock/stub python module like urllib

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

我还捕获了 xml 响应并将其放入本地文件中test 文件夹，目的是找到一种将其用作模拟的方法传递到测试函数的 url 参数中的响应，像这样的东西会覆盖 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 构建逻辑函数定义，(即“url + encoded_pa​​rams”)。同样，我可以重命名响应文件与连接的 url 相同，但这正在成为不太像是功能的良好单元测试，更像是“作弊”，整个这些解决方案一直在变得越来越脆弱，而且它实际上只是一个固定装置，这也是我想避免的事情尽一切可能。

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

因此，理想情况下，我需要能够以某种方式模拟“服务器”以在函数调用中代替 Java API，或者以某种方式服务上传一些 xml 有效负载，该函数可以将其作为其 url 打开，或者monkeypatch 测试本身的函数，或者...

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

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

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

Answer 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')",
        ]))