Python——单元测试中mock原理和使用

mock主要是的为了提供开发程序员的做一个的单元测试而使用的。假设你开发一个项目，里面包含了一个登录模块，登录模块需要调用身份证验证模块中的认证函数，该认证函数会进行值的返回，然后系统根据这个返回值来做判断是否能进行登录。但是身份证验证模块中的认证函数只有在正式上线的系统上才提供。公司内部的测试环境或者开发环境上不提供。如果此时需要进行登录模块的业务测试或接口测试。

搭建一个真实的测试环境器，在测试的时候，让认证函数和这个测试服务器交互，返回值给登录模块；

缺点：

1、测试服务器可能不好搭建，或者搭建效率很低；

2、搭建的测试服务器可能无法返回所有可能的值，或者需要大量的工作才能达到这个目的。

3、有可能真实的测试环境构建不了，又或者是测试的代价太大。

Mock是Python中一个用于支持单元测试的库，它的主要功能是使用mock对象替代掉指定的Python对象，以达到模拟对象的行为。python3.3 以前，mock是第三方库，需要安装之后才能使用。python3.3之后，mock作为标准库内置到 unittest。

因为unittest集成了mock，而且python3.0使用更加广泛，所以以unittest中的mock为例介绍mock功能。

​

 Mock对象是模拟的基石，提供了丰富多彩的功能。从测试的阶段来分类包括：

​

class unittest.mock.Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

return_value ：调用mock的返回值，模拟某一个方法的返回值。

side_effect ：调用mock时的返回值，可以是函数，异常类，可迭代对象。使用side_effect可以将模拟对象的返回值变成函数，异常类，可迭代对象等。
当设置了该方法时，如果该方法返回值是DEFAULT，那么返回return_value的值，如果不是，则返回该方法的值。 return_value 和 side_effect 同时存在，side_effect会返回。
如果 side_effect 是异常类或实例时，调用模拟程序时将引发异常。
如果 side_effect 是可迭代对象，则每次调用 mock 都将返回可迭代对象的下一个值。

name ：mock 的名称。 这个是用来命名一个mock对象，只是起到标识作用，当你print一个mock对象的时候，可以看到它的name。

wraps: 装饰器：模拟对象要装饰的项目。
如果wrapps不是None，那么调用Mock将把调用传递给wrapped对象（返回实际结果）。
对mock的属性访问将返回一个mock对象，该对象装饰了包装对象的相应属性。

spec_set：更加严格的要求，spec_set=True时，如果访问mock不存在属性或方法会报错

spec: 参数可以把一个对象设置为 Mock 对象的属性。访问mock对象上不存在的属性或方法时，将会抛出属性错误。

使用mock.Mock()可以创建一个mock对象，对象中的方法有两种设置途径：

作为Mock类的参数传入。  

    mock.Mock(return_value=20,side_effect=mock_fun, name='mock_sum')

实例化mock对象之后设置属性。

    mock_sum = mock.Mock()
    mock_sum.return_value = 20
    mock_sum.side_effect = mock_fun

https://github.com/2462612540/Machine-Learning/tree/2021/python_mock

完成模拟之后之后，必须把它们复原。如果模拟对象在其它测试中持续存在，那么会导致难以诊断的问题。为此，mock中还提供了 mock.patch和mock.patch.object 等多个对象。mock.patch 是一种进阶的使用方法，主要是方便函数和类的测试，有三种使用方法：

1.  函数修饰器
2. 类修饰器
3. 上下文管理器 

使用patch或者patch.object的目的是为了控制mock的范围

1. patch：用于mock一个函数
2. patch.object：用于mock一个类

unittest.mock.patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

说明：Patch()充当函数修饰器、类修饰器或上下文管理器。在函数体或with语句中，使用patch中的new替换目标函数或方法。当function/with语句退出时，模拟程序被撤消。

target: 模拟对象的路径，参数必须是一个str,格式为'package.module.ClassName'，
注意这里的格式一定要写对。如果对象和mock函数在同一个文件中，路径要加文件名

new: 模拟返回的结果，是一个具体的值，也可是函数。new属性替换target，返回模拟的结果。

new_callable 模拟返回的结果，是一个可调用的对象，可以是函数。

spec: 与Mock对象的参数类似，用于设置mock对象属性。

spec_set: 与Mock对象的参数类似，严格限制mock对象的属性或方法的访问

autospec：替换mock对象中所有的属性。可以替换对象所有属性，但不包括动态创建的属性。
autospec是一个更严格的规范。如果你设置了autospec=True，将会使用spec替换对象的属性来创建一个mock对象。mock对象的所有属性都会被spec相应的属性替换。
被mock的方法和函数会检查他们的属性，如果调用它们没有属性会抛出 TypeError。它们返回的实例也会是相同属性的类

create：允许访问不存在属性
默认情况下，patch()将无法替换不存在的属性。如果你通过create=True，当替换的属性不存在时，patch会创建一个属性，并且当函数退出时会删除掉属性。这对于针对生产代码在运行时创建的属性编写测试非常有用。它在默认情况下是关闭的，因为它可能是危险的，打开它后，您可以针对实际不存在的api编写通过测试的代码

同时mock.patch也是mock的一个子类，所以可以用return_value 和 side_effect

def get_sum(x, y):
    pass

--------------------------------------------------------------------

import demo
from unittest import mock

def need_mock_fun():
    mock_get_sum = mock.patch('demo.get_sum', return_value=20)

    mock_get_sum.start()
    result = demo.get_sum()
    mock_get_sum.stop()
    
    print(result)
    
need_mock_fun()