1. 程式人生 > 其它 >python mock基本使用(轉載)

python 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方法的引數是否正確。

  再次,執行測試用例,通過!