Question

我有一个棘手的问题，我似乎无法掌握。我是目前正在为django自定义auth-backend编写单元测试。在我们的系统我们实际上有两个后端：一个是内置的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存在然后我们可以返回字典并继续进行快乐和认证。显然，一种解决方案就是找到某种方式来覆盖或 monkeypatch xml变量中的逻辑，我找到了这个答案：

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构建逻辑函数定义，（即“url + encoded_params”）。再一次，我可以重命名响应文件与连接的URL相同，但这正在变为不像一个好的单元测试功能和更多的“作弊”，整体而言这些解决方案一直在变得越来越脆弱，无论如何它真的只是一个装置，这也是我想要避免的东西，如果在所有可能的。

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

所以，理想情况下，我需要能够以某种方式模拟“服务器” 取代函数调用中的Java API，或以某种方式服务一些xml有效负载，该函数可以作为其URL打开，或者 monkeypatch来自测试本身的功能，或者......

模拟库是否有适当的工具来执行此类操作？

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

所以，这个问题有两点：1）我想解决我的问题干净的特殊问题，更重要的是2）是什么适合干净地编写Django单元测试的最佳实践依赖于数据，cookie等来从远程进行用户身份验证您域外的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')",
        ]))

Answer 2

以下是我最终记录的解决方案的基础知识。我最终使用了模拟库而不是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")

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

2 个答案: