第7章テストの構成

PHPUnit の目指すところ (第 2 章を参照ください) のひとつに「自由に組み合わせられる」ということがあります。つまり、例えば「そのプロジェクトのすべてのテストを実行する」「プロジェクトの中のある部品を構成するすべてのクラスについて、すべてのテストを実行する」「特定のひとつのクラスのテストのみを実行する」など、数や組み合わせにとらわれずに好きなテストを一緒に実行できるということです。

PHPUnit では、さまざまな方法でテストを組み合わせてテストスイートにまとめることができます。本章では、その中でもよく使われる手法を説明します。

ファイルシステムを用いたテストスイートの構成

おそらく、テストスイートをとりまとめるもっとも簡単な方法はすべてのテストケースのソースファイルを一つのテストディレクトリにまとめることでしょう。 PHPUnit はテストディレクトリを再帰的に探索し、テストを自動的に見つけて実行します。

Object_Freezer ライブラリのテストスイートを見てみましょう。このプロジェクトのディレクトリ構成を見ると、テストケースクラスが Tests ディレクトリにまとめられていることがわかります。その中のディレクトリの構造は、テスト対象のシステム (SUT) がある Object ディレクトリ以下の構造と同じになっています。

Object                              Tests
|-- Freezer                         |-- Freezer
|   |-- HashGenerator               |   |-- HashGenerator
|   |   `-- NonRecursiveSHA1.php    |   |   `-- NonRecursiveSHA1Test.php
|   |-- HashGenerator.php           |   |
|   |-- IdGenerator                 |   |-- IdGenerator
|   |   `-- UUID.php                |   |   `-- UUIDTest.php
|   |-- IdGenerator.php             |   |
|   |-- LazyProxy.php               |   |
|   |-- Storage                     |   |-- Storage
|   |   `-- CouchDB.php             |   |   `-- CouchDB
|   |                               |   |       |-- WithLazyLoadTest.php
|   |                               |   |       `-- WithoutLazyLoadTest.php
|   |-- Storage.php                 |   |-- StorageTest.php
|   `-- Util.php                    |   `-- UtilTest.php
`-- Freezer.php                     `-- FreezerTest.php

PHPUnit のコマンドラインテストランナーにテストディレクトリの場所を指示してやるだけで、このライブラリのすべてのテストを実行できます。

phpunit Tests
PHPUnit 3.5.13 by Sebastian Bergmann.

............................................................ 60 / 75
...............

Time: 0 seconds

OK (75 tests, 164 assertions)

注記

PHPUnit のコマンドラインテストランナーでディレクトリを指定すると、その中の *Test.php ファイルを見つけて実行します。

Tests/FreezerTest.php にあるテストケースクラス Object_FreezerTest で宣言されているテストだけを実行するには、次のコマンドを実行します。

phpunit Tests/FreezerTest
PHPUnit 3.5.13 by Sebastian Bergmann.

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

Time: 0 seconds

OK (28 tests, 60 assertions)

実行したいテストをより細かく指示するには --filter スイッチを使います。

phpunit --filter testFreezingAnObjectWorks Tests
PHPUnit 3.5.13 by Sebastian Bergmann.

.

Time: 0 seconds

OK (1 test, 2 assertions)

注記

この方式の欠点は、テストの実行順を制御できないことです。そのため、テストの依存性に関する問題を引き起こすことがあります。「テストの依存性」を参照ください。次の節では、テストの実行順序を XML 設定ファイルで明示的に指定する方法を説明します。

XML 設定ファイルを用いたテストスイートの構成

PHPUnit の XML 設定ファイル (付録 C) を使ってテストスイートを構成することもできます。例 7.1 に、最小限の例を示します。これは、 Tests を再帰的に探索して *Test.php というファイルにある *Test クラスをすべて追加する設定です。

例 7.1: XML 設定ファイルを用いたテストスイートの構成

<phpunit>
  <testsuites>
    <testsuite name="Object_Freezer">
      <directory>Tests</directory>
    </testsuite>
  </testsuites>
</phpunit>

どのテストを実行するのかを明示的に指定することができます。

例 7.2: XML 設定ファイルを用いたテストスイートの構成

<phpunit>
  <testsuites>
    <testsuite name="Object_Freezer">
      <file>Tests/Freezer/HashGenerator/NonRecursiveSHA1Test.php</file>
      <file>Tests/Freezer/IdGenerator/UUIDTest.php</file>
      <file>Tests/Freezer/UtilTest.php</file>
      <file>Tests/FreezerTest.php</file>
      <file>Tests/Freezer/StorageTest.php</file>
      <file>Tests/Freezer/Storage/CouchDB/WithLazyLoadTest.php</file>
      <file>Tests/Freezer/Storage/CouchDB/WithoutLazyLoadTest.php</file>
    </testsuite>
  </testsuites>
</phpunit>

1. 自動テスト

2. PHPUnit の目標

3. PHPUnit のインストール

4. PHPUnit 用のテストの書き方