Question

我最近了解了unittest.monkey.patch及其变体，我想用它来对文件读取函数的原子性进行单元测试。但是，补丁似乎没有任何效果。

这是我的设置。仔细审查的方法大致如此（abriged）：

#local_storage.py

def read(uri):
    with open(path, "rb") as file_handle:
        result = file_handle.read()
    return result

执行单元测试的模块（也是abriged）：

#test/test_local_storage.py

import unittest.mock
import local_storage

def _read_while_writing(io_handle, size=-1):
    """ The patch function, to replace io.RawIOBase.read. """

    _write_something_to(TestLocalStorage._unsafe_target_file) #Appends "12".
    result = io_handle.read(size) #Should call the actual read.
    _write_something_to(TestLocalStorage._unsafe_target_file) #Appends "34".

class TestLocalStorage(unittest.TestCase):
    _unsafe_target_file = "test.txt"

    def test_read_atomicity(self):
        with open(self._unsafe_target_file, "wb") as unsafe_file_handle:
            unsafe_file_handle.write(b"Test")

        with unittest.mock.patch("io.RawIOBase.read", _read_while_writing): # <--- This doesn't work!
            result = local_storage.read(TestLocalStorage._unsafe_target_file) #The actual test.
            self.assertIn(result, [b"Test", b"Test1234"], "Read is not atomic.")

这样，补丁应该确保每次尝试读取时，文件都会在实际读取之前和之后进行修改，就像它同时发生一样，从而测试读取的原子性。

单元测试目前成功，但我已经通过打印语句验证了补丁功能实际上没有被调用，因此该文件永远不会获得额外的写入（它只是说＆＃34;测试＆＃ 34）。我还修改了代码，因为它是非原子的。

所以我的问题：如何在local_storage模块中修补IO句柄的read函数？我在其他地方读过人们倾向于替换open（）函数返回类似StringIO的内容，但我不知道如何解决这个问题。

我需要支持Python 3.4及更高版本。

Answer 1

我终于找到了解决方案。

问题在于mock无法模拟用C语言编写的任何对象方法。其中一个是我遇到的RawIOBase。

所以确实解决方法是模拟open以返回RawIOBase周围的包装器。我无法让mock为我制作包装器，所以我自己实现了它。

有一个预先定义的文件被认为是＆＃34;不安全＆＃34;。包装器写到这个＆＃34;不安全＆＃34;每次对包装器进行任何调用时都会生成文件。这允许测试文件写入的原子性，因为它在写入时将其他内容写入不安全文件。我的实现通过写入临时（＆＃34; safe＆＃34;）文件然后将该文件移动到目标文件上来阻止这种情况。

包装器具有read函数的特殊情况，因为要正确测试原子性，它需要在读取期间写入文件。所以它首先读取文件的中途，然后停止并写入一些内容，然后继续读取。这个解决方案现在是半硬编码的（在中途有多远），但我会找到一种改进方法。

您可以在此处查看我的解决方案：https://github.com/Ghostkeeper/Luna/blob/0e88841d19737fb1f4606917f86e3de9b5b9f29b/plugins/storage/localstorage/test/test_local_storage.py

如何用unittest修补方法io.RawIOBase.read？

1 个答案: