第5章コマンドラインのテストランナー

phpunit コマンドを実行すると、PHPUnit のコマンドライン版テストランナーが起動します。コマンドラインのテストランナーを使用したテストの様子を以下に示します。

phpunit ArrayTest
PHPUnit 3.4.14 by Sebastian Bergmann.

..

Time: 0 seconds


OK (2 tests, 2 assertions)

テストがひとつ実行されるたびに、PHPUnit コマンドラインツールはその経過を示す文字を出力します。

.: テストが成功した際に表示されます。
F: テストメソッドの実行中、アサーションに失敗した際に表示されます。
E: テストメソッドの実行中、エラーが発生した際に表示されます。
S: テストが飛ばされた場合に表示されます (第 10 章を参照ください)。
I: テストが「不完全」あるいは「未実装」とマークされている場合に表示されます (第 10 章を参照ください)。

PHPUnit は、失敗 (failures) と エラー (errors) を区別します。「失敗」は PHPUnit のアサーションに違反した場合、つまり例えば assertEquals() のコールに失敗した場合などで、「エラー」は予期せぬ例外や PHP のエラーが発生した場合となります。この区別は、時に有用です。というのは「エラー」は一般的に「失敗」より修正しやすい傾向があるからです。もし大量の問題が発生した場合は、まず「エラー」を最初に片付け、その後で「失敗」を修正していくのが最良の方法です。

以下のコードで、コマンドライン版テストランナーのスイッチの一覧を見てみましょう。

phpunit --help
PHPUnit 3.4.14 by Sebastian Bergmann.

Usage: phpunit [switches] UnitTest [UnitTest.php]
       phpunit [switches] <directory>

  --log-junit <file>       Log test execution in JUnit XML format to file.
  --log-tap <file>         Log test execution in TAP format to file.
  --log-json <file>        Log test execution in JSON format.

  --coverage-html <dir>    Generate code coverage report in HTML format.
  --coverage-clover <file> Write code coverage data in Clover XML format.
  --coverage-source <dir>  Write code coverage / source data in XML format.

  --story-html <file>      Write Story/BDD results in HTML format to file.
  --story-text <file>      Write Story/BDD results in Text format to file.

  --testdox-html <file>    Write agile documentation in HTML format to file.
  --testdox-text <file>    Write agile documentation in Text format to file.

  --filter <pattern>       Filter which tests to run.
  --group ...              Only runs tests from the specified group(s).
  --exclude-group ...      Exclude tests from the specified group(s).
  --list-groups            List available test groups.

  --loader <loader>        TestSuiteLoader implementation to use.
  --repeat <times>         Runs the test(s) repeatedly.

  --story                  Report test execution progress in Story/BDD format.
  --tap                    Report test execution progress in TAP format.
  --testdox                Report test execution progress in TestDox format.

  --colors                 Use colors in output.
  --stderr                 Write to STDERR instead of STDOUT.
  --stop-on-failure        Stop execution upon first error or failure.
  --verbose                Output more verbose information.
  --wait                   Waits for a keystroke after each test.

  --skeleton-class         Generate Unit class for UnitTest in UnitTest.php.
  --skeleton-test          Generate UnitTest class for Unit in Unit.php.

  --process-isolation      Run each test in a separate PHP process.
  --no-globals-backup      Do not backup and restore $GLOBALS for each test.
  --static-backup          Backup and restore static attributes for each test.
  --syntax-check           Try to check source files for syntax errors.

  --bootstrap <file>       A "bootstrap" PHP file that is run before the tests.
  --configuration <file>   Read configuration from XML file.
  --no-configuration       Ignore default configuration file (phpunit.xml).
  --include-path <path(s)> Prepend PHP's include_path with given path(s).
  -d key[=value]           Sets a php.ini value.

  --help                   Prints this usage information.
  --version                Prints the version and exits.

phpunit UnitTest

UnitTest という名前のクラスで定義されているテストを実行します。このクラスは、UnitTest.php という名前のファイルの中に定義されているものとします。

UnitTest は、PHPUnit_Framework_TestCase を継承したクラスであるか、あるいは PHPUnit_Framework_Test オブジェクト、例えば PHPUnit_Framework_TestSuite のインスタンスを返す public static suite() というメソッドを保持するクラスでなければなりません。

phpunit UnitTest UnitTest.php

UnitTest という名前のクラスで定義されているテストを実行します。このクラスは、指定したファイルの中で定義されているものとします。

--log-json

JSON フォーマットを使用して、ログファイルを作成します。詳細は第 19 章を参照ください。

--log-junit

JUnit XML フォーマットを使用して、テストの実行結果のログを作成します。詳細は第 19 章を参照ください。

--log-tap

Test Anything Protocol (TAP) フォーマットを使用して、テストの実行結果のログを作成します。詳細は第 19 章を参照ください。

--coverage-html

コードカバレッジレポートを HTML 形式で作成します。詳細は第 15 章を参照ください。

この機能は、tokenizer 拡張モジュールおよび Xdebug 拡張モジュールがインストールされている場合にのみ使用可能となることに注意しましょう。

--coverage-clover

テスト結果から XML 形式のログファイルを作成し、コードカバレッジ情報もそこに含めます。詳細は第 19 章を参照ください。

この機能は、tokenizer 拡張モジュールおよび Xdebug 拡張モジュールがインストールされている場合にのみ使用可能となることに注意しましょう。

--coverage-source

カバーする PHP ソースファイルごとにひとつずつの XML ファイルを、指定したディレクトリに作成します。各 <line> 要素には、コードカバレッジ情報がついた PHP ソースコードの行が保持されます。

この機能は、tokenizer 拡張モジュールおよび Xdebug 拡張モジュールがインストールされている場合にのみ使用可能となることに注意しましょう。

--story-html および --story-text

振舞駆動開発のシナリオとして実行するためのレポートを HTML あるいはプレーンテキスト形式で作成します。詳細は第 14 章を参照ください。

--testdox-html および --testdox-text

実行したテストについて、HTML あるいはプレーンテキスト形式のドキュメントを生成します詳細は第 16 章を参照ください。

--filter

指定したパターンにマッチする名前のテストのみを実行します。パターンとして指定できるのは、単一のテスト名か、あるいは複数のテスト名にマッチする正規表現です。

--group

指定したグループのテストのみを実行します。あるテストを特定のグループに所属させるには、 @group アノテーションを使用します。

--exclude-group

指定したグループをテストの対象外とします。あるテストを特定のグループに所属させるには、 @group アノテーションを使用します。

--list-groups

使用可能なテストグループの一覧を表示します。

--loader

PHPUnit_Runner_TestSuiteLoader を実装したクラスのうち、実際に使用するものを指定します。

標準のテストスイートローダーは、現在の作業ディレクトリおよび PHP の設定項目 include_path で指定されているディレクトリからソースファイルを探します。 PEAR の命名規則に従い、Project_Package_Class クラスがソースファイル Project/Package/Class.php に対応します。

--repeat

指定された回数だけ、繰り返しテストを実行します。

--story

テストの進捗状況レポートを、振舞駆動開発に適した形式で出力します。詳細は第 14 章を参照ください。

--tap

Test Anything Protocol (TAP) を使用して、テストの進行状況を報告します。詳細は第 19 章を参照ください。

--testdox

テストの進行状況を、アジャイルな文書として報告します。詳細は第 16 章を参照ください。

--colors

出力に色を使用します。

--syntax-check

テストソースファイルの構文チェックを有効にします。

--stderr

オプションで、出力先を STDOUT ではなく STDERR にします。

--stop-on-failure

最初にエラーあるいは失敗が発生した時点で実行を停止します。

--verbose

より詳細な情報を出力します。例えば、未完成のテストや省略したテストの名前が表示されます。

--wait

各テストが終了するたびにキー入力待ちの状態になります。これは、テストランナーが終了すると同時にウィンドウが閉じてしまうような場合に便利です。

--skeleton-class

(UnitTest.php に記述された) テストケースクラス UnitTest を元に、雛形クラス Unit を (Unit.php という名前で) 作成します。詳細は第 17 章を参照ください。

--skeleton-test

(UnitTest.php に記述された) Unit クラスに対して、テストケースクラス UnitTest の雛形を記述したファイル UnitTest.php を作成します。詳細は第 17 章を参照ください。

--process-isolation

各テストを個別の PHP プロセスで実行します。

--no-globals-backup

$GLOBALS のバックアップ・リストアを行いません。詳細は「グローバルな状態」を参照ください。

--static-backup

ユーザ定義クラスの静的属性のバックアップ・リストアを行います。詳細は「グローバルな状態」を参照ください。

--bootstrap

テストの前に実行される "ブートストラップ" PHP ファイルを指定します。

--configuration

設定を XML ファイルから読み込みます。詳細は付録 C を参照ください。

phpunit.xml あるいは phpunit.xml.dist (この順番で使用します) が現在の作業ディレクトリに存在しており、かつ --configuration が使われていない場合、設定が自動的にそのファイルから読み込まれます。

--no-configuration

現在の作業ディレクトリにある phpunit.xml および phpunit.xml.dist を無視します。

--include-path

PHP の include_path の先頭に、指定したパスを追加します。

-d

指定した PHP 設定オプションの値を設定します。

注記

テストしようとしているコードに PHP の文法エラーがあった場合は、コマンドラインのテストランナーは何もエラー情報を表示せずに終了します。標準のテストスイートローダーは、テストスイート自体のソースファイルについてはオプションで PHP の文法チェックをしますが、テストスイートが include しているその他のファイルについてはチェックしません。

1. 自動テスト

2. PHPUnit の目標

3. PHPUnit のインストール

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