unitest mock

介绍

什么是 mock

unittest.mock 是一个用于在 Python 中进行单元测试的库，Mock 翻译过来就是模拟的意思，顾名思义这个库的主要功能是模拟一些东西。

它的主要功能是使用 mock 对象替代掉指定的 Python 对象，以达到模拟对象的行为。

学过 python 自动化的对 unittest 并不陌生，unittest 其实是单元测试框架，

但对于单元测试，估计很多小伙伴都不懂，单元测试才是自动化测试的至高境界，其中 mock 是单元测试的脊髓所在

mock 能做什么

1、前后端联调，如果你是一个前端页面开发，现在需要开发一个功能：

• 下一个订单，支付页面的接口，根据支付结果展示不同的页面。

  • 支付成功，展示支付成功页，
  • 支付失败，展示支付失败页。

• 要完成此功能，就需要调用后端的接口，根据返回给你的结果，来展示不同的页面。但此时后端接口还没开发好，

作为一个前端开发总不能等别人开发好了，你再开发，那你只有加班的命了。 为了同步开发完成任务，此时，你可以根据接口文档的规定，把接口的地址和入参传过去，然后自己 mock 接口的不同返回界面，来完成前端的开发任务

2、单元测试，单元测试的目的是测试某个小小单元的功能，但现实中开发的函数或方法都是有依赖关系。

比如 b 函数的参数，需要调用 a 函数的返回结果，但是我前面已经测试 a 函数了 这种情况下，就不需要再测一次 a 函数了，此时就可以用 mock 模块来模拟调用这部分内容，并给出返回结果。

3、第三方接口依赖，在做接口自动化的时候，有时候需要调用第三方的接口，但是别人公司的接口服务不受你的控制，有可能别人提供的测试环境今天服务给你开着，别人就关掉了， 给自动化接口测试带来很多的麻烦，此时就可以自己写一个 mock-server 来模拟接口的返回数据

mock 使用

在 Python3 中，unittest 已经包含 mock 了，是 unittest 单元测试的一部分，直接导入过来就能使用。

from unittest import mock

依赖关系

1、如下场景：支付是一个独立的接口，由其它开发提供，根据支付的接口返回状态去显示失败，还是成功，这个是你需要实现的功能 也就是说你写一个 b 功能，你的同事写一个 a 功能，你的 b 功能需要根据 a 功能的结果去判断，然后实现对应的功能。这就是存在依赖关系，你同事开发的进度你是无法控制的 你要是等他开发完了，你再开发，那你就坐等加班吧。

2、以下是自己写的 pay_statues() 函数功能，大概设计如下，保存为 order.py 文件

order.py

def pay():
    """
    假设这里是一个支付的功能，未开发完
    支付成功返回：{"result": "success", "reason":"null"}
    支付失败返回：{"result": "fail", "reason":"余额不足"}
    reason 返回失败原因
    """
    pass


def pay_statues():
    """根据支付的结果 success or fail，判断跳转到对应页面"""
    result = pay()
    print(result)
    try:
        if result["result"] == "success":
            return "支付成功"
        elif result["result"] == "fail":
            print("失败原因：%s" % result["reason"])
            return "支付失败"
        else:
            return "未知错误异常"
    except:
        return "Error, 服务端返回异常！"

unitest_mock.py

from unittest import mock
import unittest
import order


class TestPayStatues(unittest.TestCase):
    """单元测试用例"""

    def test_01(self):
        """测试支付成功场景"""
        # mock 一个支付成功的数据
        order.pay = mock.Mock(return_value={"result": "success", "reason": "null"})
        # 根据支付结果测试页面跳转
        statues = order.pay_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    def test_02(self):
        """测试支付失败场景"""
        # mock 一个支付成功的数据
        order.pay = mock.Mock(return_value={"result": "fail", "reason": "余额不足"})
        # 根据支付结果测试页面跳转
        statues = order.pay_statues()
        self.assertEqual(statues, "支付失败")


if __name__ == "__main__":
    unittest.main()

Patch

mock 里面另一种实现方式，patch 装饰器的使用，patch() 作为函数装饰器，为您创建模拟并将其传递到装饰函数

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

• target 参数必须是一个 str，格式为'package.module.ClassName'，注意这里的格式一定要写对，如果你的函数或类写在 pakege 名称为 a 下，b.py 脚本里，有个 c 的函数（或类），那这个参数就写“a.b.c”
• new 参数如果没写，默认指定的是 MagicMock
• spec=True 或 spec_set=True，这会导致 patch 传递给被模拟为 spec / spec_set 的对象 new_callable 允许您指定将被调用以创建新对象的不同类或可调用对象。默认情况下 MagicMock 使用。

unitest_patch.py

from unittest import mock
import unittest
import order


class TestPayStatues(unittest.TestCase):
    """单元测试用例"""

    @mock.patch("order.pay")
    def test_01(self, mock_pay):
        """测试支付成功场景"""
        # 方法一：mock 一个支付成功的数据
        # order.pay = mock.Mock(return_value={"result": "success", "reason":"null"})

        # 方法二：mock.path 装饰器模拟返回结果
        mock_pay.return_value = {"result": "success", "reason": "null"}
        # 根据支付结果测试页面跳转
        statues = order.pay_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    @mock.patch("order.pay")
    def test_02(self, mock_pay):
        """测试支付失败场景"""
        # mock 一个支付成功的数据

        mock_pay.return_value = {"result": "fail", "reason": "余额不足"}
        # 根据支付结果测试页面跳转
        statues = order.pay_statues()
        self.assertEqual(statues, "支付失败")


if __name__ == "__main__":
    unittest.main()

from unittest import TestCase
from unittest.mock import Mock


class TestExample(TestCase):
    def test_mock_method(self):
        # 创建一个 mock 对象
        mock_obj = Mock()

        # 设置返回值
        mock_obj.add.return_value = 10

        # 调用 mock 方法
        result = mock_obj.add(2, 3)

        # 验证结果
        self.assertEqual(result, 10)

        # 验证是否被调用过
        mock_obj.add.assert_called_once_with(2, 3)

类和方法案例

如果前面的 order.py 里面不是函数，是写的类和方法，如何去使用 mock?

order_class.py

class Payment:
    def pay(self):
        """假设这里是一个支付的功能，未开发完
        支付成功返回：{"result": "success", "reason":"null"}
        支付失败返回：{"result": "fail", "reason":"余额不足"}
        reason 返回失败原因
        """
        pass


class Statues:
    def pay_statues(self):

        """根据支付的结果 success or fail，判断跳转到对应页面"""
        result = Payment().pay()
        print(result)
        try:
            if result["result"] == "success":
                return "支付成功"
            elif result["result"] == "fail":
                print("失败原因：%s" % result["reason"])
                return "支付失败"
            else:
                return "未知错误异常"
        except:
            return "Error, 服务端返回异常！"

unitest_class_mock.py

from unittest import mock
import unittest
from order_class import Payment, Statues


class TestPayStatues(unittest.TestCase):
    """单元测试用例"""

    @mock.patch("order_class.Payment")
    def test_01(self, mock_payment):
        """测试支付成功场景"""
        payment_instance = mock_payment.return_value  # 先返回实例，对类名称替换
        # 通过实例调用方法，再对方法的返回值替换
        payment_instance.pay.return_value = {"result": "success", "reason": "null"}
        # 根据支付结果测试页面跳转
        statues = Statues().pay_statues()
        print(statues)
        self.assertEqual(statues, "支付成功")

    @mock.patch("order_class.Payment")
    def test_02(self, mock_payment):
        """测试支付失败场景"""
        payment_instance = mock_payment.return_value  # 先返回实例，对类名称替换
        # 通过实例调用方法，再对方法的返回值替换
        payment_instance.pay.return_value = {"result": "fail", "reason": "余额不足"}
        # 根据支付结果测试页面跳转
        statues = Statues().pay_statues()
        print(statues)
        self.assertEqual(statues, "支付失败")


if __name__ == "__main__":
    unittest.main()

附录

https://www.cnblogs.com/lisa2016/p/12069243.html