9

我有一个棘手的问题，我似乎无法解决。我目前正在为 django 自定义身份验证后端编写单元测试。在我们的系统上，我们实际上有两个后端：一个是内置的 django 后端，另一个是自定义后端，它向基于 Java 的 API 发送请求，该 API 以 XML 的形式返回用户信息。现在，我正在编写单元测试，所以我不想像那样在系统外发送请求，我不想测试 Java API，所以我的问题是如何解决这个问题并模拟副作用以最稳健的方式。

我正在测试的函数是这样的，其中 url 设置值只是用于验证用户名和密码数据并返回 xml 的 Java 服务器的基本 url，而服务值只是构建 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，那么我们可以返回 dict 并继续进行快乐和身份验证。显然，一个解决方案就是找到一种方法来以某种方式覆盖或修改 xml 变量中的逻辑，我找到了这个答案：

一个模拟/存根 python 模块如何像 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 打开，或者从测试本身，或者...

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

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

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

4

2 回答 2

2

如果使用得当，模拟库应该可以工作。我更喜欢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')",
        ]))
于 2013-06-03T13:00:49.433 回答
0

这是我最终记录下来的解决方案的基础知识。最后我使用了 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")
于 2013-06-05T11:07:57.307 回答