【Python】unittes,pytestのpatch,monkeypatchの使い方

Copy
.
|-- app
|   |-- __init__.py
|   |-- class_module.py
|   `-- execute_module.py
|   
`-- tests
    |-- __init__.py
    |-- test_execute_module_monkeypatch_class.py
    |-- test_execute_module_monkeypatch_class2.py
    |-- test_execute_module_monkeypatch_fanc.py
    |-- test_execute_module_monkeypatch_fanc2.py
    |-- test_execute_module_patch.py
    `-- test_execute_module_patch_object.py

Copy
from app.class_module import SampleClass

class ExecuteClass:
    def __init__(self):
        self.sample_class = SampleClass(param1='1', param2='2', param3='3')

    def callParam1(self):
        return self.sample_class.getParam1()

    def callParam2(self):
        return self.sample_class.getParam2()

if __name__ == "__main__":
    execute_instance = ExecuteClass()
    print(execute_instance.callParam1())
    print(execute_instance.callParam2())

# 実行結果
# SampleClassのparam1は「1」です
# SampleClassのparam2は「2」です

Copy
class SampleClass:
    def __init__(self,param1=None, param2=None, param3=None):
        self.param1 = param1
        self.param2 = param2
        self.param3 = param3

    def getParam1(self):
        return f'SampleClassのparam1は「{self.param1}」です'

    def getParam2(self):
        return f'SampleClassのparam2は「{self.param2}」です'

Copy
import unittest

from unittest.mock import patch

# テスト対象のクラス
from app.execute_module import ExecuteClass

# テスト対象のExecuteClassクラス内で呼ばれるSampleClassクラスをmockにする
@patch('app.execute_module.SampleClass')    
class TestSampleClass(unittest.TestCase):

    def test_callParam1(self, mock_sample_class):
        # mockインスタンスを取得
        mock_instance = mock_sample_class.return_value
        # mockのメソッドを定義
        mock_instance.getParam1.return_value = "param1"

        # test実行
        execute_instance = ExecuteClass()
        result = execute_instance.callParam1()

        # callNameの戻り値が期待通りのものであるかをアサート
        assert result == "param1"

    def test_callParam2(self, mock_sample_class):
        # mockインスタンスを取得
        mock_instance = mock_sample_class.return_value
        # mockのメソッドを定義
        mock_instance.getParam2.return_value = "param2"

        # test実行
        execute_instance = ExecuteClass()
        result = execute_instance.callParam2()

        # callNameの戻り値が期待通りのものであるかをアサート
        assert result == "param2"

Copy
# テスト対象のExecuteClassクラス内で呼ばれるSampleClassクラスをmockにする
@patch('app.execute_module.SampleClass')    
class TestSampleClass(unittest.TestCase):
...

Copy
...
    def test_callParam1(self, mock_sample_class):
        # mockインスタンスを取得
        mock_instance = mock_sample_class.return_value
        # mockのメソッドを定義
        mock_instance.getParam1.return_value = "param1"

        # test実行
        execute_instance = ExecuteClass()
        result = execute_instance.callParam1()

        # callNameの戻り値が期待通りのものであるかをアサート
        assert result == "param1"
...

Copy
import unittest

from unittest.mock import patch

# テスト対象のクラス
from app.execute_module import ExecuteClass
from app.class_module import SampleClass

class TestSampleClass(unittest.TestCase):

    # テスト関数
    @patch.object(SampleClass, 'getParam1')
    def test_callParam1(self, mock_sample_class_getParam1):
        # getParam1の戻り値を指定
        mock_sample_class_getParam1.return_value = "param1"

        # test実行
        execute_instance = ExecuteClass()
        result = execute_instance.callParam1()

        # callNameの戻り値が期待通りのものであるかをアサート
        assert result == "param1"

    @patch.object(SampleClass, 'getParam2')
    def test_callParam2(self, mock_sample_class_getParam2):
        # getParam2の戻り値を指定
        mock_sample_class_getParam2.return_value = "param2"

        # test実行
        execute_instance = ExecuteClass()
        result = execute_instance.callParam2()

        # callNameの戻り値が期待通りのものであるかをアサート
        assert result == "param2"

Copy
import pytest
from unittest.mock import MagicMock

# テスト対象のクラス
from app.execute_module import ExecuteClass

@pytest.fixture
def mock_sample_class(monkeypatch):
    # インスタンスのモックを作成
    mock_sample_class_instance = MagicMock()
    # メソッドの戻り値を設定
    mock_sample_class_instance.getParam1.return_value = "param1"
    mock_sample_class_instance.getParam2.return_value = "param2"

    # クラスのモックを生成
    mock_sample_class = MagicMock()
    # クラスのモックが呼ばれた場合にインスタンスモックが返るようにする
    mock_sample_class.return_value=mock_sample_class_instance

    # SampleClassをクラスモックに置き換える
    monkeypatch.setattr('app.execute_module.SampleClass', mock_sample_class)

class TestSampleClass:
    def test_callParam1(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam1を呼び出し、結果を取得
        result = execute_instance.callParam1()
        # 戻り値をアサート
        assert result == "param1"

    def test_callParam2(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam2を呼び出し、結果を取得
        result = execute_instance.callParam2()
        # 戻り値をアサート
        assert result == "param2"

Copy
import pytest
from unittest.mock import MagicMock

# テスト対象のクラス
from app.execute_module import ExecuteClass

@pytest.fixture
def mock_sample_class(monkeypatch):

    # インスタンスモックの生成
    mock_sample_class_instance  = MagicMock()
    mock_sample_class_instance.getParam1.return_value = "param1"
    mock_sample_class_instance.getParam2.return_value = "param2"

    # init処理を定義（引数の数は元のinit処理と同じにする）
    def mock_init(self):
        self.sample_class = mock_sample_class_instance

    # ExecuteClassのinit処理を置き換えて,インスタンスモックを返すようにする
    monkeypatch.setattr(ExecuteClass, '__init__', mock_init)

class TestSampleClass:
    def test_callParam1(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam1を呼び出し、結果を取得
        result = execute_instance.callParam1()
        # 戻り値をアサート
        assert result == "param1"

    def test_callParam2(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam2を呼び出し、結果を取得
        result = execute_instance.callParam2()
        # 戻り値をアサート
        assert result == "param2"

Copy
import pytest

# テスト対象のクラス
from app.execute_module import ExecuteClass
from app.class_module import SampleClass

class TestSampleClass:
    def test_callParam1(self, monkeypatch):
        # 関数をモック化
        monkeypatch.setattr(SampleClass, "getParam1", lambda self: "param1")
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam1を呼び出し、結果を取得
        result = execute_instance.callParam1()
        # 戻り値をアサート
        assert result == "param1"

    def test_callParam2(self, monkeypatch):
        # 関数をモック化
        monkeypatch.setattr(SampleClass, "getParam2", lambda self: "param2")
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam2を呼び出し、結果を取得
        result = execute_instance.callParam2()
        # 戻り値をアサート
        assert result == "param2"

Copy
import pytest

# テスト対象のクラス
from app.execute_module import ExecuteClass

# モック化するクラス
from app.class_module import SampleClass

@pytest.fixture
def mock_sample_class(monkeypatch):

    # 関数定義
    # 元の関数getParam1と同じ数の引数を設定する必要がある
    def mock_func(*args, **kwargs):
        return 'param1'

    # SampleClassのgetParam1をmock_funcに置き換え
    monkeypatch.setattr(SampleClass, 'getParam1', mock_func)

    # パスを指定することもできる。またラムダも使える
    # こちらも元の関数getParam2と同じ数の引数を設定する必要がある
    monkeypatch.setattr('app.class_module.SampleClass.getParam2', lambda self :'param2')

class TestSampleClass:
    def test_callParam1(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam1を呼び出し、結果を取得
        result = execute_instance.callParam1()
        # 戻り値をアサート
        assert result == "param1"

    def test_callParam2(self, mock_sample_class):
        # ExecuteClassのインスタンスを作成
        execute_instance = ExecuteClass()
        # callParam2を呼び出し、結果を取得
        result = execute_instance.callParam2()
        # 戻り値をアサート
        assert result == "param2"