Python 中的 Unit testing 文件写入

在 Python 中进行单元测试时，有时候需要测试文件写入操作。为了模拟文件写入并进行单元测试，你可以使用 Python 的 unittest 模块，并结合 io.StringIO 或 tempfile 模块来模拟文件操作。

1、问题背景

在 Python 中，为 ConfigParser 编写一个简单的包装器，以便于存储和检索应用程序设置。

包装器具有两个方法，read 和 write，以及一组用于不同应用程序设置的属性。

write 方法只是 ConfigParser 的 write 方法的一个包装器，另外还创建了 ConfigParser 所需的文件对象。如下所示：

def write(self):
    f = open(self.path, "w")
    try:
        self.config_parser.write(f)
    finally:
        f.close()

希望编写单元测试来断言，如果无法写入文件，此方法会引发 IOError，反之，会调用 config 解析器的 write 方法。

借助模拟对象，第二个测试很容易处理。但是 open 调用让事情变得有点棘手。最终，必须创建一个文件对象才能传递给 config 解析器。在运行此代码时实际会创建一个文件，这对于单元测试来说不是很有用。是否有模拟文件创建的一些策略？可以以某种方式测试这段代码吗？还是它太简单而无法测试？

2、解决方案

解决方案 1

首先，实际上不需要对 open() 进行单元测试，因为可以合理地假设标准库是正确的。

其次，不想对文件系统进行操作以使 open() 生成所需的错误，因为那样就不是单元测试了，而是在通过包含文件系统来进行功能/集成测试。

因此，也许可以将全局命名空间中的 open() 替换为仅引发 IOError 的代理。虽然，可能需要确保在执行继续后将会还原。

但最后，测试有什么价值？代码片段中很少有是你自己的系统。即使替换 open() 最终也只是测试是否“Python 中 try 和 finally 语句有效？”。

建议只在文档字符串中添加一条记录期望值的语句。“如果无法写入文件，则引发 IOError。”然后继续。如果此方法获得一些复杂性（以及测试价值的话），稍后可以添加单元测试。

解决方案 2

实际上，在代码中只有 open 会引发异常。write() 的文档中没有提到任何异常。可能只针对错误的文件指针（由于 open 失败，此处不可能发生这种情况）而引发 ValueError 或其他异常。

为 open 做一个 IOError很容易。只需在其他地方创建文件并在那里打开它进行写入。或者可以更改其权限，以便自己无法访问。

可能需要在此处使用 with 语句，它会自己处理关闭操作。

在 Python 2.5 中，需要第一行。在更高版本中不需要。

from __future__ import with_statement # python 2.5 only
​
def write(self):
    with open(self.path, 'w') as f:
        self.config_parser.write(f)

如果 open 成功，则保证会调用 write 方法，如果 open 引发 IOError，则不会调用 write 方法。不知道为何需要测试是否调用了 write。代码表明是这样做的。不要过度测试。 ;)

解决方案 3

请记住，不需要测试 open() 或 ConfigParser 是否可用，它们不是代码的一部分，只需要测试是否正确使用它们。可以使用自己的 open() 来修补该模块，就像对实例属性那样，并且可以从中返回一个有助于进行测试的模拟。

但是，单元测试并不是唯一工具，这是一个足够简单且足以分析和“证明”其工作原理的功能。

以上三种方法用于在 Python 单元测试中测试文件写入操作。最终需要我们具体的根据实际情况选择适合的方法。如果有任何问题可以这里联系。