ほとんどの場合、PHPUnit を使用する際には以下の 5 つのクラスやインターフェイスに出会うことになるでしょう。

PHPUnit の、5 つの基本クラス/インターフェイスである PHPUnit2_Framework_Assert、 PHPUnit2_Framework_Test、 PHPUnit2_Framework_TestCase、 PHPUnit2_Framework_TestSuite および PHPUnit2_Framework_TestResult の関係を 図14.1「PHPUnit の 5 つの基本クラス/インターフェイス」 に示します。

図14.1 PHPUnit の 5 つの基本クラス/インターフェイス

PHPUnit 用に書かれたテストケースのほとんどは、間接的に PHPUnit2_Framework_Assert を継承しています。ここには、 値を自動的にチェックして矛盾を報告するためのメソッドが含まれています。 これらのメソッドは静的に宣言されているので、 あなたが作成したメソッドの中で「規約による設計」方式のアサーションを使用し、 PHPUnit に結果を報告させることができます (例14.1「「規約による設計」方式のアサーション」 を参照ください)。

<?php
require_once 'PHPUnit2/Framework/Assert.php';
 
class Sample {
    public function aSampleMethod($object) {
        PHPUnit2_Framework_Assert::assertNotNull($object);
    }
}
 
$sample = new Sample;
$sample->aSampleMethod(NULL);
?>

Fatal error: Uncaught exception 'PHPUnit2_Framework_AssertionFailedError'
with message 'expected: <NOT NULL> but was: <NULL>'

しかし、ほとんどの場合はこれらのアサーションはテストの中で行います。

各アサーションメソッドには 2 種類の方式があります。 エラー時に表示されるメッセージをパラメータとして指定する方法としない方法です。 オプションで指定したメッセージは、通常はテストが失敗したことが報告される場面で 表示されます。これにより、デバッグが楽になります。

<?php
require_once 'PHPUnit2/Framework/TestCase.php';
 
class MessageTest extends PHPUnit2_Framework_TestCase {
    public function testMessage() {
        $this->assertTrue(FALSE, 'これは独自のメッセージです。');
    }
}
?>

以下の例は、 例14.2「メッセージつきのアサーション」 のテスト testMessage() でメッセージつきのアサーションを使用した場合の出力結果です。

phpunit MessageTest.php
PHPUnit 2.3.0 by Sebastian Bergmann.

F

Time: 0.102507
There was 1 failure:
1) testMessage(MessageTest)
これは独自のメッセージです。

FAILURES!!!
Tests run: 1, Failures: 1, Errors: 0, Incomplete Tests: 0.

表14.1「アサーション」 に、すべてのアサーションをまとめます。

これら以外に、プロジェクトで使用している オブジェクト固有のアサーションが必要になることもあるでしょう。独自の Assert クラスを作成し、 そこに独自のアサーションを含めてテストに使用することができます。

アサーションに失敗すると、ボトルネックメソッド fail(string $message) がコールされ、これは PHPUnit2_Framework_AssertionFailedError をスローします。 このメソッドにもパラメータなしのものがあります。テストでエラーが発生した際に、 fail() を明示的にコールします。 例外が発生することが期待されるテストなどがその例になります。 表14.2「ボトルネックメソッド」 に、PHPUnit のボトルネックメソッドをまとめます。

PHPUnit2_Framework_Test は、 テストとして働くすべてのオブジェクトが使用する、 一般的なインターフェイスです。これを実装したオブジェクトは、 ひとつあるいは複数のテストを表すことになります。 表14.3「実装することになるメソッド」 に示す 2 つのメソッドが定義されています。

PHPUnit2_Framework_Test の実装クラスとして有名なのは、 PHPUnit2_Framework_TestCase および PHPUnit2_Framework_TestSuite の 2 つです。 PHPUnit2_Framework_Test を実装したクラスを独自に作成することも可能です。 このインターフェイスはあえて小規模に設計されているので、実装するのは簡単でしょう。

テストケースクラスは PHPUnit2_Framework_TestCase クラスを継承して作成します。たいていの場合は、 テストスイートから自動的にテストを実行させることになるでしょう。 この場合、(規約により) 各テストは test* という名前のメソッドにしておかなければなりません。

PHPUnit2_Framework_TestCase は PHPUnit2_Framework_Test::countTestCases() を実装しており、 これは常に 1 を返します。このクラスで実装されている PHPUnit2_Framework_Test::run(PHPUnit2_Framework_TestResult $result) は、まず setUp() を実行し、テストメソッドを実行し、 それから tearDown() を実行し、その結果を PHPUnit2_Framework_TestResult に報告します。

PHPUnit2_Framework_TestCase によって実装されている外部プロトコルを 表14.4「TestCase の外部プロトコル」 にまとめます。

このクラスには 2 つのテンプレートメソッド setUp() および tearDown() が存在します。これをオーバーライドすると、 実行しようとしているテストに関する前処理や後始末を行うことができます。 表14.5「テンプレートメソッド」 にこれらのメソッドをまとめます。

PHPUnit2_Framework_TestSuite は複数の PHPUnit2_Framework_Test を組み合わせたものです。 簡単に言うと、このクラスには複数のテストケースが含まれており、 テストスイートを実行するとそれらの全てのテストが実行されます。 テストスイートは composite なので、テストスイートの中に別のテストスイートを含め、 さらにそのテストスイートの中には別のテストスイートが含まれており…… といったことも可能です。これにより、 いろいろなところから集めたテストをひとまとめにすることが簡単になります。

run(PHPUnit2_Framework_TestResult $result) および countTestCases() の 2 つに加え、 PHPUnit2_Framework_TestSuite は名前つきインスタンス、 名前なしインスタンスを作成するためのプロトコルも用意しています。 PHPUnit2_Framework_TestSuite のインスタンスを作成するための方法を 表14.6「名前つき、あるいは名前なしインスタンスの作成」 に示します。

PHPUnit2_Framework_TestSuite には、 PHPUnit2_Framework_Test を追加したり取得したりするためのプロトコルも用意されています。これを 表14.7「テストの追加、取得のためのプロトコル」 にまとめます。

例14.3「テストスイートの作成および実行」 に、テストスイートを作成して実行する方法を示します。

<?php
require_once 'PHPUnit2/Framework/TestSuite.php';
 
require_once 'ArrayTest.php';
 
// ArrayTest クラスのテストを含む
// テストスイートを作成します。
$suite = new PHPUnit2_Framework_TestSuite('ArrayTest');
 
// テストを実行します。
$suite->run();
?>

階層化されたテストケースを組み合わせた PHPUnit2_Framework_TestSuite の使用例として、PHPUnit 自身のテストスイートを見てみましょう。

例14.4「AllTests クラス」 は Tests/AllTests.php の一部を抜粋したもの、そして 例14.5「Framework_AllTests クラス」 は Tests/Framework/AllTests.php の一部を抜粋したものです。

<?php
if (!defined('PHPUnit2_MAIN_METHOD')) {
    define('PHPUnit2_MAIN_METHOD', 'AllTests::main');
}
 
require_once 'PHPUnit2/Framework/TestSuite.php';
require_once 'PHPUnit2/TextUI/TestRunner.php';
 
require_once 'Framework/AllTests.php';
// ...
 
class AllTests {
    public static function main() {
        PHPUnit2_TextUI_TestRunner::run(self::suite());
    }
 
    public static function suite() {
        $suite = new PHPUnit2_Framework_TestSuite('PHPUnit');
 
        $suite->addTest(Framework_AllTests::suite());
        // ...
 
        return $suite;
    }
}
 
if (PHPUnit2_MAIN_METHOD == 'AllTests::main') {
    AllTests::main();
}
?>

<?php
if (!defined('PHPUnit2_MAIN_METHOD')) {
    define('PHPUnit2_MAIN_METHOD', 'Framework_AllTests::main');
}
 
require_once 'PHPUnit2/Framework/TestSuite.php';
require_once 'PHPUnit2/TextUI/TestRunner.php';
 
require_once 'Framework/AssertTest.php';
// ...
 
class Framework_AllTests {
    public static function main() {
        PHPUnit2_TextUI_TestRunner::run(self::suite());
    }
 
    public static function suite() {
        $suite = new PHPUnit2_Framework_TestSuite('PHPUnit Framework');
 
        $suite->addTestSuite('Framework_AssertTest');
        // ...
 
        return $suite;
    }
}
 
if (PHPUnit2_MAIN_METHOD == 'Framework_AllTests::main') {
    Framework_AllTests::main();
}
?>

Framework_AssertTest クラスは、 PHPUnit2_Framework_TestCase を継承した一般的なテストケースです。

Tests/AllTests.php を実行すると、TextUI テストランナーを使用し、すべてのテストを実行します。一方 Tests/Framework/AllTests.php を実行すると、 PHPUnit2_Framework_* クラスのテストのみを実行します。

PHPUnit テストスイートの実行結果は、このようになります。

php AllTests.php
PHPUnit 2.3.0 by Sebastian Bergmann.

.........................................
.........................................
.......

Time: 4.642600

OK (89 tests)

これらのテストを実行している間は、実行したテストの数・失敗したテスト・ テストの所要時間などをどこかに保存しておかなければなりません。 これらの結果を収集するのが PHPUnit2_Framework_TestResult です。ひとつの PHPUnit2_Framework_TestResult が、 テスト全体で使いまわされます。テストの実行結果や失敗の内容は PHPUnit2_Framework_TestResult に記録されていき、 実行が終了すると、PHPUnit2_Framework_TestResult には全てのテストの概要が含まれるようになります。

PHPUnit2_Framework_TestResult は、 テストの進行状況を知りたい他のオブジェクトから参照されることもあります。 例えば、グラフィカルなテストランナーは PHPUnit2_Framework_TestResult を監視し、各テストの開始時にプログレスバーを更新するでしょう。

表14.8「TestResult の外部プロトコル」 は、 PHPUnit2_Framework_TestResult の外部プロトコルをまとめたものです。

PHPUnit2_Framework_TestResult のオブザーバを登録したい場合は、PHPUnit2_Framework_TestListener を実装する必要があります。これを登録するには、 表14.9「TestResult および TestListener」 に示した addListener() を使用します。

表14.10「TestListener のコールバック」 に、テストリスナーが実装するメソッドを示します。 例15.3「シンプルなテストリスナー」 も参照ください。

この本で取り上げたクラスの多くは PHPUnit2/Framework にあるものです。ここには PHPUnit のすべてのパッケージが含まれています。