ユニットテストの効果を高めるテクニック: テストダブルの活用

ソフトウェア開発において、ユニットテストは品質保証の重要な要素です。
しかし、テスト対象のコードが外部リソースや複雑な依存関係を持つ場合、テストの実施が困難になることがあります。
このような状況で役立つのが「テストダブル」です。

本記事では、テストダブルの概念、その必要性、および活用方法について解説します。
サンプルコードを交えながら、テストダブルがどのようにユニットテストの効果を高めるかを見ていきましょう。

テストダブルとは

テストダブルとは、テスト対象のコードが依存するコンポーネントの代わりに使用される、シミュレートされたオブジェクトです。
これにより、テスト対象のコードを他のコンポーネントから分離し、より制御された環境でテストを行うことが可能になります。

テストダブルの種類には、モック、スタブ、フェイクなどがあります。
それぞれの詳細な説明は別の記事で行う予定です。

テストダブルを使用する主な理由は、以下の3つです。

テストを簡単にする
テストから外部システムを保護する
テストを外部要因から保護する

それぞれの理由について、詳しく見ていきましょう。

テストを簡単にする

複雑な依存関係を持つコードをテストする場合、その依存関係のセットアップに多大な労力が必要になることがあります。
テストダブルを使用することで、このような複雑なセットアップを回避し、テストをより簡潔に書くことができます。

以下は、外部サービスを使用して商品の在庫を確認するクラスのサンプルコードです。

import requests
 
class InventoryService:
    def __init__(self, api_url):
        self.api_url = api_url
 
    def check_stock(self, product_id):
        response = requests.get(f"{self.api_url}/stock/{product_id}")
        if response.status_code == 200:
            return response.json()['quantity']
        else:
            raise Exception("Failed to fetch stock information")
 
class OrderProcessor:
    def __init__(self, inventory_service):
        self.inventory_service = inventory_service
 
    def process_order(self, product_id, quantity):
        available_stock = self.inventory_service.check_stock(product_id)
        if available_stock >= quantity:
            return "Order processed successfully"
        else:
            return "Insufficient stock"

このコードをテストする場合、実際のAPIを呼び出すと、ネットワーク接続やAPIの応答時間などの外部要因に左右されてしまいます。
テストダブル（ここではスタブ）を使用することで、これらの問題を回避できます。

import unittest
 
class InventoryServiceStub:
    def __init__(self, stock_data):
        self.stock_data = stock_data
 
    def check_stock(self, product_id):
        return self.stock_data.get(product_id, 0)
 
class TestOrderProcessor(unittest.TestCase):
    def test_process_order_sufficient_stock(self):
        stub_inventory = InventoryServiceStub({"PROD001": 10})
        processor = OrderProcessor(stub_inventory)
        result = processor.process_order("PROD001", 5)
        self.assertEqual(result, "Order processed successfully")
 
    def test_process_order_insufficient_stock(self):
        stub_inventory = InventoryServiceStub({"PROD001": 3})
        processor = OrderProcessor(stub_inventory)
        result = processor.process_order("PROD001", 5)
        self.assertEqual(result, "Insufficient stock")

このテストでは、InventoryServiceStubを作成し、特定の在庫データを返すように設定しています。
これにより、実際のAPIを呼び出すことなく、OrderProcessorの動作を簡単にテストできます。

テストから外部システムを保護する

テストの実行中に、実際の外部システムに影響を与えたくない場合があります。
例えば、プロダクションデータベースにテストデータを書き込んだり、実際の決済処理を行ったりすることは避けるべきです。

以下は、ユーザーのポイントを更新する処理のサンプルコードです。

class UserPointsDatabase:
    def __init__(self):
        self.points = {}
 
    def add_points(self, user_id, points):
        if user_id in self.points:
            self.points[user_id] += points
        else:
            self.points[user_id] = points
 
    def get_points(self, user_id):
        return self.points.get(user_id, 0)
 
class PointsManager:
    def __init__(self, database):
        self.database = database
 
    def award_points(self, user_id, activity_points):
        current_points = self.database.get_points(user_id)
        new_points = current_points + activity_points
        self.database.add_points(user_id, activity_points)
        return f"User {user_id} now has {new_points} points"

このコードをテストする際、実際のデータベースを使用すると、テストの実行によって実際のユーザーポイントが変更されてしまう可能性があります。
テストダブル（ここではフェイク）を使用することで、この問題を回避できます。

import unittest
 
class FakeUserPointsDatabase:
    def __init__(self):
        self.points = {}
 
    def add_points(self, user_id, points):
        if user_id in self.points:
            self.points[user_id] += points
        else:
            self.points[user_id] = points
 
    def get_points(self, user_id):
        return self.points.get(user_id, 0)
 
class TestPointsManager(unittest.TestCase):
    def test_award_points(self):
        fake_db = FakeUserPointsDatabase()
        fake_db.add_points("user123", 100)  # 初期ポイントを設定
         
        manager = PointsManager(fake_db)
        result = manager.award_points("user123", 50)
 
        self.assertEqual(result, "User user123 now has 150 points")
        self.assertEqual(fake_db.get_points("user123"), 150)

このテストでは、FakeUserPointsDatabaseを作成し、実際のデータベースの動作をシミュレートしています。
これにより、実際のデータベースに影響を与えることなく、PointsManagerの動作をテストできます。

テストを外部要因から保護する

外部システムの状態や動作が不安定または予測不可能な場合、テストの結果が一貫しなくなる可能性があります。
テストダブルを使用することで、このような外部要因からテストを保護し、一貫性のあるテスト結果を得ることができます。

以下は、現在の気温を取得するクラスのサンプルコードです。

import random
 
class WeatherSensor:
    def get_temperature(self):
        # 実際にはセンサーからデータを読み取るが、
        # ここでは簡単のためにランダムな値を返す
        return round(random.uniform(-10, 40), 1)
 
class TemperatureMonitor:
    def __init__(self, sensor):
        self.sensor = sensor
 
    def check_temperature(self):
        temp = self.sensor.get_temperature()
        if temp > 30:
            return "Warning: High temperature"
        elif temp < 0:
            return "Warning: Low temperature"
        else:
            return "Temperature is normal"

この場合、WeatherSensorが返す値がランダムであるため、テストの結果が不安定になります。
テストダブル（ここではモック）を使用することで、この問題を解決できます。

import unittest
from unittest.mock import Mock
 
class TestTemperatureMonitor(unittest.TestCase):
    def test_high_temperature_warning(self):
        mock_sensor = Mock()
        mock_sensor.get_temperature.return_value = 35.0
 
        monitor = TemperatureMonitor(mock_sensor)
        result = monitor.check_temperature()
 
        self.assertEqual(result, "Warning: High temperature")
        mock_sensor.get_temperature.assert_called_once()
 
    def test_low_temperature_warning(self):
        mock_sensor = Mock()
        mock_sensor.get_temperature.return_value = -5.0
 
        monitor = TemperatureMonitor(mock_sensor)
        result = monitor.check_temperature()
 
        self.assertEqual(result, "Warning: Low temperature")
        mock_sensor.get_temperature.assert_called_once()
 
    def test_normal_temperature(self):
        mock_sensor = Mock()
        mock_sensor.get_temperature.return_value = 20.0
 
        monitor = TemperatureMonitor(mock_sensor)
        result = monitor.check_temperature()
 
        self.assertEqual(result, "Temperature is normal")
        mock_sensor.get_temperature.assert_called_once()