在utils.py的Django单元测试中模拟失败

Question

我正在尝试为名为search_ldap()的函数编写单元测试，该函数将在给定特定用户名的情况下搜索LDAP服务器。 这是utils.py的函数定义（注意：我正在使用Python 3）：

from ldap3 import Server, Connection
def search_ldap(username):
    result = ()
    baseDN = "o=Universiteit van Tilburg,c=NL"
    searchFilter = '(uid={})'.format(username)
    attributes = ['givenName', 'cn', 'employeeNumber', 'mail']

    try:
        server = Server('ldap.example.com', use_ssl=True)
        conn = Connection(server, auto_bind=True)
        conn.search(baseDN, searchFilter, attributes=attributes)
        for a in attributes:
            result += (conn.response[0]['attributes'][a][0], )
    except Exception:
        raise LDAPError('Error in LDAP query')

    return result

当然，我不想在测试期间实际连接到ldap.example.com ，因此我决定使用Python的模拟对象库在单元测试中模拟Server()和Connection()类。 这是测试代码：

from unittest import mock
from django.test import TestCase
class LdapTest(TestCase):
    @mock.patch('ldap3.Server')
    @mock.patch('ldap3.Connection')
    def test_search_ldap(self, mockConnection, mockServer):
        from .utils import search_ldap
        search_ldap('username')
        self.assertTrue(mockServer.called)
        self.assertTrue(mockConnection.called)

该测试仅断言已模拟了Server和Connection对象。 但是，不要这样做，因为当我使用./manage.py test运行测试时，收到以下错误：

Creating test database for alias 'default'...
F.
======================================================================
FAIL: test_search_ldap (uvt_user.tests.LdapTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/mock.py", line 1142, in patched
    return func(*args, **keywargs)
  File "/home/jj/projects/autodidact/uvt_user/tests.py", line 28, in test_search_ldap
    self.assertTrue(mockServer.called)
AssertionError: False is not true

----------------------------------------------------------------------
Ran 2 tests in 0.030s

FAILED (failures=1)
Destroying test database for alias 'default'...

为什么我的测试失败？ 如何成功模拟ldap3的Server和Connection类？

Answer 1

为了模拟类，您应该提供带有必要方法的虚假实现。 例如：

class FakeServer:
    def call():
        pass

class LdapTest(TestCase):
    @mock.patch('ldap3.Server', FakeServer)
    def test_search_ldap(self):
        <do you checks here>

Answer 2

使用patch() ，重要的一点是在查找对象的名称空间中修补对象。 在文档的“ 何处打补丁”部分对此进行了说明。 两者之间有根本的区别

from ldap3 import Server
server = Server()

和

import ldap3
server = ldap3.Server()

在第一种情况下（在原始问题中也是如此），名称“服务器”属于当前模块。 在第二种情况下，名称“服务器”属于定义它的ldap3模块。 以下Django单元测试修补了正确的“服务器”和“连接”名称，并应按预期工作：

from unittest import mock
from django.test import TestCase
class LdapTest(TestCase):
    @mock.patch('appname.utils.Server')
    @mock.patch('appname.utils.Connection')
    def test_search_ldap(self, mockConnection, mockServer):
        from .utils import search_ldap
        search_ldap('username')
        self.assertTrue(mockServer.called)
        self.assertTrue(mockConnection.called)