Mockを使ったユニットテスト：外部依存を持つコードの効果的なテスト方法

ユニットテストは、コードの品質を保証する上で非常に重要です。
しかし、外部依存を持つコードをテストする場合、テストの再現性や安定性が損なわれる可能性があります。

実際の外部システムを用いて、容易にはテストをできませんよね。
この問題を解決するために、Mockオブジェクトを使用したテスト手法が有効です。

本記事では、Mockを使用したユニットテストの方法について、具体的なコード例を交えて解説します。
外部依存を持つコードをどのようにテストするか、そしてMockの使用によってどのような利点があるかを見ていきましょう。

外部依存を持つコードの問題点

以下は、外部の決済システムに依存するPaymentProcessorクラスの例です。

class PaymentProcessor:
    def __init__(self, payment_gateway):
        self.payment_gateway = payment_gateway

    def process_payment(self, order_id, amount):
        # 決済処理を行う
        result = self.payment_gateway.charge(order_id, amount)
        if result.status == "success":
            return True
        else:
            return False

このクラスは、payment_gatewayという外部の決済システムに依存しています。
process_paymentメソッドは、実際に決済を行い、その結果に基づいて処理の成功・失敗を返します。

このようなコードをテストする際の問題点は以下の通りです。

実際の決済システムを使用すると、テストのたびに実際の取引が発生してしまう。
外部システムの状態によってテスト結果が変化する可能性がある。
テストの実行速度が遅くなる。

Mockを使用したテスト

これらの問題を解決するために、Mockオブジェクトを使用してテストを行うことができます。
Mockは、外部依存のインターフェースをシミュレートし、その呼び出しを記録する機能を提供します。

以下は、PaymentProcessorクラスをテストするためのコード例です。

import unittest
from unittest.mock import Mock

class TestPaymentProcessor(unittest.TestCase):
    def test_process_payment_success(self):
        # Mockオブジェクトを作成
        mock_gateway = Mock()
        
        # Mockの振る舞いを定義
        mock_gateway.charge.return_value = Mock(status="success")
        
        # PaymentProcessorのインスタンスを作成
        processor = PaymentProcessor(mock_gateway)
        
        # テスト実行
        result = processor.process_payment("order123", 100)
        
        # アサーション
        self.assertTrue(result)
        mock_gateway.charge.assert_called_once_with("order123", 100)

    def test_process_payment_failure(self):
        mock_gateway = Mock()
        mock_gateway.charge.return_value = Mock(status="failure")
        
        processor = PaymentProcessor(mock_gateway)
        
        result = processor.process_payment("order456", 200)
        
        self.assertFalse(result)
        mock_gateway.charge.assert_called_once_with("order456", 200)

このテストコードでは、以下のような特徴があります。