mock基本使用

什麼是mock?

mock在翻譯過來有模擬的意思。這裏要介紹的mock是輔助單元測試的一個模塊。它容許您用模擬對象替換您的系統的部分，並對它們已使用的方式進行斷言。

 

在Python2.x 中 mock是一個單獨模塊，須要單獨安裝。

> pip install -U mock

在Python3.x中，mock已經被集成到了unittest單元測試框架中，因此，能夠直接使用。

 

　　可能你和我初次接觸這個概念的時候會有這樣的疑問：把要測的東西都模擬掉了還測試什麼呢？

　　但在，實際生產中的項目是很是複雜的，對其進行單元測試的時候，會遇到如下問題：

• 接口的依賴
• 外部接口調用
• 測試環境很是複雜

　　單元測試應該只針對當前單元進行測試, 全部的內部或外部的依賴應該是穩定的, 已經在別處進行測試過的.使用mock 就能夠對外部依賴組件實現進行模擬而且替換掉, 從而使得單元測試將焦點只放在當前的單元功能。

 

 

簡單的例子                                                        

咱們先從最簡單例子開始。

modular.py

#modular.py

class Count():

    def add(self):
        pass

這裏要實現一個Count計算類，add() 方法要實現兩數相加。但，這個功能我尚未完成。這時就能夠藉助mock對其進行測試。

mock_demo01.py

from unittest import mock
import unittest

from modular import Count

# test Count class
class TestCount(unittest.TestCase):

    def test_add(self):
        count = Count()
        count.add = mock.Mock(return_value=13)
        result = count.add(8,5)
        self.assertEqual(result,13)


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

　　count = Count()

　　首先，調用被測試類Count() 。

 

　　count.add = mock.Mock(return_value=7)

　　經過Mock類模擬被調用的方法add()方法，return_value 定義add()方法的返回值。

 

　　result = count.add(2,5)

　　接下來，至關於在正常的調用add()方法，傳兩個參數2和5，而後會獲得相加的結果7。而後，7的結果是咱們在上一步就預先設定好的。

 

　　self.assertEqual(result,7)

　　最後，經過assertEqual()方法斷言，返回的結果是不是預期的結果7。

 　 運行測試結果：

> python3 mock_demo01.py
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

這樣一個用例就在mock的幫助下編寫完成，而且測試經過了。

 

 

完成功能測試                                                     

 　　再接下來完成module.py文件中add()方法。

#module.py

class Count():

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

　　而後，修改測試用例：

from unittest import mock
import unittest
from module import Count


class MockDemo(unittest.TestCase):

    def test_add(self):
        count = Count()
        count.add = mock.Mock(return_value=13, side_effect=count.add)
        result = count.add(8, 8)
        print(result)
        count.add.assert_called_with(8, 8)
        self.assertEqual(result, 16)

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

  　count.add = mock.Mock(return_value=13, side_effect=count.add)

　　side_effect參數和return_value是相反的。它給mock分配了可替換的結果，覆蓋了return_value。簡單的說，一個模擬工廠調用將返回side_effect值，而不是return_value。

　　因此，設置side_effect參數爲Count類add()方法，那麼return_value的做用失效。

 

　　result = count.add(8, 8)

　　print(result)

　　此次將會真正的調用add()方法，獲得的返回值爲16（8+8）。經過print打印結果。

 

　　assert_called_with(8,8)

　　檢查mock方法是否得到了正確的參數。

 

 

解決測試依賴                                                     

 　  前面的例子，只爲了讓你們對mock有個初步的印象。再接來，咱們看看如何mock方法的依賴。

　　例如，咱們要測試A模塊，而後A模塊依賴於B模塊的調用。可是，因爲B模塊的改變，致使了A模塊返回結果的改變，從而使A模塊的測試用例失敗。其實，對於A模塊，以及A模塊的用例來講，並無變化，不該該失敗纔對。

　　這個時候就是mock發揮做用的時候了。經過mock模擬掉影響A模塊的部分（B模塊）。至於mock掉的部分（B模塊）應該由其它用例來測試。

# function.py
def add_and_multiply(x, y):
    addition = x + y
    multiple = multiply(x, y)
    return (addition, multiple)


def multiply(x, y):
    return x * y

  　　而後，針對 add_and_multiply()函數編寫測試用例。func_test.py

import unittest
import function


class MyTestCase(unittest.TestCase):

    def test_add_and_multiply(self):
        x = 3
        y = 5
        addition, multiple = function.add_and_multiply(x, y)
        self.assertEqual(8, addition)
        self.assertEqual(15, multiple)


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

 運行結果：

>  python3 func_test.py
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

　　

　　目前運行一切正確常，然而，add_and_multiply()函數依賴了multiply()函數的返回值。若是這個時候修改multiply()函數的代碼。

……
def multiply(x, y):
    return x * y + 3

　　這個時候，multiply()函數返回的結果變成了x*y加3。

　　再次運行測試：

>  python3 func_test.py                                                   
F                                                                       
======================================================================  
FAIL: test_add_and_multiply (__main__.MyTestCase)                       
----------------------------------------------------------------------  
Traceback (most recent call last):                                      
  File "fun_test.py", line 19, in test_add_and_multiply                 
    self.assertEqual(15, multiple)                                      
AssertionError: 15 != 18                                                
                                                                        
----------------------------------------------------------------------  
Ran 1 test in 0.000s                                                    
                                                                        
FAILED (failures=1)   

　　測試用例運行失敗了，然而，add_and_multiply()函數以及它的測試用例並無作任何修改，罪魁禍首是multiply()函數引發的，咱們應該把 multiply()函數mock掉。

import unittest
from unittest.mock import patch
import function


class MyTestCase(unittest.TestCase):

    @patch("function.multiply")
    def test_add_and_multiply2(self, mock_multiply):
        x = 3
        y = 5
        mock_multiply.return_value = 15
        addition, multiple = function.add_and_multiply(x, y)
        mock_multiply.assert_called_once_with(3, 5)

        self.assertEqual(8, addition)
        self.assertEqual(15, multiple)


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

　　@patch("function.multiply")

　　patch()裝飾/上下文管理器能夠很容易地模擬類或對象在模塊測試。在測試過程當中，您指定的對象將被替換爲一個模擬（或其餘對象），並在測試結束時還原。

　　這裏模擬function.py文件中multiply()函數。

 

　　def test_add_and_multiply2(self, mock_multiply):

　　在定義測試用例中，將mock的multiply()函數（對象）重命名爲 mock_multiply對象。

 

　　mock_multiply.return_value = 15

　　設定mock_multiply對象的返回值爲固定的15。

 

　　ock_multiply.assert_called_once_with(3, 5)

　　檢查ock_multiply方法的參數是否正確。

 

　　再次，運行測試用例，經過！

 

 

本文摘自蟲師：https://www.cnblogs.com/fnng/p/5648247.html