使用补丁模拟两个函数以进行单元测试

Question

我有一个要单元测试的函数包含调用其他两个函数。我不确定如何使用补丁正确地同时模拟这两个函数。我在下面提供了一个例子来说明我的意思。当我运行nosetests时，测试通过了，但我觉得必须有一种更清洁的方法来做到这一点，我并不真正理解关于 f.close() 的文章......

目录结构如下：

program/
  program/
    data.py
  tests/
    data_test.py

数据.py：

import cPickle

def write_out(file_path, data):
    f = open(file_path, 'wb')
    cPickle.dump(data, f)
    f.close()

data_test.py：

from mock import MagicMock, patch

def test_write_out():
    path = '~/collection'
    mock_open = MagicMock()
    mock_pickle = MagicMock()
    f_mock = MagicMock()
    with patch('__builtin__.open', mock_open):
        f = mock_open.return_value
        f.method.return_value = path
        with patch('cPickle.dump', mock_pickle):
            write_out(path, 'data')
            mock_open.assert_called_once_with('~/collection', 'wb')
            f.close.assert_any_call()
            mock_pickle.assert_called_once_with('data', f)

结果：

$ nosetests
.
----------------------------------------------------------------------
Ran 1 test in 0.008s
OK

Answer 1

您可以通过使用补丁装饰器并像这样嵌套它们来简化测试（默认情况下它们是MagicMock 对象）：

@patch('cPickle.dump')
@patch('__builtin__.open')
def test_write_out(mock_open, mock_pickle):
    path = '~/collection'
    f = mock_open.return_value
    f.method.return_value = path

    write_out(path, 'data')

    mock_open.assert_called_once_with('~/collection', 'wb')
    mock_pickle.assert_called_once_with('data', f)
    f.close.assert_any_call()

对MagicMock 实例的调用会返回一个新的MagicMock 实例，因此您可以检查返回的值是否像任何其他模拟对象一样被调用。在这种情况下，f 是一个名为 'open()' 的 MagicMock（尝试打印 f）。

Answer 2

除了响应@Matti John，您还可以在函数test_write_out 内使用patch：

from mock import MagicMock, patch

def test_write_out():
    path = '~/collection'
    with patch('__builtin__.open') as mock_open, \
            patch('cPickle.dump') as mock_pickle:

        f = mock_open.return_value
        ...

Answer 3

这里有一个简单的例子，说明如何使用 mock 在 create_collection 函数中测试提升 ConflictError：

import os
from unittest import TestCase
from mock import patch
from ..program.data import ConflictError, create_collection


class TestCreateCollection(TestCase):
    def test_path_exists(self):
        with patch.object(os.path, 'exists') as mock_method:
            mock_method.return_value = True

            self.assertRaises(ConflictError, create_collection, 'test')

另请参阅 mock docs 和 Michael Foord 的精彩 introduction to mock。