为Django Unittests干净地模拟远程服务器和API

Question

我有一个棘手的问题,我似乎无法掌握.我目前正在为django自定义auth-backend编写单元测试.在我们的系统上,我们实际上有两个后端:一个是内置的django后端和一个自定义后端,它向基于Java的API发送请求,该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,如果key nil存在,那么我们可以返回dict并继续执行happy and authenticated.显然,一个解决方案就是找到一种方法以某种方式覆盖或monkeypatch xml变量中的逻辑,我找到了这个答案:

一个mock/stub python模块如何像urllib一样

我试图实现类似的东西,但那里的细节非常粗略,我似乎无法实现这一点.

我还捕获了xml响应并将其放在测试文件夹中的本地文件中,目的是找到一种方法将其用作传递到测试函数的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)当你依赖于数据,cookie时,干净地编写Django单元测试的最佳实践是什么？等来自您域外的远程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')",
        ]))