PHPでユニットテストを理解しよう！実践例10選で学ぶ基本と応用

はじめに
●ユニットテストとは？
●PHPでのユニットテスト
●PHPUnitとは？
●PHPUnitのインストール方法
●基本的なテストケースの作り方
- ○サンプルコード1：基本的なテストケース
●モックオブジェクトを利用したテストケースの作り方
- ○サンプルコード2：モックオブジェクトを用いたテストケース
●データプロバイダを利用したテストケースの作り方
- ○サンプルコード3：データプロバイダを利用したテストケース
●例外をテストする方法
- ○サンプルコード4：例外のテスト
●高度なテストケースの作り方
○サンプルコード10：CRONジョブのテスト
●テスト結果の解釈とトラブルシューティング
- ○テスト駆動開発(TDD)について
まとめ

はじめに

PHPに慣れてきたところで、ユニットテストについて深く掘り下げてみませんか？

ユニットテストは、ソフトウェア開発における極めて重要な一部で、より強固で信頼性の高いコードを作成するためのキーとなります。

この記事では、PHPでのユニットテストについて解説します。

テストフレームワーク「PHPUnit」を使用した基本的なテストケースの作り方から、高度なテストケースまで、10個の実践的なサンプルコードを通じて理解を深めます。

さらに、テスト結果の解釈方法や、トラブルシューティングのテクニックについても学びます。

●ユニットテストとは？

ユニットテストは、ソフトウェアの最小単位（ユニット）が期待通りに動作するか確認するテストです。

多くの場合、ユニットテストは関数やメソッド、モジュールなど、小さな単位で実行されます。

ユニットテストの目的は、各部分が正しく動作することを保証し、全体としてのソフトウェアの品質を向上させることです。

また、バグの早期発見や、コードのリファクタリングを安全に行うことも可能にします。

●PHPでのユニットテスト

PHPでも、もちろんユニットテストは行うことができます。

PHPには、様々なテストフレームワークが存在しますが、中でも最も広く利用されているのが「PHPUnit」です。

これからは、このPHPUnitを用いたユニットテストの方法について詳しく見ていきましょう。

●PHPUnitとは？

PHPUnitは、PHPでユニットテストを行うためのフレームワークです。

PHPUnitを使うことで、手軽にユニットテストを書き、実行することができます。

また、テスト結果を様々な形式で出力する機能や、テストケースの自動生成など、便利な機能も多数提供しています。

●PHPUnitのインストール方法

PHPUnitはComposerを使って簡単にインストールすることができます。

下記のコマンドをプロジェクトのルートディレクトリで実行することで、PHPUnitをインストールすることができます。

composer require --dev phpunit/phpunit

このコマンドを実行すると、PHPUnitがプロジェクトに追加され、テストコードを書き始めることができます。

インストールが完了したら、まずは基本的なテストケースの作成方法を見ていきましょう。

●基本的なテストケースの作り方

PHPUnitを用いたユニットテストは、テストクラスとテストメソッドから成り立っています。

テストクラスは、通常のPHPクラスで、テストしたいクラスや機能に対応します。

テストメソッドは、そのクラスの中で定義され、具体的なテストを行います。

テストメソッドの名前は「test」で始まる必要があります。

また、アサーション（期待値と実際の結果を比較する機能）を使って、テスト結果を検証します。

それでは、基本的なテストケースを作成してみましょう。

○サンプルコード1：基本的なテストケース

簡単なPHPUnitのテストケースのサンプルコードを紹介します。

<?php

use PHPUnit\Framework\TestCase;

class SampleTest extends TestCase
{
    public function testAddition()
    {
        $result = 2 + 2;
        $this->assertEquals(4, $result);
    }
}

このコードでは、PHPUnitの基本的な機能を用いて、2+2が4になることを確認しています。

テストケースはSampleTestというクラスの中にあり、testAdditionというメソッドで定義されています。

テストケースのメソッド名は「test」で始まる必要があります。

assertEqualsメソッドは、引数として期待値と実際の値を取り、これらが等しいかどうかをチェックします。

●モックオブジェクトを利用したテストケースの作り方

次に、モックオブジェクトを用いたテストケースの作り方について見ていきましょう。

モックオブジェクトは、テスト対象のクラスが依存する他のクラスをシミュレートするためのオブジェクトです。

PHPUnitでは、テストダブルという機能を用いてモックオブジェクトを作成することができます。

テストダブルは、テスト対象のクラスが依存するクラスの実装を書く必要がなく、必要な振る舞いだけをエミュレートすることが可能です。

これにより、テストが他の部分に影響を受けることなく、独立してテスト対象の機能だけをテストすることが可能になります。

それでは、モックオブジェクトを用いたテストケースを作成してみましょう。

○サンプルコード2：モックオブジェクトを用いたテストケース

モックオブジェクトを用いたPHPUnitのテストケースのサンプルコードを紹介します。

<?php

use PHPUnit\Framework\TestCase;

class MockTest extends TestCase
{
    public function testMock()
    {
        $mock = $this->createMock(SampleClass::class);

        $mock->method('add')
             ->willReturn(5);

        $result = $mock->add(2, 3);
        
        $this->assertEquals(5, $result);
    }
}

このコードでは、SampleClassというクラスのモックオブジェクトを作成しています。

そして、そのモックオブジェクトのaddメソッドが呼び出されたときに5を返すように設定しています。

この例では、モックオブジェクトのaddメソッドに2と3を渡して呼び出すと、設定した通りに5が返ってくることを確認しています。

これにより、SampleClassのaddメソッドが正しく動作しているかどうかをテストすることなく、それを使用するコードのテストを行うことが可能になります。

●データプロバイダを利用したテストケースの作り方

次に、データプロバイダを利用したテストケースの作り方について見ていきましょう。

データプロバイダは、複数のテストケースに対して同じテストロジックを使用しつつ、異なるパラメータセットを提供するための機能です。

これにより、テストコードの重複を減らし、テストケースの数を増やすことが可能になります。

データプロバイダは、「provide」で始まるメソッドとして定義し、そのメソッドから配列の配列を返すようにします。

それぞれの内部配列は、テストメソッドに渡す引数のセットを表します。

それでは、データプロバイダを用いたテストケースを作成してみましょう。

○サンプルコード3：データプロバイダを利用したテストケース

次に、データプロバイダを用いたテストケースのサンプルコードを紹介します。

<?php

use PHPUnit\Framework\TestCase;

class DataProviderTest extends TestCase
{
    /**
     * @dataProvider additionProvider
     */
    public function testAdd($a, $b, $expected)
    {
        $result = $a + $b;
        $this->assertEquals($expected, $result);
    }

    public function additionProvider()
    {
        return [
            [1, 2, 3],
            [0, 0, 0],
            [-1, -1, -2],
        ];
    }
}

このコードでは、データプロバイダadditionProviderを用いて、testAddというメソッドをテストしています。additionProviderメソッドは、テストケースの配列を返します。

それぞれのテストケースは、testAddメソッドに渡す引数の配列となります。

この例では、additionProviderが3つのテストケースを提供しています。

それぞれのテストケースでtestAddメソッドが呼び出され、その引数として配列の要素が渡されます。

つまり、testAddメソッドは3回実行され、その各回で引数が変わることになります。

このようにデータプロバイダを使用することで、同じテストロジックに対して異なるパラメータを適用し、多くのテストケースを簡単に作成することが可能になります。

●例外をテストする方法

テストでは、メソッドが想定通りの例外をスローするかどうかも確認することが重要です。

PHPUnitでは、特定の例外がスローされることを期待するテストを書くための方法が提供されています。

例外をテストするための基本的なアプローチは、expectExceptionメソッドを使用することです。

このメソッドは、テストケース内で例外がスローされることを期待するタイプの例外を指定します。

次に、例外のテストケースを作成してみましょう。

○サンプルコード4：例外のテスト

次に示すコードは、例外をテストするためのサンプルコードです。

<?php

use PHPUnit\Framework\TestCase;

class ExceptionTest extends TestCase
{
    public function testException()
    {
        $this->expectException(InvalidArgumentException::class);

        // This code will throw an InvalidArgumentException
        throw new InvalidArgumentException();
    }
}

このコードでは、expectExceptionメソッドを使って、テスト中にInvalidArgumentExceptionが投げられることを期待しています。

その後のコードで実際にInvalidArgumentExceptionを投げているため、このテストはパスします。

しかし、もしInvalidArgumentException以外の例外が投げられる場合や、全く例外が投げられない場合は、テストは失敗します。

このようにexpectExceptionメソッドは、期待する特定の例外がスローされるかを確認するテストを容易に作成できるため、例外を適切に扱うコードのテストにとても役立ちます。

●高度なテストケースの作り方

上記のテストケースは基本的なものですが、複雑なアプリケーションをテストする際には、もっと高度なテストケースが必要となることがあります。

例えば、データベースとのインタラクションをテストする場合や、外部APIからのレスポンスをテストする場合などは、独自のセットアップとティアダウンが必要となることがあります。

そのような高度なテストケースを作成する方法を、次に詳しく見ていきましょう。

○サンプルコード5：データベースとのインタラクションをテストする

データベースとのインタラクションをテストする際には、テストケース内でデータベースのセットアップとクリーンアップを行うことが一般的です。

データベースとのインタラクションをテストするためのサンプルコードを紹介します。

<?php

use PHPUnit\Framework\TestCase;

class DatabaseTest extends TestCase
{
    protected $dbh;

    protected function setUp(): void
    {
        $this->dbh = new PDO('sqlite::memory:');
        $this->dbh->exec(
            'CREATE TABLE user (
                id INT PRIMARY KEY,
                name VARCHAR(50)
            )'
        );
    }

    protected function tearDown(): void
    {
        $this->dbh = null;
    }

    public function testDatabaseInsert()
    {
        $name = 'test user';
        $stmt = $this->dbh->prepare('INSERT INTO user (id, name) VALUES (:id, :name)');
        $stmt->bindParam(':id', $id, PDO::PARAM_INT);
        $stmt->bindParam(':name', $name, PDO::PARAM_STR);

        $id = 1;
        $stmt->execute();

        $stmt = $this->dbh->prepare('SELECT name FROM user WHERE id = :id');
        $stmt->bindParam(':id', $id, PDO::PARAM_INT);
        $stmt->execute();
        $result = $stmt->fetch(PDO::FETCH_ASSOC);

        $this->assertEquals($name, $result['name']);
    }
}

このコードではsetUpメソッドを使って、各テストケースの前にメモリ内にSQLiteデータベースを作成し、ユーザーテーブルを作成しています。

その後、tearDownメソッドでテストケースの後にデータベース接続を閉じています。

testDatabaseInsertメソッドでは、データベースにデータを挿入し、その後、そのデータを取得して期待した値と一致するかを確認しています。

このようなテストケースの設計は、データベースとのインタラクションを確認しながら、テストの前後でデータベースの状態を制御することを可能にします。

○サンプルコード6：APIリクエストをテストする

次に、外部APIとのインタラクションをテストするためのサンプルコードを示します。

このコードでは、HTTPクライアントライブラリであるGuzzleを使用しています。

また、テスト中に実際のHTTPリクエストを行わずに、モックとスタブを使用してHTTPレスポンスをシミュレートします。

APIリクエストのテストは、通常の単体テストと異なり、外部のシステムとのインタラクションをテストします。

そのため、通常のモックやスタブを使用して、テスト中の外部APIの呼び出しをシミュレートすることが一般的です。

GuzzleとPHPUnitを使用してAPIリクエストのテストを行うサンプルコードを紹介します。

<?php

use GuzzleHttp\Client;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Response;
use PHPUnit\Framework\TestCase;

class ApiTest extends TestCase
{
    public function testGetRequest()
    {
        $mock = new MockHandler([
            new Response(200, [], '{"foo": "bar"}'),
        ]);

        $handlerStack = HandlerStack::create($mock);
        $client = new Client(['handler' => $handlerStack]);

        $response = $client->request('GET', '/');

        $this->assertEquals(200, $response->getStatusCode());
        $this->assertEquals('bar', json_decode($response->getBody(), true)['foo']);
    }
}

このサンプルコードでは、まずGuzzleのMockHandlerを使用して、実際のHTTPリクエストを行わずにHTTPレスポンスをシミュレートしています。

次にHandlerStackを使用して、このモックハンドラをクライアントに関連付け、requestメソッドを使用してAPIリクエストをシミュレートします。

最後に、テストケースではAPIからのレスポンスが期待通りであることを確認しています。

この例では、ステータスコードが200であることと、レスポンスボディの値が期待通りであることを確認しています。

○サンプルコード7：依存関係の注入をテストする

依存関係の注入は、オブジェクト指向プログラミングとテスト可能なコードの設計において重要なパターンです。

依存関係の注入を用いることで、クラスの依存関係を動的に変更したり、テスト中にモックオブジェクトを注入したりすることが可能になります。

依存関係の注入をテストするためのサンプルコードを紹介します。

<?php

use PHPUnit\Framework\TestCase;

class Dependency {
    public function getValue() {
        return '実際の値';
    }
}

class TestClass {
    protected $dependency;

    public function __construct(Dependency $dependency) {
        $this->dependency = $dependency;
    }

    public function getDependencyValue() {
        return $this->dependency->getValue();
    }
}

class DependencyInjectionTest extends TestCase
{
    public function testDependencyInjection()
    {
        $mockDependency = $this->createMock(Dependency::class);
        $mockDependency->method('getValue')->willReturn('モックの値');

        $testClass = new TestClass($mockDependency);

        $this->assertEquals('モックの値', $testClass->getDependencyValue());
    }
}

このコードでは、まずDependencyクラスとそのメソッドgetValueを定義しています。

次に、TestClassクラスではDependencyクラスのインスタンスをコンストラクタで受け取り、それをプロパティとして保存します。これが依存関係の注入の基本的な形です。

DependencyInjectionTestクラスでは、Dependencyクラスのモックを作成し、そのgetValueメソッドが呼び出されたときに’モックの値’を返すように設定しています。

そして、このモックをTestClassのコンストラクタに渡してインスタンスを作成し、そのメソッドgetDependencyValueを呼び出すとモックが返した値が得られることを確認しています。

○サンプルコード8：ユーザー認証機能のテスト

ユーザー認証は、Webアプリケーションにおける最も重要な機能の一つです。

ユーザーの認証機能が正しく動作することを確認するためのテストは不可欠です。

ユーザー認証機能のテストを行うためのサンプルコードを紹介します。

この例では、ユーザー名とパスワードが正しく入力された場合に認証が成功し、誤った情報が入力された場合には認証が失敗することを確認します。

<?php

use PHPUnit\Framework\TestCase;

class User {
    private $username;
    private $password;

    public function __construct($username, $password) {
        $this->username = $username;
        $this->password = $password;
    }

    public function authenticate($username, $password) {
        return $this->username === $username && $this->password === $password;
    }
}

class UserAuthTest extends TestCase
{
    public function testUserAuthentication()
    {
        $user = new User('username', 'password');

        $this->assertTrue($user->authenticate('username', 'password'));
        $this->assertFalse($user->authenticate('wrong_username', 'wrong_password'));
    }
}

このコードでは、まずUserクラスとその認証メソッドauthenticateを定義しています。

Userクラスのコンストラクタでは、ユーザ名とパスワードを受け取り、それらをプロパティとして保存します。

authenticateメソッドでは、提供されたユーザ名とパスワードが、インスタンスのユーザ名とパスワードと一致するかどうかを確認し、一致する場合はtrue、そうでない場合はfalseを返します。

UserAuthTestクラスでは、まずUserのインスタンスを作成し、そのauthenticateメソッドを呼び出します。

まず正しいユーザ名とパスワードで認証を試み、結果がtrueになることを確認します。

次に、誤ったユーザ名とパスワードで認証を試み、結果がfalseになることを確認します。

○サンプルコード9：ファイル操作のテスト

プログラムがファイル操作を正しく行っていることを確認するテストも重要です。

例えば、ファイルの書き込みや読み込み、ファイルの存在確認など、ファイル操作に関連する各種機能の動作を確認することができます。

ファイルを作成し、その内容を読み取ることを確認するテストのサンプルコードを紹介します。

このコードでは、まずテスト用のファイルを作成し、その後でそのファイルの内容を読み取り、期待した内容と一致することを確認します。

<?php

use PHPUnit\Framework\TestCase;

class FileHandler
{
    public function createFile($filename, $content)
    {
        file_put_contents($filename, $content);
    }

    public function readFile($filename)
    {
        return file_get_contents($filename);
    }
}

class FileHandlerTest extends TestCase
{
    private $fileHandler;

    public function setUp(): void
    {
        $this->fileHandler = new FileHandler();
    }

    public function testFileCreationAndReading()
    {
        $filename = 'testfile.txt';
        $content = 'Hello, World!';

        // ファイル作成
        $this->fileHandler->createFile($filename, $content);

        // ファイルの内容を読み込む
        $actualContent = $this->fileHandler->readFile($filename);

        $this->assertEquals($content, $actualContent);

        // テスト後の掃除
        unlink($filename);
    }
}

このコードでは、まずFileHandlerクラスとそのcreateFileメソッド、readFileメソッドを定義しています。

createFileメソッドでは、指定されたファイル名と内容でファイルを作成します。

readFileメソッドでは、指定されたファイルの内容を読み取ります。

FileHandlerTestクラスでは、まずFileHandlerのインスタンスを作成します。

次に、テスト用のファイル名と内容を定義し、それを使用してファイルを作成します。

その後、そのファイルの内容を読み取り、それが作成時に指定した内容と一致することを確認します。

最後に、テスト用のファイルを削除します。

○サンプルコード10：CRONジョブのテスト

CRONジョブのテストも重要な要素の一つです。

例えば、特定の時間に特定のタスクが実行されることを確認する必要があります。

下記のサンプルコードは、特定の時間にメッセージを出力するCRONジョブのテストを示しています。

このコードでは、スケジュールされたタスクが正しく実行され、その出力が期待通りであることを確認します。

<?php

use PHPUnit\Framework\TestCase;

class CronJob
{
    public function run()
    {
        return "CRON job ran successfully!";
    }
}

class CronJobTest extends TestCase
{
    public function testRun()
    {
        $cronJob = new CronJob();

        $this->assertEquals("CRON job ran successfully!", $cronJob->run());
    }
}

上記のコードでは、CronJobクラスとそのrunメソッドを定義しています。

runメソッドは、CRONジョブが成功した場合にメッセージを返します。

CronJobTestクラスでは、まずCronJobのインスタンスを作成します。

そしてrunメソッドを呼び出し、その結果が期待されるメッセージと一致することを確認します。

このテストは非常に単純なものですが、実際の環境ではCRONジョブが適切なタイミングで動作し、予期される出力を生成するかどうかをテストするためのロジックが必要となるでしょう。

●テスト結果の解釈とトラブルシューティング

PHPUnitなどのテストフレームワークを使ってテストを実行した後、出力結果を解釈する能力は重要なスキルです。

テスト結果の解釈は、あなたがテストが何をテストしているのか、そしてそれがなぜ失敗したのかを理解するためのキーとなります。

テスト結果には通常、次のような情報が含まれます。

テストケースの名前：これはテストが何をテストしているのかを示します。
テストの状態：テストが成功したか、失敗したか、スキップされたか、などを示します。
失敗したテストのエラーメッセージとスタックトレース：テストが失敗した場合、何が悪かったのかを示すメッセージと、エラーが発生したコードのスタックトレースが表示されます。

これらの情報を用いて、問題の原因を特定し、それを解決するための手順を考えることができます。