在单元测试中模拟python类并验证实例

Question

我正在尝试对SFTP帮助程序类进行单元测试，该类对pysftp模块进行了一些调用。 我想模拟来自pysftp的实际网络调用，因此没有副作用，只需确保该类使用正确的参数正确调用了基础SFTP方法。

到目前为止，这是我的代码的一个简单示例：

import pysftp
import unittest
import mock

class SFTPHelper(object):
    def __init__(self, host, username, password, files_dir):
        self.host = host
        self.username = username
        self.password = password
        self.files_dir = files_dir

    def list_files(self):
        with pysftp.Connection(
                self.host,
                username=self.username,
                password=self.password) as sftp:
            return sftp.listdir(self.files_dir)

class TestSFTPHelper(unittest.TestCase):
    @mock.patch('pysftp.Connection')
    def test_list_files(self, mock_connection):
        sftp_helper = SFTPHelper('somehost', 'someuser', 'somepassword', '/some/files/dir')
        sftp_helper.list_files()

        # this assertion passes
        mock_connection.assert_called_with(
            'somehost', password='somepassword', username='someuser')

        # this assertion does not pass
        mock_connection.listdir.assert_called_with('/some/files/dir')

断言错误：

AssertionError: Expected call: listdir('/some/files/dir')
Not called

我认为它不起作用，因为我需要断言该函数是在实例上调用的，但是如何获取在我的方法中使用的pysftp.Connection实例呢？

Answer 1

您可以配置模拟，以返回定义了__enter__和__exit__方法的新模拟对象。 例如：

@mock.patch.object(
    target=pysftp,
    attribute='Connection',
    autospec=True,
    return_value=mock.Mock(
        spec=pysftp.Connection,
        __enter__=lambda self: self,
        __exit__=lambda *args: None
    )
)
def test_list_files(self, mock_connection):
    # (contents of test case)

另外，您可能要使用：

mock_connection.return_value.listdir.assert_called_with('/some/files/dir')

代替：

mock_connection.listdir.assert_called_with('/some/files/dir')

作为一个侧面说明，你也可以更换的两种用法assert_called_with在你的榜样assert_called_once_with 。

最终结果：

$ python -m unittest test_sftp_helper.TestSFTPHelper.test_list_files
.
----------------------------------------------------------------------
Ran 1 test in 0.017s

OK