文章目录
前言
前段时间,我们团队就单元测试是否采用 Mock 进行了一番交流,各有各的说法。本文就单元测试 Mock不Mock 给出我的观点,欢迎各位同仁提出不同的意见,共同探讨、相互交流。
单元测试没必要?
我见过好多不写单元测试的项目,大多给出的原因都是:"没必要"、"浪费时间"、"get不到单测的作用",这样的项目要么是小规模,要么就是头铁。
本人之前也有相同的观点...
单元测试在软件开发过程中还是非常重要的,除了可以提高代码的质量,在引入CI/CD后的自动化测试环节可以起到快速部署、交付作用。难道每次上线都需要"点点点"测试?这一点,我想经历过的人都深有体会。
Mock不Mock?
那什么是Mock?
什么是Mock?
简单来说,Mock就是模拟目标代码的行为,在实际测试过程中代替真实的调用目标。如下图
这样做的意义何在?
Mock的意义何在?
试想一下,单元测试中如果出现以下几个问题应该怎么办?
- 涉及到的DB操作、网络调用等单元测试产生的数据属不属于垃圾数据?会不会影响业务?
- 发布/部署生产环境的过程中,错误地执行了单元测试引起生产问题怎么办?
- CI过程中的测试环节花费时间太长怎么办?会不会影响集成交付?
以上几个问题我想大部分开发人员都经历过,那如何避免这些问题?我想Mock就是最好的一种方式。
如果将涉及到的外部操作,例如DB操作、网络调用等行为进行Mock,那就不会存在垃圾数据的问题,也不用担心环境切换带来的问题,外部耗时的操作也可以通过Mock避免CI过程过长。
个人认为Mock只是模拟调用外部的行为,并不影响代码逻辑。所以,不存在"Mock是不是有效的单元测试"这种说法。
如何Mock?
应该Mock什么?
通常,我们编写的方法(或函数)都是由很多方法按照层级组成的,就像这样
当我们对顶层方法进行单元测试时,应该Mock哪些方法?
- 如果Mock方法1、2、3,那么方法4、5、6就不会被调用到,里面的逻辑不会被覆盖到,也就不是有效的单元测试。
- 如果Mock方法4、5、6,里面的逻辑或返回值有修改,那么就要递归向上修改,不符合软件工程。
但是,如果方法43、、5、6都涉及到DB或者网络调用等外部不可控操作,我们就应该对其Mock。
所以,应该Mock一些稳定的、不可控的方法。
Mock 编写示例
以Python中的Mock框架为例,下面是一个示例:
python
class TestXxService(unittest.TestCase):
def test_init(self):
XXService.update(xx)
class XXService:
def update(xx):
......
test_init
函数中的....update
会涉及到数据库的操作,这里使用patch
模拟这两个函数的行为
python
# patch("目标函数路径")
patch('....update')
在模拟的上下文中,XXService.update
将会被模拟的函数替代执行
python
def test_init(self):
with patch('....update') as mocked_update:
# 在模拟的上下文中调用业务逻辑函数
XXService.update(xx)
mocked_update.assert_called_once_with(xx)
其中,assert_called_once_with
会验证模拟函数是否被调用了一次,并且会验证预期接收的参数是否匹配。
如果没有参数,使用assert_called_once
进行验证是否被调用了一次。
如果模拟的函数实际被调用了多次,需要通过以下方式
python
# 断言mocked_update被调用了2次
self.assertEqual(mocked_update.call_count, 2)
# 断言mocked_update被调用了,并且参数正确
mocked_update.assert_any_call(xx)
如果函数有返回值,在定义模拟函数时,添加 return_value
,return_value可以是任意类型。
python
patch('...update',
return_value='xxx') as mocked_update
在验证返回值时通过下面的方式
python
xxxx = mocked_update.return_value
self.assertEqual(xxxx, 'xxx')
通过示例,我们Mock了XXService.update
行为,实现了对XXService
的隔离测试,并确保了测试的可靠性和高效性。
总结
单元测试中使用Mock有以下几个好处:
- 隔离测试:Mock 使得测试可以专注于测试的代码逻辑,而不必关心外部不稳定因素。
- 提高测试速度:Mock 可以避免耗时的外部调用,从而加快测试速度。
- 提高测试的可靠性和稳定性:通过Mock,可以避免外部变化对测试结果的影响。