フィクスチャ(Fixture)

ここまでのテストでは、add(1, 2)のようにテスト関数の中で直接値を渡していました。しかし、実際のアプリケーションでは、テストの前にデータベースにデータを登録したり、オブジェクトを初期化したりする前準備が必要になることがあります。

こうした前準備を各テスト関数の中に毎回書くと、テストコードが重複し、修正が必要になったときにすべてのテスト関数を変更しなければなりません。フィクスチャは、この前準備を1か所にまとめて共通化するための仕組みです。@pytest.fixtureデコレータ(関数に機能を追加する構文)を使って定義します。

基本的な構文は以下の通りです。

@pytest.fixture
def フィクスチャ名():
    オブジェクト = ...
    return オブジェクト

def test_関数名(フィクスチャ名):
    assert ...

実際に試してみましょう。tests/test_user_service.pyを作成します。Visual Studio Codeのエクスプローラーでtestsフォルダを右クリックし、「新しいファイル」を選択してtest_user_service.pyという名前で作成してください。

python-testing
├── src/
│   ├── __init__.py
│   ├── calculator.py
│   ├── user_service.py
│   └── weather_client.py
├── tests/
│   ├── __init__.py
│   ├── test_calculator.py
│   └── test_user_service.py  ← このファイルを作成
└── requirements.txt

作成したファイルに以下の内容を記述して保存します。

import pytest
from src.user_service import UserService

@pytest.fixture
def user_service():
    """テストごとに新しいUserServiceインスタンスを作成する"""
    service = UserService()
    service.add_user(1, "Tanaka")
    service.add_user(2, "Suzuki")
    return service

def test_get_user(user_service):
    # Act
    user = user_service.get_user(1)

    # Assert
    assert user["name"] == "Tanaka"
    assert user["id"] == 1

def test_get_all_users(user_service):
    # Act
    users = user_service.get_all_users()

    # Assert
    assert len(users) == 2

def test_add_user(user_service):
    # Act
    new_user = user_service.add_user(3, "Yamada")

    # Assert
    assert new_user["name"] == "Yamada"
    assert len(user_service.get_all_users()) == 3

def test_add_duplicate_user(user_service):
    # Act & Assert
    with pytest.raises(ValueError, match="既に存在します"):
        user_service.add_user(1, "Tanaka")

def test_delete_user(user_service):
    # Act
    user_service.delete_user(1)

    # Assert
    assert len(user_service.get_all_users()) == 1
    with pytest.raises(KeyError):
        user_service.get_user(1)

def test_delete_nonexistent_user(user_service):
    # Act & Assert
    with pytest.raises(KeyError, match="見つかりません"):
        user_service.delete_user(999)

コードを解説します。

@pytest.fixture
def user_service():
    service = UserService()
    service.add_user(1, "Tanaka")
    service.add_user(2, "Suzuki")
    return service

@pytest.fixtureデコレータを付けた関数がフィクスチャです。UserServiceのインスタンスを作成し、テスト用のデータ(2名のユーザ)を登録して返しています。

def test_get_user(user_service):

テスト関数の引数にフィクスチャ名(user_service)を指定すると、pytestが自動的にフィクスチャを実行し、戻り値を引数に渡してくれます。テストごとに新しいインスタンスが作成されるため、あるテストでデータを変更しても他のテストに影響しません。

def test_add_duplicate_user(user_service):
    with pytest.raises(ValueError, match="既に存在します"):
        user_service.add_user(1, "Tanaka")

既に存在するユーザID(1)を再度登録しようとした場合に、ValueErrorが発生することを検証しています。正常系だけでなく、エラーケースもテストすることで、コードの信頼性が高まります。

Windowsの場合:

pytest tests/test_user_service.py -v

Macの場合:

python3 -m pytest tests/test_user_service.py -v

以下のような実行結果が表示されます。

========================= test session starts ==========================
collected 6 items

tests/test_user_service.py::test_get_user PASSED                [ 16%]
tests/test_user_service.py::test_get_all_users PASSED            [ 33%]
tests/test_user_service.py::test_add_user PASSED                 [ 50%]
tests/test_user_service.py::test_add_duplicate_user PASSED       [ 66%]
tests/test_user_service.py::test_delete_user PASSED              [ 83%]
tests/test_user_service.py::test_delete_nonexistent_user PASSED  [100%]

========================== 6 passed in 0.01s ===========================

フィクスチャで用意したUserServiceインスタンスに対して、6つのテスト(取得、一覧、追加、重複エラー、削除、削除エラー)がすべて成功しています。