Python测试:使用虚拟文件和mock& io.StringIO

时间:2016-11-03 15:05:10

标签: python unit-testing mocking python-mock

我正在尝试测试一些在文件上运行的代码,而我似乎无法理解如何使用mock和{{1}的真实文件进行替换} 我的代码几乎是以下内容:

io.StringIO

我有一个可以接受列表或文件的类,如果它是一个文件,它打开它并将内容提取到列表中,然后执行它需要对结果列表执行的操作。

我的工作测试如下:

class CheckConfig(object):
    def __init__(self, config):
        self.config = self._check_input_data(config)

    def _check_input_data(self, data):
        if isinstance(data, list):
            return self._parse(data)
        elif os.path.isfile(data):
            with open(data) as f:
                return self._parse(f.readlines())

    def _parse(self, data):
        return data

我想替换对文件系统的调用。我尝试用def test_CheckConfig_with_file(): config = 'config.txt' expected = parsed_file_data actual = CheckConfig(config).config assert expected == actual 替换文件,但我从io.StringIO得到TypeError,因为它需要字符串,字节或整数。我也试过像这样嘲笑os.path.isfile()方法:

isfile

但我仍然得到@mock.patch('mymodule.os.path') def test_CheckConfig_with_file(mock_path): mock_path.isfile.return_value = True config = io.StringIO('data') expected = parsed_file_data actual = CheckConfig(config).config assert expected == actual 相同的TypeError _io.StringIO类型导致异常,isfile有机会返回一些内容。

当我传递假文件时,如何让os.path.isfile返回True?或者这是一个我应该改变我的代码的建议吗?

2 个答案:

答案 0 :(得分:4)

只需模拟os.path.isfile open()调用,然后传入假文件名(毕竟你不应该传入打开的文件)。

模拟库包含后者的实用程序:mock_open()

@mock.patch('os.path.isfile')
def test_CheckConfig_with_file(mock_isfile):
    mock_isfile.return_value = True
    config_data = mock.mock_open(read_data='data')
    with mock.patch('mymodule.open', config_data) as mock_open:
        expected = parsed_file_data
        actual = CheckConfig('mocked/filename').config
        assert expected == actual

这会导致if isinstance(data, list):测试为假(因为data是字符串),然后是elif os.path.isfile(data):返回Trueopen(data)致电使用mock_open()结果中的模拟数据。

您可以使用mock_open变量来声明使用正确的数据(例如open())调用了mock_open. assert_called_once_with('mocked/filename')

演示:

>>> import os.path
>>> from unittest import mock
>>> class CheckConfig(object):
...     def __init__(self, config):
...         self.config = self._check_input_data(config)
...     def _check_input_data(self, data):
...         if isinstance(data, list):
...             return self._parse(data)
...         elif os.path.isfile(data):
...             with open(data) as f:
...                 return self._parse(f.readlines())
...     def _parse(self, data):
...         return data
...
>>> with mock.patch('os.path.isfile') as mock_isfile:
...     mock_isfile.return_value = True
...     config_data = mock.mock_open(read_data='line1\nline2\n')
...     with mock.patch('__main__.open', config_data) as mock_open:
...         actual = CheckConfig('mocked/filename').config
...
>>> actual
['line1\n', 'line2\n']
>>> mock_open.mock_calls
[call('mocked/filename'),
 call().__enter__(),
 call().readlines(),
 call().__exit__(None, None, None)]

答案 1 :(得分:2)

如果您最终想知道如何使用pytest-mock库解决此问题,请按以下步骤操作:

def test_open(mocker):
    m = mocker.patch('builtins.open', mocker.mock_open(read_data='bibble'))
    with open('foo') as h:
        result = h.read()

    m.assert_called_once_with('foo')
    assert result == 'bibble'

找到了此代码示例(但必须进行调整)here