Python 中 Mock 到底該怎么玩？一篇文章告訴你（超全）

1. 前言

微服務(wù)架構(gòu)下，由于各類服務(wù)開發(fā)進(jìn)度的不一致，導(dǎo)致聯(lián)調(diào)工作經(jīng)常會存在不確定性，進(jìn)而導(dǎo)致項(xiàng)目延期

在實(shí)際工作中，為了保證項(xiàng)目進(jìn)度，我們經(jīng)常需要針對部分未完成模塊及不穩(wěn)定模塊采用 Mock 方式，以驗(yàn)證已開發(fā)完的模塊

本篇文章將介紹 Python 實(shí)現(xiàn) Mock 的幾種常見方式

2. Mock 介紹

Mock 測試：在測試驗(yàn)證過程中，對于那些尚未完成或不穩(wěn)定的對象，用一個(gè)虛擬對象來替代，以便測試的測試方法

因此，這個(gè)虛擬的對象是 Mock 對象，Mock 對象是真實(shí)對象在調(diào)試期間的代替品

它的優(yōu)勢包含：

• 前、后端并行開發(fā)

• 模擬無法訪問的資源

• 隔離系統(tǒng)，避免臟數(shù)據(jù)干擾測試結(jié)果
  

3.1 mock

在 Python 3.3 之前使用 mock，需要先安裝依賴

# 安裝mock依賴
pip3 install mock

項(xiàng)目地址：

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

假設(shè) Product 類中有 2 個(gè)方法

• get_product_status_by_id

• buy_product

其中，get_product_status_by_id 方法還沒有實(shí)現(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獲取產(chǎn)品信息（Mock）
        :return:
        """
        # 待實(shí)現(xiàn)查詢數(shù)據(jù)庫的業(yè)務(wù)邏輯
        pass

    def buy_product(self, product_id):
        """
        購買產(chǎn)品（真實(shí)邏輯）
        :return:
        """
        # 產(chǎn)品信息
        # {"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 result

Mock 的步驟如下：

導(dǎo)入使用 mock 中的 patch 方法
作為測試方法的裝飾器，對 get_product_status_by_id 方法進(jìn)行 Mock，方法參數(shù)為 Mock 對象
測試方法中，對該 Mock 對象設(shè)置一個(gè)返回值
調(diào)用并斷言
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方法，指定一個(gè)返回值
    mock_get_product_status_by_id.return_value = {"id": 1, "name": "蘋果", "num": 23}

    product = Product()

    assert product.buy_product(1).get("status") == 0
需要注意的是，Mock 此方法的時(shí)候，必須制定該方法的完整路徑
使用 @patch.object 同樣能完成 Mock，不同的是，@patch.object 包含 2 個(gè)參數(shù)
第一個(gè)參數(shù)為該方法所在的類；第二個(gè)參數(shù)為方法名
from mock import patch

from mock_.product_impl import Product

# Mock一個(gè)方法
# @patch.object：對象、方法名
@patch.object(Product, 'get_product_status_by_id')
def test_succuse(mock_get_product_status_by_id):
    # Mock方法，指定一個(gè)返回值
    mock_get_product_status_by_id.return_value = {"id": 1, "name": "蘋果", "num": 23}

    product = Product()

    assert product.buy_product(1).get("status") == 0

3.2 unittest.mock

Python 3.3 之后，mock 作為標(biāo)準(zhǔn)庫，已經(jīng)內(nèi)置到 unittest 中了

還是以 3.1 的場景為例，使用 unittest 編寫一個(gè)測試用例

Mock 步驟如下：

• 導(dǎo)入 unittest 框架中的 mock 文件

• 實(shí)例化 Product 對象

• mock.Mock(return_value=*) 方法

  對 get_product_status_by_id 方法進(jìn)行 Mock

• 調(diào)用并斷言

import unittest
from unittest import mock

from unittest_mock.product_impl import Product

class TestProduct(unittest.TestCase):

    def test_success(self):
        # 成功結(jié)果
        mock_success_value = {"id": 1, "name": "蘋果", "num": 23}

        product = Product()

        product.get_product_status_by_id = mock.Mock(return_value=mock_success_value)

        # 調(diào)用實(shí)際函數(shù)
        assert product.buy_product(1).get("status") == 0

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

3.3 pytest.mock

相比 unittest，pytest 由于強(qiáng)大的插件支持，用戶群體可能更大！

如果項(xiàng)目本身使用的框架是 pytest，則 Mock 更建議使用 pytest-mock 這個(gè)插件

# pytest依賴
pip3 install pytest

Mock 步驟如下：

• 使用 pytest 編寫測試方法，參數(shù)為 mocker

• 實(shí)例化 Product 對象

• 使用 mocker.patch() 方法對 get_product_status_by_id 方法進(jìn)行 Mock，并設(shè)置返回值

• 調(diào)用并斷言

import pytest

from pytest_mock_.product_impl import Product

def test_buy_product_success(mocker):
    """
    購買成功Mock
    :param mocker:
    :return:
    """
    # 實(shí)例化一個(gè)產(chǎn)品對象
    product = Product()

    # 對Product中的方法的返回值進(jìn)行Mock
    mock_value = {"id": 1, "name": "蘋果", "num": 23}

    # Mock方法
    # 注意：需要指定方法的完整路徑
    # mocker.patch 的第一個(gè)參數(shù)必須是模擬對象的具體路徑，第二個(gè)參數(shù)用來指定返回值
    product.get_product_status_by_id = mocker.patch("product_impl.Product.get_product_status_by_id",
                                                    return_value=mock_value)

    # 調(diào)用購買產(chǎn)品的方法
    result = product.buy_product(1)

    assert result.get("status") == 0

需要注意的是，mocker.patch 方法第一個(gè)參數(shù)必須是 Mock 對象的完整路徑

4. 最后

文中對 Python 中常見的 Mock 方案進(jìn)行了講解，實(shí)際應(yīng)用中，建議根據(jù)項(xiàng)目實(shí)際情況進(jìn)行選型