PHPUnitの基本：テスト駆動開発を始めるための入門ガイド

ソフトウェア開発の現場で、品質を保証する手段の一つとして単体テストがあります。そして、その単体テストを効率よく行うための手法として注目されるのが「テスト駆動開発（TDD）」です。その中でもPHP言語でのテストに便利なツールが「PHPUnit」です。この記事では、PHPUnitを用いたテスト駆動開発の基本となる部分を解説し、例を交えながら具体的なステップを見ていきます。

テスト駆動開発（TDD）とは？
1. TDDの基本サイクル
PHPUnitのインストール
PHPUnitでのテスト作成
1. テストケースの構造
2. テストの実行
FizzBuzz問題をTDDで解決する例
PHPUnitの高度な機能
1. データプロバイダ
2. モック・スタブ
まとめ
関連記事

テスト駆動開発（TDD）とは？

まず、テスト駆動開発がどのような方法論であるのかを理解しておくことが重要です。TDDは、開発のサイクルをテストを書くことから始める手法で、「小さなテストを書き、それを動作する最小限のコードを書いて通す」というプロセスを繰り返します。この手法を通じて、コードの確実性を確認しながら進められるため、バグの発生原因を減らすことができます。

TDDの基本サイクル

Red: まずは失敗するテストを書く
Green: テストを通すために最小限のコードを実装
Refactor: コードをリファクタリングして、クリーンで効率的な形に整える

この「Red-Green-Refactor」というサイクルを絶えず繰り返すことで、自然とテストが網羅された高品質なコードが完成していきます。

PHPUnitのインストール

PHPUnitを使うためには、まずはインストールしなければなりません。最も一般的な方法はComposerを利用することです。ComposerはPHPの依存関係管理ツールで、多くのPHPプロジェクトで使用されています。

以下はComposerを介してPHPUnitをプロジェクトにインストールする手順です。

# Composerがインストールされていることを確認
composer --version

# プロジェクトディレクトリに移動して、PHPUnitをインストール
composer require --dev phpunit/phpunit

この方法でインストールすると、PHPUnitを簡単にプロジェクト内で呼び出して使用することができます。

PHPUnitでのテスト作成

PHPUnitをインストールした後は、実際にテストを書いてみましょう。まず、基本的なテストケースを作成することから始めます。

テストケースの構造

PHPUnitは「TestCase」というクラスを拡張する形でテストを作成します。以下は基本的なテストケースの例です。

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    public function testAddition()
    {
        $this->assertEquals(2, 1 + 1);
    }
}

テストの実行

上記のテストを実行するには、PHPUnitをコマンドラインから呼び出します。テストスクリプトはtestsディレクトリなどにまとめて配置しておくと管理しやすくなります。テストの実行は以下のように行います。

vendor/bin/phpunit tests

これにより、ComposerでインストールされたPHPUnitがテストディレクトリ内の全てのテストケースを実行します。

FizzBuzz問題をTDDで解決する例

少し実践的な例として、TDDを用いて典型的な「FizzBuzz」問題を解決する過程を見てみましょう。

FizzBuzzの仕様

数字を1から100まで出力する。
3の倍数なら「Fizz」、5の倍数なら「Buzz」、15の倍数なら「FizzBuzz」と表示する。

テストを書く

FizzBuzzを実装する前に、まずはテストを書きます。

use PHPUnit\Framework\TestCase;

class FizzBuzzTest extends TestCase
{
    public function testFizzBuzz()
    {
        $this->assertEquals('1', fizzBuzz(1));
        $this->assertEquals('2', fizzBuzz(2));
        $this->assertEquals('Fizz', fizzBuzz(3));
        $this->assertEquals('Buzz', fizzBuzz(5));
        $this->assertEquals('FizzBuzz', fizzBuzz(15));
    }
}

実装を行う

テストが書けたら、それを通すために最小限の実装を行います。

function fizzBuzz($number)
{
    if ($number % 15 === 0) {
        return 'FizzBuzz';
    }
    if ($number % 3 === 0) {
        return 'Fizz';
    }
    if ($number % 5 === 0) {
        return 'Buzz';
    }
    return (string)$number;
}

リファクタリング

テストが成功したなら、コードをより良くするためのリファクタリングを実施します。例えば、条件の順序を見直したり、処理を整理したりします。

PHPUnitの高度な機能

ここまで基本的な部分を説明しましたが、PHPUnitにはさらに高度なテストを可能にする様々な機能が用意されています。

データプロバイダ

同じテストコードを異なる入力データで実行したい場合、データプロバイダを利用できます。データプロバイダはテストメソッドに複数のデータを提供する役割を果たします。

モック・スタブ

複雑な依存関係を持つソフトウェアの場合、モックやスタブを使用して依存する部分を模擬したテストを行うことができます。PHPUnitではcreateMockやcreateStubメソッドを使うことでこれらを簡単に作成できます。

まとめ

PHPUnitを活用したテスト駆動開発（TDD）は、PHPでのソフトウェア開発において非常に有効な手法です。エラーを未然に防ぐだけではなく、保守性の高いコードを生産することができます。最初は基本的なテストケースから始めて、徐々に高度なテスト手法に手を広げていくことで、効率的で堅牢な開発サイクルを確立しましょう。