Arrange, Act, Assertパターン

前のセクションで作成したテストはシンプルな1行のテストでしたが、実際のプロジェクトではテストの内容がより複雑になります。たとえば、テスト前にデータを準備する必要があったり、複数の条件を検証する必要があったりします。

テストが複雑になると、「このテストは何をしているのか」が読み取りにくくなります。そこで、テストを構造化する際の基本的なパターンとして、Arrange, Act, Assert(AAA)パターンが広く使われています。AAAパターンでは、テストを以下の3つのステップに分けて記述します。

  • Arrange(準備): テストに必要なデータやオブジェクトを用意する
  • Act(実行): テスト対象の処理を実行する
  • Assert(検証): 実行結果が期待通りであることを検証する

この3ステップに分けることで、テストの意図が明確になり、他の開発者がテストコードを読んだときにも「何を準備して」「何を実行して」「何を検証しているのか」がすぐに理解できます。

AAAパターンの基本的な構文は以下の通りです。

def test_関数名():
    # Arrange(準備)
    入力値 = ...

    # Act(実行)
    結果 = テスト対象関数(入力値)

    # Assert(検証)
    assert 結果 == 期待値

実際に試してみましょう。tests/test_calculator.pyに、AAAパターンを意識したtest_divide関数を追加します。

import pytest
from src.calculator import add, subtract, multiply, divide

def test_add():
    assert add(1, 2) == 3

def test_subtract():
    assert subtract(5, 3) == 2

def test_multiply():
    assert multiply(3, 4) == 12

def test_divide():
    # Arrange
    a = 10
    b = 3

    # Act
    result = divide(a, b)

    # Assert
    assert result == pytest.approx(3.333, rel=1e-2)

追加したコードを解説します。

import pytest

pytestモジュールをインポートしています。pytest.approxなどのヘルパ関数を使用するために必要です。

def test_divide():
    # Arrange
    a = 10
    b = 3

    # Act
    result = divide(a, b)

    # Assert
    assert result == pytest.approx(3.333, rel=1e-2)

AAAパターンに沿ってdivide関数のテストを記述しています。Arrangeでテストデータを準備し、Actで関数を実行し、Assertで結果を検証しています。pytest.approxは浮動小数点数の比較に使用するヘルパで、rel=1e-2は1%の相対誤差を許容することを意味します。

テストを実行して結果を確認しましょう。

Windowsの場合:

pytest tests/test_calculator.py -v

Macの場合:

python3 -m pytest tests/test_calculator.py -v

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

========================= test session starts ==========================
collected 4 items

tests/test_calculator.py::test_add PASSED                        [ 25%]
tests/test_calculator.py::test_subtract PASSED                   [ 50%]
tests/test_calculator.py::test_multiply PASSED                   [ 75%]
tests/test_calculator.py::test_divide PASSED                     [100%]

========================== 4 passed in 0.01s ===========================

test_divideが追加され、4つのテストがすべてPASSEDとなりました。

1. 例外のテスト

次に、エラーケースのテストを追加します。divide関数は0で割った場合にValueError例外を発生させるように実装しています。この例外が正しく発生することもテストで検証しましょう。

tests/test_calculator.pyにtest_divide_by_zero関数を追加します。

import pytest
from src.calculator import add, subtract, multiply, divide

def test_add():
    assert add(1, 2) == 3

def test_subtract():
    assert subtract(5, 3) == 2

def test_multiply():
    assert multiply(3, 4) == 12

def test_divide():
    # Arrange
    a = 10
    b = 3

    # Act
    result = divide(a, b)

    # Assert
    assert result == pytest.approx(3.333, rel=1e-2)

def test_divide_by_zero():
    # Arrange & Act & Assert
    with pytest.raises(ValueError, match="0で割ることはできません"):
        divide(10, 0)

追加したコードを解説します。

def test_divide_by_zero():
    with pytest.raises(ValueError, match="0で割ることはできません"):
        divide(10, 0)

pytest.raisesは、特定の例外が発生することを検証するためのヘルパです。matchパラメータで例外メッセージの内容も検証できます。

💡 ポイント
通常のテストではassert 結果 == 期待値のように戻り値を検証しますが、例外が発生する場合は関数が値を返す前にエラーで中断されるため、戻り値を受け取ることができません。with pytest.raises(ValueError):と書くことで、withブロックの中で例外が発生することを「期待している」とpytestに伝えます。ブロック内で指定した例外が発生すればテスト成功、発生しなければテスト失敗となります。

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

with pytest.raises(例外型):
    例外を発生させる処理()

テストを実行して結果を確認しましょう。

Windowsの場合:

pytest tests/test_calculator.py -v

Macの場合:

python3 -m pytest tests/test_calculator.py -v

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

========================= test session starts ==========================
collected 5 items

tests/test_calculator.py::test_add PASSED                        [ 20%]
tests/test_calculator.py::test_subtract PASSED                   [ 40%]
tests/test_calculator.py::test_multiply PASSED                   [ 60%]
tests/test_calculator.py::test_divide PASSED                     [ 80%]
tests/test_calculator.py::test_divide_by_zero PASSED             [100%]

========================== 5 passed in 0.01s ===========================

test_divide_by_zeroが追加され、5つのテストがすべてPASSEDとなりました。正常系のテスト(test_divide)とエラーケースのテスト(test_divide_by_zero)の両方が正しく動作しています。