Python 中 Mock 到底该怎么玩?一篇文章告诉你

开发 后端
微服务架构下,由于各类服务开发进度的不一致,导致联调工作经常会存在不确定性,进而导致项目延期,在实际工作中,为了保证项目进度,我们经常需要针对部分未完成模块及不稳定模块采用 Mock 方式,以验证已开发完的模块。 本篇文章将介绍 Python 实现 Mock 的几种常见方式

[[377066]]

本文转载自微信公众号「AirPython」,作者星安果 。转载本文请联系AirPython公众号。  

 1. 前言

微服务架构下,由于各类服务开发进度的不一致,导致联调工作经常会存在不确定性,进而导致项目延期

在实际工作中,为了保证项目进度,我们经常需要针对部分未完成模块及不稳定模块采用 Mock 方式,以验证已开发完的模块

本篇文章将介绍 Python 实现 Mock 的几种常见方式

2. Mock 介绍

Mock 测试:在测试验证过程中,对于那些尚未完成或不稳定的对象,用一个虚拟对象来替代,以便测试的测试方法

因此,这个虚拟的对象是 Mock 对象,Mock 对象是真实对象在调试期间的代替品

它的优势包含:

  • 前、后端并行开发
  • 模拟无法访问的资源
  • 隔离系统,避免脏数据干扰测试结果

3.1 mock

在 Python 3.3 之前使用 mock,需要先安装依赖

  1. # 安装mock依赖 
  2.  
  3. pip3 install mock 

项目地址:

https://github.com/testing-cabal/mock

假设 Product 类中有 2 个方法

  • get_product_status_by_id
  • buy_product

其中,get_product_status_by_id 方法还没有实现;buy_product 方法依赖于 get_product_status_by_id 方法的返回值

  1. # product_impl.py 
  2.  
  3. class Product(object): 
  4.  
  5.     def __init__(self): 
  6.         pass 
  7.  
  8.     def get_product_status_by_id(self, product_id): 
  9.         ""
  10.         通过商品id获取产品信息(Mock) 
  11.         :return
  12.         ""
  13.         # 待实现查询数据库的业务逻辑 
  14.         pass 
  15.  
  16.     def buy_product(self, product_id): 
  17.         ""
  18.         购买产品(真实逻辑) 
  19.         :return
  20.         ""
  21.         # 产品信息 
  22.         # {"id":1,"name":"苹果","num":23} 
  23.         product = self.get_product_status_by_id(product_id) 
  24.  
  25.         if product.get("num") >= 1: 
  26.             result = {"status": 0, "msg""购买成功!"
  27.         else
  28.             result = {"status": 1, "msg""购买失败,库存不足!"
  29.  
  30.         return result 

Mock 的步骤如下:

  • 导入使用 mock 中的 patch 方法
  • 作为测试方法的装饰器,对 get_product_status_by_id 方法进行 Mock,方法参数为 Mock 对象
  • 测试方法中,对该 Mock 对象设置一个返回值
  • 调用并断言
  1. from mock import patch 
  2. from mock_.product_impl import Product 
  3.  
  4. @patch('mock_.product_impl.Product.get_product_status_by_id'
  5. def test_succuse(mock_get_product_status_by_id): 
  6.     # Mock方法,指定一个返回值 
  7.     mock_get_product_status_by_id.return_value = {"id": 1, "name""苹果""num": 23} 
  8.  
  9.     product = Product() 
  10.  
  11.     assert product.buy_product(1).get("status") == 0 

需要注意的是,Mock 此方法的时候,必须制定该方法的完整路径

使用 @patch.object 同样能完成 Mock,不同的是,@patch.object 包含 2 个参数

第一个参数为该方法所在的类;第二个参数为方法名

  1. from mock import patch 
  2.  
  3. from mock_.product_impl import Product 
  4.  
  5. # Mock一个方法 
  6. # @patch.object:对象、方法名 
  7. @patch.object(Product, 'get_product_status_by_id'
  8. def test_succuse(mock_get_product_status_by_id): 
  9.     # Mock方法,指定一个返回值 
  10.     mock_get_product_status_by_id.return_value = {"id": 1, "name""苹果""num": 23} 
  11.  
  12.     product = Product() 
  13.  
  14.     assert product.buy_product(1).get("status") == 0 

3.2 unittest.mock

Python 3.3 之后,mock 作为标准库,已经内置到 unittest 中了

还是以 3.1 的场景为例,使用 unittest 编写一个测试用例

Mock 步骤如下:

  • 导入 unittest 框架中的 mock 文件
  • 实例化 Product 对象
  • mock.Mock(return_value=*) 方法
  • 对 get_product_status_by_id 方法进行 Mock
  • 调用并断言
  1. import unittest 
  2. from unittest import mock 
  3.  
  4. from unittest_mock.product_impl import Product 
  5.  
  6. class TestProduct(unittest.TestCase): 
  7.  
  8.     def test_success(self): 
  9.         # 成功结果 
  10.         mock_success_value = {"id": 1, "name""苹果""num": 23} 
  11.  
  12.         product = Product() 
  13.  
  14.         product.get_product_status_by_id = mock.Mock(return_value=mock_success_value) 
  15.  
  16.         # 调用实际函数 
  17.         assert product.buy_product(1).get("status") == 0 
  18.  
  19. if __name__ == "__main__"
  20.     unittest.main() 

3.3 pytest.mock

相比 unittest,pytest 由于强大的插件支持,用户群体可能更大!

如果项目本身使用的框架是 pytest,则 Mock 更建议使用 pytest-mock 这个插件

  1. # pytest依赖 
  2. pip3 install pytest 

Mock 步骤如下:

  • 使用 pytest 编写测试方法,参数为 mocker
  • 实例化 Product 对象
  • 使用 mocker.patch() 方法对 get_product_status_by_id 方法进行 Mock,并设置返回值
  • 调用并断言
  1. import pytest 
  2.  
  3. from pytest_mock_.product_impl import Product 
  4.  
  5. def test_buy_product_success(mocker): 
  6.     ""
  7.     购买成功Mock 
  8.     :param mocker: 
  9.     :return
  10.     ""
  11.     # 实例化一个产品对象 
  12.     product = Product() 
  13.  
  14.     # 对Product中的方法的返回值进行Mock 
  15.     mock_value = {"id": 1, "name""苹果""num": 23} 
  16.  
  17.     # Mock方法 
  18.     # 注意:需要指定方法的完整路径 
  19.     # mocker.patch 的第一个参数必须是模拟对象的具体路径,第二个参数用来指定返回值 
  20.     product.get_product_status_by_id = mocker.patch("product_impl.Product.get_product_status_by_id"
  21.                                                     return_value=mock_value) 
  22.  
  23.     # 调用购买产品的方法 
  24.     result = product.buy_product(1) 
  25.  
  26.     assert result.get("status") == 0 

需要注意的是,mocker.patch 方法第一个参数必须是 Mock 对象的完整路径

4. 最后

文中对 Python 中常见的 Mock 方案进行了讲解,实际应用中,建议根据项目实际情况进行选型

 

责任编辑:武晓燕 来源: AirPython
相关推荐

2022-02-18 00:13:53

JavaScript编程语言数组

2021-11-04 10:34:02

JavaScript继承编程

2019-07-28 20:15:07

2019-08-13 09:00:01

内网外网通信

2023-11-01 15:52:35

2019-10-17 19:15:22

jQueryJavaScript前端

2021-02-19 19:35:53

SVG 形状元素

2023-06-21 00:10:17

JSONWeb服务器JavaScript

2021-11-10 09:19:41

PythonShutil模块

2021-05-15 09:18:04

Python进程

2021-05-18 09:00:28

Pythonclass

2021-11-17 10:11:08

PythonLogging模块

2020-10-09 08:15:11

JsBridge

2021-02-24 10:14:04

PythonClassPython基础

2020-11-13 08:14:28

JavaScript

2019-09-24 14:19:12

PythonC语言文章

2021-12-28 09:27:45

Javascript 高阶函数前端

2019-02-26 15:22:14

MySQL命令数据库

2020-05-29 10:23:19

Kubernetes容器开发
点赞
收藏

51CTO技术栈公众号