パラメタライズドテスト

前のセクションで作成したtest_addでは、add(1, 2) == 3という1つのパターンだけをテストしていました。しかし、実際には「0同士の足し算」「負の数同士の足し算」「大きな数の足し算」など、さまざまなパターンで正しく動作するかを検証する必要があります。

各パターンごとにtest_add_zero、test_add_negativeのようにテスト関数を作ることもできますが、テストのロジック(関数を呼んで結果を確認する)は同じで、入力値と期待値だけが異なります。このような場合にパラメタライズドテストを使うと、1つのテスト関数に複数のデータセットを渡して繰り返し実行できます。@pytest.mark.parametrizeデコレータを使います。

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

@pytest.mark.parametrize("引数1, 引数2, 期待値", [
    (値1, 値2, 期待値1),
    (値3, 値4, 期待値2),
])
def test_関数名(引数1, 引数2, 期待値):
    assert 関数(引数1, 引数2) == 期待値

実際に試してみましょう。tests/test_calculator.pyに以下のテストを追加します。

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (0, 0, 0),
    (-1, 1, 0),
    (100, 200, 300),
    (-5, -3, -8),
])
def test_add_parametrize(a, b, expected):
    assert add(a, b) == expected

@pytest.mark.parametrize("a, b, expected", [
    (10, 2, 5.0),
    (7, 2, 3.5),
    (1, 3, pytest.approx(0.333, rel=1e-2)),
])
def test_divide_parametrize(a, b, expected):
    assert divide(a, b) == expected

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

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (0, 0, 0),
    (-1, 1, 0),
    (100, 200, 300),
    (-5, -3, -8),
])
def test_add_parametrize(a, b, expected):
    assert add(a, b) == expected

@pytest.mark.parametrizeデコレータの第1引数にテスト関数の引数名を文字列で指定し、第2引数にテストデータのリストを渡しています。この例では、add関数に対して正の数、0、負の数など5つのパターンをテストしています。テストデータを追加するだけで、テストケースを簡単に増やすことができます。

テストを実行すると、パラメータの組み合わせごとにテストが実行されます。

Windowsの場合:

pytest tests/test_calculator.py -v

Macの場合:

python3 -m pytest tests/test_calculator.py -v

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

tests/test_calculator.py::test_add_parametrize[1-2-3] PASSED
tests/test_calculator.py::test_add_parametrize[0-0-0] PASSED
tests/test_calculator.py::test_add_parametrize[-1-1-0] PASSED
tests/test_calculator.py::test_add_parametrize[100-200-300] PASSED
tests/test_calculator.py::test_add_parametrize[-5--3--8] PASSED
tests/test_calculator.py::test_divide_parametrize[10-2-5.0] PASSED
tests/test_calculator.py::test_divide_parametrize[7-2-3.5] PASSED
tests/test_calculator.py::test_divide_parametrize[1-3-expected2] PASSED

パラメータの組み合わせごとにテスト名に[1-2-3]のようなサフィックスが付き、それぞれ個別に実行されています。すべてのパラメータパターンでPASSEDとなっています。

💡 ポイント
パラメタライズドテストを使うことで、1つのテスト関数で複数のケースを網羅できます。テストコードの重複を減らし、新しいテストケースの追加も容易になります。