使用mock.patch.object时找不到CmdController的executeSSHCommand方法求助

问题描述 #

我刚开始尝试使用mock库进行单元测试，现有CmdController类如下：

class CmdController:
    def __init__(self):
        pass

    def getNbProcessors(self, connParams: ConnectionParams):
        cmd = 'someCommand'
        out, err = self.executeSSHCommand(connParams, cmd)
        if len(err) > 0:
            raise errors.CmdError(err)
        return out

    def executeSSHCommand(self, connParams: ConnectionParams, cmd: list) -> tuple:
        <someTreatments>
        return res, err

编写的测试用例如下：

class MyTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.connParamsTest = ConnectionParams(some, arguments)

    @mock.patch.object('project.Module.CmdController.executeSSHCommand')
    def test_getNbProcessors(self, mock_exec_cmd):
        mock_exec_cmd.return_value = '3'
        print(self.cmdController.getNbProcessors(self.connParamsTest))

运行测试时出现错误：

<module 'project.Module.CmdController' from '/app/SynchroDB_app/project/Module/CmdController.py'> does not have the attribute 'executeSSHCommand'

尝试将路径改为'CmdController.executeSSHCommand'后问题依旧，请问为何找不到该方法？

问题原因及解决办法 #

1. mock.patch.object的参数使用错误 #

mock.patch.object的第一个参数必须是类/实例对象，而非字符串形式的模块路径——字符串路径是mock.patch（不带.object）的用法。

修正方式一：直接传入类对象

先确保已经导入CmdController类，然后将类作为第一个参数传入patch.object：

from project.Module.CmdController import CmdController
import mock
import unittest

class MyTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.connParamsTest = ConnectionParams(some, arguments)
        self.cmdController = CmdController()  # 初始化类实例

    @mock.patch.object(CmdController, 'executeSSHCommand')
    def test_getNbProcessors(self, mock_exec_cmd):
        # 匹配原方法的返回值格式：元组(out, err)
        mock_exec_cmd.return_value = ('3', '')
        result = self.cmdController.getNbProcessors(self.connParamsTest)
        self.assertEqual(result, '3')

修正方式二：用mock.patch配合完整字符串路径

如果坚持用字符串路径，需要使用mock.patch，并且路径要精确到类的方法：

import mock
import unittest

class MyTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.connParamsTest = ConnectionParams(some, arguments)
        self.cmdController = CmdController()

    @mock.patch('project.Module.CmdController.CmdController.executeSSHCommand')
    def test_getNbProcessors(self, mock_exec_cmd):
        mock_exec_cmd.return_value = ('3', '')
        result = self.cmdController.getNbProcessors(self.connParamsTest)
        self.assertEqual(result, '3')

2. 遗漏CmdController实例化 #

原测试代码中没有初始化self.cmdController，导致调用self.cmdController.getNbProcessors时会报错，必须在setUp方法中补上实例化代码。

3. 返回值格式不匹配 #

原executeSSHCommand方法返回的是元组类型(res, err)，测试中设置return_value = '3'是字符串，会导致后续len(err)逻辑报错，需要改成元组形式，比如('3', '')表示无错误输出。

内容的提问来源于stack exchange，提问作者Antonin