python之mock模塊基本使用方法詳解

轉自：https://www.jb51.net/article/164055.htm

mock簡介

mock原是python的第三方庫。python3以后mock模塊已經整合到了unittest測試框架中，不用再單獨安裝。Mock這個詞在英語中有模擬的意思，因此我們可以猜測出這個庫的主要功能是模擬一些東西。准確的說，Mock是Python中一個用於支持單元測試的庫，它的主要功能是使用mock對象替代掉指定的Python對象，以達到模擬對象的行為既然mock已經被整合到了unittest單元測試框架中，可想而知mock的目的就是為了讓我們更好的進行測試

mock作用

1. 解決依賴問題：當我們測試一個接口或者功能模塊的時候，如果這個接口或者功能模塊依賴其他接口或其他模塊，那么如果所依賴的接口或功能模塊未開發完畢，那么我們就可以使用mock模擬被依賴接口，完成目標接口的測試

2. 單元測試：如果某個功能未開發完成，我們又要進行測試用例的代碼編寫，我們也可以先模擬這個功能進行測試

3. 模擬復雜業務的接口：實際工作中如果我們在測試一個接口功能時，如果這個接口依賴一個非常復雜的接口業務，那么我們完全可以使用mock來模擬這個復雜的業務接口，其實這個和解決接口依賴是一樣的原理

4.前后端聯調：如果你是一個前端頁面開發，現在需要開發一個功能：根據后台返回的狀態展示不同的頁面，那么你就需要調用后台的接口，但是后台接口還未開發完成，是不是你就停止這部分工作呢？答案是否定的，你完全可以借助mock來模擬后台這個接口返回你想要的數據

mock安裝

python 3 的mock模塊已經被整合到了unittest框架中，所以你使用的時候只需要在文件開頭from unittest import mock 導入即可。如果你使用的是python2 那么你需要執行pip install mock安裝后再 import mock即可

mock實例

一個未開發完成的功能如何測試？

假如們現在有一個實現兩個數相加的功能需要編寫測試用例，但是由於開發進度緩慢，只搭兩個簡單的框架，並沒有內部實現

import unittest
from unittest import mock

class SubClass:
    def add(self,a,b):
　　　　#假設功能代碼還沒有實現
        pass

class TestSub(unittest.TestCase):
    def test_sub(self):
        sub=SubClass()
        sub.add = mock.Mock(return_value=10)
        result = sub.add(12,23)
        self.assertEqual(result,10)

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

 測試結果：

 

.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
Process finished with exit code

 

 實際上mock模擬add方法的原理是，使用相同的對象方法接收mock的對象(使用sub.add接收)，那么當mock對象被調用時(sub.add())就會返回return_value參數對應的數據

我們用例編寫完了，而且開發既然也把功能開發完了，既然真實的功能已經可以測試了，那么我們怎么在上面用例的基礎上直接測試真實功能呢？

完整的功能如何測試？

我們把用例的代碼稍做修改

import unittest
from unittest import mock

class SubClass:
    def add(self,a,b):
        return a+b


class TestSub(unittest.TestCase):
    def test_sub(self):
        sub=SubClass()
        sub.add = mock.Mock(return_value=10, side_effect=sub.add)
        result = sub.add(12,23)
        self.assertEqual(result,35)

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

 side_effect參數

代碼中我們給Mock方法添加了另一個關鍵字參數side_effect = sub.add， 這個參數和return_value 正好相反，當傳遞這個參數的時候return_value 參數就會失效，而side_effect生效。這里我給的參數值是sub.add 相當於add方法的地址，那么當調用add方法時就會真實的使用add方法，也就達到了我們測試實際的add 方法。

你也可以理解為當傳遞了side_effect參數且值為被測方法地址時，mock就不會起作用。side_effect接收的是一個可迭代序列，當傳遞多個值時，那么每次調用mock時會返回不同的值

存在依賴關系的功能如何測試？

假設有這樣一個場景：我們要測試一個支付接口但是這個支付接口又依賴一個第三方支付接口，那么第三方支付接口我們暫時沒有權限使用，那么我們該如何測試我們自己這個接口呢？

看下面的實例，假設第三方接口和我們自己的支付接口如下：

import requests

class PayApi:
    
    @staticmethod
    def auth(card, amount):
        """
        第三方支付接口
        :param card: 卡號
        :param amount: 支付金額
        :return:
        """
        pay_url = "http://www.zhifubao.com" # 第三方支付接口地址
        data = {"card": card, "amount": amount}
        response = requests.post(pay_url, data=data) # 請求第三方支付接口
        return response # 返回狀態碼
    
    def pay(self, user_id, card, amount):
        """
        我們自己的支付接口
        :param user_id: 用戶id
        :param card: 卡號
        :param amount: 支付金額
        :return:
        """
    　# 調用第三方支付接口
        response = self.auth(card, amount)
        try:
            if response['status_code'] == '200':
                print('用戶{}支付金額{}成功'.format(user_id, amount))
                return '支付成功'
            elif response['status_code'] == '500':
                print('用戶{}支付失敗, 金額不變'.format(user_id))
                return '支付失敗'
            else:
                return '未知錯誤'
        except Exception:
            return "Error, 服務器異常!"
    
if __name__ == '__main__':
    pass

 很明顯第三方支付接口是無法訪問的，因為接口的地址是我DIY的，為了模擬實際中我們無法使用的第三方支付接口編寫測試用例

import unittest
from unittest import mock
from payment.PayMent import PayApi

class TestPayApi(unittest.TestCase):
    def test_success(self):
        pay = PayApi()
        pay.auth = mock.Mock(return_value={'status_code':'200'})
        status = pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '支付成功')
        
    def test_fail(self):
        pay = PayApi()
        pay.auth = mock.Mock(return_value={'status_code':'500'})
        status = pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '支付失敗')
        
    def test_error(self):
        pay = PayApi()
        pay.auth = mock.Mock(return_value={'status_code':'300'})
        status = pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '未知錯誤')
        
    def test_exception(self):
        pay = PayApi()
        pay.auth = mock.Mock(return_value='200')
        status = pay.pay('1000', '12345', '10000')
        self.assertEqual(status, 'Error, 服務器異常!')

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

 測試輸出結果：

....用戶1000支付失敗, 金額不變
用戶1000支付金額10000成功
----------------------------------------------------------------------
Ran 4 tests in 0.001s
OK
Process finished with exit code 0

 從執行結果可以看出，即使第三方支付接口無法使用，但是我們自己的支付接口仍然測試通過了。也許有人會問，第三方支付都不能用，我們的測試結果是否是有效的呢？

通常我們在測試一個模塊的時候，我們是可以認為其他模塊的功能是正常的，只針對目標模塊進行測試是沒有任何問題的，所以說測試結果也是正確的，其實上述代碼還可以使用另一種方式來寫

import unittest
from unittest import mock
from unittest.mock import patch
from payment.PayMent import PayApi

class TestPayApi(unittest.TestCase):
    def setUp(self):
        self.pay = PayApi()
        
    @patch.object(PayApi, 'auth')
    def test_success(self, mock_auth):
        mock_auth.return_value = {'status_code':'200'}
        status = self.pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '支付成功')
        
    @patch.object(PayApi, 'auth')
    def test_fail(self, mock_auth):
        mock_auth.return_value={'status_code':'500'}
        status = self.pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '支付失敗')
        
    @patch.object(PayApi, 'auth')
    def test_error(self, mock_auth):
        mock_auth.return_value={'status_code':'300'}
        status = self.pay.pay('1000', '12345', '10000')
        self.assertEqual(status, '未知錯誤')
        
    @patch.object(PayApi, 'auth')
    def test_exception(self, mock_auth):
        mock_auth.return_value='200'
        status = self.pay.pay('1000', '12345', '10000')
        self.assertEqual(status, 'Error, 服務器異常!')

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

 還有mock一個普通函數，mock多個方法等，這里先不贅述，寫法和上面實例差不多

最后

mock還有很多自帶的功能方法且mock功能很強大，也不是一句兩句話就能說完了，本篇文章主要介紹了mock的基本使用方法，甚是簡單，對於實際中如何應用，如何掌握更強大的方法還需自己慢慢摸索