Pythonのunittestフレームワークには、テストで外部リソースや他のモジュールとの依存を排除する手段として、モックオブジェクトとパッチが存在します。この記事では、モックオブジェクトとパッチの基本的な使い方から応用例まで、具体的なコードとその解説を交えて詳しく説明します。
目次
モックオブジェクトとは
モックオブジェクトは、テストで特定のオブジェクトやメソッドを置き換えるためのオブジェクトです。これにより、外部リソースや他のモジュールとの依存を排除し、テストをより効率的に行えます。
基本的な使用方法
Pythonのunittestモジュールでモックオブジェクトを使用する基本的なコードは以下の通りです。
from unittest import TestCase, mock
class TestExample(TestCase):
def test_something(self):
with mock.patch('target_module.target_function') as mock_func:
mock_func.return_value = "Hello"
# ここでtarget_functionが呼ばれると"Hello"が返る
self.assertEqual(target_module.target_function(), "Hello")
パッチとは
パッチ（patch）は、特定のオブジェクトや関数を一時的に置き換える手法です。これもテストで頻繁に使用されます。
基本的な使用方法
パッチの基本的な使用方法は、モックオブジェクトと非常に似ています。
from unittest import TestCase, mock
class TestExample(TestCase):
@mock.patch('target_module.target_function')
def test_something(self, mock_func):
mock_func.return_value = "Hello"
# target_functionが呼ばれると"Hello"が返る
self.assertEqual(target_module.target_function(), "Hello")
応用例1: 複数のパッチを使用する
一つのテスト内で複数のパッチを使用する方法です。
from unittest import TestCase, mock
class TestExample(TestCase):
@mock.patch('module1.func1')
@mock.patch('module2.func2')
def test_multiple_patches(self, mock_func1, mock_func2):
mock_func1.return_value = "Hello1"
mock_func2.return_value = "Hello2"
# func1とfunc2がそれぞれ置き換えられる
self.assertEqual(module1.func1(), "Hello1")
self.assertEqual(module2.func2(), "Hello2")
応用例2: モックオブジェクトで例外を発生させる
モックオブジェクトを使って特定の関数が例外を発生させるテストケースを書く方法です。
from unittest import TestCase, mock
class TestExample(TestCase):
def test_exception_with_mock(self):
with mock.patch('target_module.target_function') as mock_func:
mock_func.side_effect = Exception("Something went wrong")
# target_functionが呼ばれると例外が発生する
with self.assertRaises(Exception):
target_module.target_function()
まとめ
Pythonのunittestフレームワークにおけるモックオブジェクトとパッチは、テストをより柔軟かつ効率的に行う強力なツールです。基本的な使い方から応用例まで、多様なケースでの利用が可能です。特に、外部リソースへの依存を排除したい場合や、複数のメソッドやオブジェクトを同時にテストしたい場合に非常に有用です。
コメント