Jak używać Python’owej biblioteki Mock #1: Podstawy

pip install mock

import unittest.mock

def s_method():
    return False
 
class TestObject:

    @staticmethod
    def testmethod():
        if s_method():
            return True
        return False

def test_mock():
    assert TestObject().test_method()

____________________________________________________________ test_mock ____________________________________________________________
 
 
def test_mock():
> assert TestObject().testmethod()
E assert False
E + where False = >()
E + where > = <test_example.TestObjec
t object at 0x04209808>.testmethod
E + where = TestObject()
 
 
test_example.py:17: AssertionError
================================================= 1 failed, 1 deselected in 0.20s =================================================

from unittest.mock import patch, MagicMock
 
 
@patch.object(TestObject, 'testmethod', MagicMock(return_value=True))
def test_mock():
    assert TestObject().testmethod()
 

Jak używać Python’owej biblioteki Mock #1 instalacja
Poziom trudności
2/5
Podczas pisania unit testów (choć może i nie tylko), są metody, które obsługują pliki czy bazy danych, które nie są obiektem testów, ale wpływają na rzeczy testowane. Unikamy przecież tworzenia „przykładowych” plików czy przykładowych ograniczonych baz danych, które prócz testów też potrzebują utrzymania. W dobie feke news’ów można też używać fake obiektów. Biblioteka Mock może w czasie rzeczywistym, symulować działanie dowolnego obiektu, co może bardzo ułatwić testowanie w pyTest’cie.

Instalacja
Mock jest ogólnodostępną biblioteką, więc można ją zainstalować przy użyciu komendy pip install:

pip install mock
W pliku, w którym będzie używany obiektu Mock, importujemy bibliotekę w poniższy sposób:

import unittest.mock
Przygotowanie
Przed rozpoczęciem dodawania Mock’a do testów stworzymy klasę TestObject, i metodę s_method wpływającą na jej działanie, którą magicznie obsłużymy w testach. 

def s_method():
    return False
 
 
class TestObject:
 
 
    @staticmethod
    def testmethod():
        if s_method():
            return True
        return False
Tylko zbyt głośno się nie śmiej, widząc tę klasę. Ale spokojnie, tworzę tak prosty kod w tym przypadku nie bez powodu. Chcę pokazać w jak najklarowniejszy sposób jak używać Mocka. W teście, który teraz zostanie napisany, oczekiwać będziemy, że testmethod zwróci nam True, pomimo że jest zależna od metody s_method.

def test_mock():
    assert TestObject().test_method()
Wynik jest mocno niezadowalający. Nie chcemy testować s_method samej w sobie, gdyż interesuje nas, tylko to co wydarzy się, jeśli metoda ta będzie równa True. Jednak jak na razie ta ścieżka jest dla nas niedostępna:

____________________________________________________________ test_mock ____________________________________________________________
 
 
def test_mock():
> assert TestObject().testmethod()
E assert False
E + where False = >()
E + where > = <test_example.TestObjec
t object at 0x04209808>.testmethod
E + where = TestObject()
 
 
test_example.py:17: AssertionError
================================================= 1 failed, 1 deselected in 0.20s =================================================
Rozwiązanie problemu
I można by pomyśleć, że to sytuacja bez wyjścia, bo cóż poradzisz, skoro te wartości są wręcz „zahardcodowane„. Poniżej bardzo proste rozwiązanie problemu:

from unittest.mock import patch, MagicMock
 
 
@patch.object(TestObject, 'testmethod', MagicMock(return_value=True))
def test_mock():
    assert TestObject().testmethod()
 
======================================================= test session starts =======================================================
platform win32 -- Python 3.8.1, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
rootdir: D:\test_delete\unit_tests
plugins: cov-2.8.1
collected 2 items / 1 deselected / 1 selected
 
 
test_example.py . [100%]
 
 
================================================= 1 passed, 1 deselected in 0.17s =================================================