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

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

phpunit ArrayTest
PHPUnit 3.7.0 by Sebastian Bergmann.

..

Time: 0 seconds


OK (2 tests, 2 assertions)

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

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

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

Command-Line switches

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

phpunit --help
PHPUnit 3.7.0 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-clover <file>  Generate code coverage report in Clover XML format.
  --coverage-html <dir>     Generate code coverage report in HTML format.
  --coverage-php <file>     Serialize PHP_CodeCoverage object to file.
  --coverage-text=<file>    Generate code coverage report in text format.
                            Default to writing to the standard output.

  --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.
  --printer <printer>       TestSuiteListener implementation to use.
  --repeat <times>          Runs the test(s) repeatedly.

  --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-error           Stop execution upon first error.
  --stop-on-failure         Stop execution upon first error or failure.
  --stop-on-skipped         Stop execution upon first skipped test.
  --stop-on-incomplete      Stop execution upon first incomplete test.
  --strict                  Run tests in strict mode.
  -v|--verbose              Output more verbose information.
  --debug                   Display debbuging information during test execution.

  --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.

  --bootstrap <file>        A "bootstrap" PHP file that is run before the tests.
  -c|--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.

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

  --debug                   Output debugging information.

phpunit UnitTest

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

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

phpunit UnitTest UnitTest.php

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

--log-junit

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

--log-tap

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

--log-json

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

--coverage-html

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

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

--coverage-clover

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

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

--coverage-php

シリアライズした PHP_CodeCoverage オブジェクトを生成し、コードカバレッジ情報もそこに含めます。

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

--coverage-text

テストを実行したときに、ログファイルあるいはコマンドライン出力で可読形式のコードカバレッジ情報を生成します。詳細は第 18 章を参照ください。

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

--testdox-html and --testdox-text

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

--filter

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

--group

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

@author アノテーションは @group のエイリアスで、テストの作者に基づいてテストをフィルタリングします。

--exclude-group

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

--list-groups

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

--loader

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

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

--printer