Python 单元测试：通过模拟替换（或修补）一个函数

Question

我阅读了很多关于 unittest.mock 的内容，但我无法将其转移到我自己的场景中。所以我在这里创建了一个最小的工作示例。

我只是在测试之前替换了一个函数，并在测试结束时将其设置回原来的函数——没有使用 unittest.mock。问题是如何使用 unittest.mock.

替换函数或修改 return 值

Side-queston 是否有办法重置测试用例末尾隐含的 mock/patch。目前它已在 tearDownClass() 中明确完成。但有时我会忘记这样的事情。

#!/usr/bin/env python3

class MyData:
    me = None

    def __init__(self):
        MyData.me = self
        self.data = self._get_default_data()

    def _get_default_data(self):
        return "real default data"

if __name__ == '__main__':
    MyData()

    print(MyData.me.data)

这是测试

import unittest

from mockplay import MyData

def _test_data(self):
    return "simulated test data"

class MyTest_Sim(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        # remember the original method
        cls.org_method = MyData._get_default_data
        # mock the method
        MyData._get_default_data = _test_data

        MyData()

    @classmethod
    def tearDownClass(cls):
        # rest the mock/patch to the origiinal
        MyData._get_default_data = cls.org_method

    def test_data(self):
        self.assertEqual(MyData.me.data,
                         "simulated test data")

背景资料:

真正的应用程序从 JSON 文件中读取与用户相关的内容（例如电子邮件）。第一次启动，直接安装后，没有这个JSON文件。因此，该应用程序使用“内置”默认 JSON 文件。每个测试都以一个“全新”应用程序开始——文件系统上没有 JSON 文件。所以它使用 _get_default_data()。为了控制测试中存在哪些数据，我需要 mock/patch/替换此方法，因为默认 JSON 文件 a) 不适合所有测试用例，b) 可以在应用程序开发期间更改.

Answer 1

不需要更换功能。在我的示例中，只有函数的 return 值是感兴趣的。

补丁已创建，explicite 在 setupClass() 开始，explicite 在 tearDownClass() 停止。

import unittest
import unittest.mock as mock

from mockplay import MyData


class MyTest_Sim(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        # mock the return value
        cls.patcher = mock.patch('mockplay.MyData._get_default_data',
                                 return_value='simulated test data')
        # start the patch
        cls.patcher.start()

        # initiate data
        MyData()

    @classmethod
    def tearDownClass(cls):
        # stop the patch
        cls.patcher.stop()

    def test_data(self):
        self.assertEqual(MyData.me.data,
                         "simulated test data")

Python 3.8 或更高版本

在此 Python 版本中引入了新方法 addClassCleanup()。所以你不需要在所有测试结束时注意调用 patcher.stop() explicite。如果您这样做，测试 class 将为您完成此操作：

@classmethod
def setUpClass(cls):
    # ...

    # start the patch
    cls.patcher.start()

    # stop after all tests
    cls.addClassCleanup(cls.patcher.stop)

    # ...

Python 单元测试：通过模拟替换（或修补）一个函数

Python unittest: replace (or patch) a function via mock

python-3.x

python-unittest.mock

Python 3.8 或更高版本