Python 中 Mock 到底該怎么玩?一篇文章告訴你(超全)

1. 前言
微服務架構下,由于各類服務開發(fā)進度的不一致,導致聯(lián)調工作經常會存在不確定性,進而導致項目延期
在實際工作中,為了保證項目進度,我們經常需要針對部分未完成模塊及不穩(wěn)定模塊采用 Mock 方式,以驗證已開發(fā)完的模塊
本篇文章將介紹 Python 實現(xiàn) Mock 的幾種常見方式
2. Mock 介紹
Mock 測試:在測試驗證過程中,對于那些尚未完成或不穩(wěn)定的對象,用一個虛擬對象來替代,以便測試的測試方法
因此,這個虛擬的對象是 Mock 對象,Mock 對象是真實對象在調試期間的代替品
它的優(yōu)勢包含:
前、后端并行開發(fā)
模擬無法訪問的資源
隔離系統(tǒng),避免臟數(shù)據(jù)干擾測試結果
3.1 mock
在 Python 3.3 之前使用 mock,需要先安裝依賴
# 安裝mock依賴
pip3 install mock
項目地址:
https://github.com/testing-cabal/mock
假設 Product 類中有 2 個方法
get_product_status_by_id
buy_product
其中,get_product_status_by_id 方法還沒有實現(xiàn);buy_product 方法依賴于 get_product_status_by_id 方法的返回值
# product_impl.py
class Product(object):
def __init__(self):
pass
def get_product_status_by_id(self, product_id):
"""
通過商品id獲取產品信息(Mock)
:return:
"""
# 待實現(xiàn)查詢數(shù)據(jù)庫的業(yè)務邏輯
pass
def buy_product(self, product_id):
"""
購買產品(真實邏輯)
:return:
"""
# 產品信息
# {"id":1,"name":"蘋果","num":23}
product = self.get_product_status_by_id(product_id)
if product.get("num") >= 1:
result = {"status": 0, "msg": "購買成功!"}
else:
result = {"status": 1, "msg": "購買失敗,庫存不足!"}
return resultMock 的步驟如下:
導入使用 mock 中的 patch 方法
作為測試方法的裝飾器,對 get_product_status_by_id 方法進行 Mock,方法參數(shù)為 Mock 對象
測試方法中,對該 Mock 對象設置一個返回值
調用并斷言
from mock import patch
from mock_.product_impl import Product
@patch('mock_.product_impl.Product.get_product_status_by_id')
def test_succuse(mock_get_product_status_by_id):
# Mock方法,指定一個返回值
mock_get_product_status_by_id.return_value = {"id": 1, "name": "蘋果", "num": 23}
product = Product()
assert product.buy_product(1).get("status") == 0
需要注意的是,Mock 此方法的時候,必須制定該方法的完整路徑
使用 @patch.object 同樣能完成 Mock,不同的是,@patch.object 包含 2 個參數(shù)
第一個參數(shù)為該方法所在的類;第二個參數(shù)為方法名
from mock import patch
from mock_.product_impl import Product
# Mock一個方法
# @patch.object:對象、方法名
@patch.object(Product, 'get_product_status_by_id')
def test_succuse(mock_get_product_status_by_id):
# Mock方法,指定一個返回值
mock_get_product_status_by_id.return_value = {"id": 1, "name": "蘋果", "num": 23}
product = Product()
assert product.buy_product(1).get("status") == 03.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
調用并斷言
import unittest
from unittest import mock
from unittest_mock.product_impl import Product
class TestProduct(unittest.TestCase):
def test_success(self):
# 成功結果
mock_success_value = {"id": 1, "name": "蘋果", "num": 23}
product = Product()
product.get_product_status_by_id = mock.Mock(return_value=mock_success_value)
# 調用實際函數(shù)
assert product.buy_product(1).get("status") == 0
if __name__ == "__main__":
unittest.main()3.3 pytest.mock
相比 unittest,pytest 由于強大的插件支持,用戶群體可能更大!
如果項目本身使用的框架是 pytest,則 Mock 更建議使用 pytest-mock 這個插件
# pytest依賴
pip3 install pytest
Mock 步驟如下:
使用 pytest 編寫測試方法,參數(shù)為 mocker
實例化 Product 對象
使用 mocker.patch() 方法對 get_product_status_by_id 方法進行 Mock,并設置返回值
調用并斷言
import pytest
from pytest_mock_.product_impl import Product
def test_buy_product_success(mocker):
"""
購買成功Mock
:param mocker:
:return:
"""
# 實例化一個產品對象
product = Product()
# 對Product中的方法的返回值進行Mock
mock_value = {"id": 1, "name": "蘋果", "num": 23}
# Mock方法
# 注意:需要指定方法的完整路徑
# mocker.patch 的第一個參數(shù)必須是模擬對象的具體路徑,第二個參數(shù)用來指定返回值
product.get_product_status_by_id = mocker.patch("product_impl.Product.get_product_status_by_id",
return_value=mock_value)
# 調用購買產品的方法
result = product.buy_product(1)
assert result.get("status") == 0
需要注意的是,mocker.patch 方法第一個參數(shù)必須是 Mock 對象的完整路徑
4. 最后
文中對 Python 中常見的 Mock 方案進行了講解,實際應用中,建議根據(jù)項目實際情況進行選型。
---------- END ----------
