2020-01-31

Pytest-Mock 进阶用法详解

一、什么是 Mock 测试？

    Mock测试就是在 测试过程 中，对于某些不容易构造或者不容易获取的对象，用一个虚拟的对象来创建以便测试的测试方法。这个虚拟的对象就是Mock对象。Mock对象就是真实对象在调试期间的代替品。关键步骤是使用一个接口来描述该对象，在测试过程中解耦掉这个接口或者方法。只通过接口来引用对象，目前一般用于单元测试或者自动化测试依赖第三方接口时所应用。

二、应用场景

在这里主要描述关于自动化测试的应用：

1、内部服务、接口的依赖

2、外部第三方接口依赖

3、被测试模块跨多个测试系统依赖，测试环境复杂且不稳定

场景案例：

        稍微复杂一点的系统存在各种项目之间的频繁调用，不管是服务、系统、平台之间的调用还是第三方（支付、银行）相关接口的调用，然而在实际测试的过程中，如果依赖的接口不可用时，这样就会影响自动化用例的执行。

        之前有遇到一个项目测试是跟银行交互，银行文件接口数据是第二天才返回的，然而自动化不可能等到第二天才去断言返回结果，还有依赖其他服务的接口会因为环境问题导致接口不可调用，由于各种的依赖问题自动化用例不稳定常常会失败。那么问题来了，在实际自动化测试过程中如果应用mock 解决依赖问题？下面会讲解Python pytest 框架的mock应用。

三、Mock 模块

Python 目前有两个库可以使用,据说 mock 从3.3+就已经集成到unittest框架，而pytest-mock 集成了 mock 的所有功能，更加的灵活和强大。

>> pip install mock

>> pip install pytest-mock

下面是 mock 库方法属性详解，参考博客：python | Mock（一） - 简书

__init__：

    name: mock 对象的标识

    spec: 设置对象属性

    return_value: 对象调用时的返回值

    side_effect: 覆盖return_value, 当对象被调用时返回

Assert_method:

    assert_called_with: 断言 mock 对象的参数是否正确

    assert_called_once_with: 检查某个对象如果被调用多次抛出异常，只允许一次

    assert_any_call: 检查对象在全局过程中是否调用了该方法

    assert_has_calls: 检查调用的参数和顺序是否正确

Management:

    attach_mock: 添加对象到另一个mock对象中

    configure_mock: 重新设置对象的返回值

    mock_add_spec: 新增对象属性

    reset_mock: 重置对象

Count:

    called: 对象调用的访问器

    call_count: 对象调用次数

    call_args: 对象调用时的参数（最近）

    call_args_list: 获取对用时所有的参数list

    method_calls: 统计对象调用的所有方法，返回list

    mock_calls: 统计工厂调用、方法调用

示例

    首先在 mock.py 定义两个函数，其中一个函数依赖上一个函数的返回值，这里这么写的原因就是mock实际项目测试过程场景中，接口中的依赖关系。

mock.py

    接下来在 test_mock.py 中对 mock.py 模块中的的mock_request 函数的返回值进行mock。下面的示例用了三种方式，其实结果是一样的效果：

    1. 使用的是pytest-mock 中的mocker

    2. 使用的 mock 中patch方法，是对目标函数的返回值进行替换，采用了with上下文进行管理

    3. 使用的装饰器的方式对mock对象的函数返回值进行替换

三种方式都是使用的mock.patch进行对函数的替换，还有一种 mock.object是针对类进行替换，实际用法是一样的。

test_mock.py

    从上面的示例可以看出，在调用 invoke_mock_request() 之前先对其接口依赖的 mock_request() 方法的返回值可以替换，这样的话不管其方法的返回值如何变化，我们只需要关注此次 mock 即可。

四、Monkey Patching

    上面介绍了对函数或者类进行 mock，但是有时候测试需要调用依赖于全局设置的功能，或调用无法轻松测试的代码（如网络访问）修改测试环境变量信息等。 monkey patch fixture 可帮助您安全地设置/删除属性，Monkey patching主要针对模块和环境进行Mock。

    假设你想阻止 os.expanduser 返回某个目录，你可以在测试方法调用其之前，使用 monkeypatch.setattr() 猴子补丁方法改造这个函数：

    虽然看起来有点奇怪，但是确实改变了 getFile() 函数的目录返回，在测试函数 test_getFile 内部 getFile 调用之前，使用猴子补丁改造了os.path.expanduser， 然后再进行调用。 测试执行完成后对 os.path.expanduser 修改将被撤消.

    以下是对环境变量的信息修改，已知有 testEnv 的值是 dev，在实际测试的函数中调用之前，事先使用猴子补丁修改了变量信息，这样可以在自动化测试的环境切换中可以用到，这样的好处是测试函数执行之后，本次的修改就会撤销，不会影响环境的整体设置。总之，功能很强大，这里只是简单描述一下，有兴趣的可以去pytest官网  Pytest官方教程-07-Monkeypatching,对模块和环境进行Mock - 简书 查看更多的资料。

五、思考

    通过以上的示例了解了 pytest_mock 的使用，那么在实际的自动化用例过程中，如何结合 pytest-mock 来解决接口解耦、数据依赖的问题？有疑问的可以给我留言！