CLI API リファレンス

Pestドキュメントの前章では、Pestで使用可能な多くのCLIオプションについて説明しました。しかし、Pestは他にも多くの便利なオプションを提供しています。完全なCLI APIリファレンスを以下に示します。

設定

  • --init: 標準的なPest設定を初期化します。
  • -c|--configuration <file>: XMLファイルから設定を読み込みます。
  • --no-configuration: デフォルトの設定ファイル(phpunit.xml)を無視します。
  • --no-extensions: PHPUnit拡張機能を読み込みません。
  • --include-path <path(s)>: 指定されたパスをPHPのinclude_pathの先頭に追加します。
  • -d <key[=value]>: php.iniの値を設定します。
  • --cache-directory <dir>: キャッシュディレクトリを指定します。
  • --generate-configuration: 推奨設定を含む設定ファイルを生成します。
  • --migrate-configuration: 設定ファイルを現在のフォーマットに移行します。
  • --test-directory: Pest.php、TestCase.php、ヘルパー、およびテストを含むテストディレクトリを指定します。デフォルト: tests

選択

  • --bail: 最初のテストが失敗したら実行を停止します。
  • --todos: ToDoリストを標準出力に出力します。
  • --retry: 失敗したテストを最初に実行し、最初のエラーまたは失敗時に実行を停止します。
  • --exclude-testsuite <name>: 指定されたテストスイートのテストを除外します。
  • --list-groups: 利用可能なテストグループを一覧表示します。
  • --group <name>: 指定されたグループのテストのみを実行します。
  • --exclude-group <name>: 指定されたグループのテストを除外します。
  • --covers <name>: <name>をカバーすることを目的としたテストのみを実行します。
  • --uses <name>: <name>を使用することを目的としたテストのみを実行します。
  • --list-tests: 利用可能なテストを一覧表示します。
  • --list-tests-xml <file>: 利用可能なテストをXML形式で一覧表示します。
  • --filter <pattern>: 実行するテストをフィルタリングします
  • --test-suffix <suffixes>: 指定されたサフィックスを持つファイル内のテストのみを検索します。デフォルト: Test.php,.phpt

実行

  • --globals-backup: 各テストに対して$GLOBALSをバックアップおよび復元します。
  • --static-backup: 各テストに対して静的プロパティをバックアップおよび復元します。
  • --strict-coverage: コードカバレッジメタデータについて厳密になります。
  • --strict-global-state: グローバル状態の変更について厳密になります。
  • --disallow-test-output: テスト中の出力について厳密になります。
  • --enforce-time-limit: テストのサイズに基づいてタイムリミットを適用します。
  • --default-time-limit <sec>: サイズが宣言されていないテストのタイムアウト秒数。
  • --dont-report-useless-tests: 何もテストしないテストを報告しません。
  • --stop-on-defect: 最初のテストが失敗したら実行を停止します。
  • --stop-on-error: 最初のエラー時に実行を停止します。
  • --stop-on-failure: 最初のエラーまたは失敗時に実行を停止します。
  • --stop-on-warning: 最初の警告時に実行を停止します。
  • --stop-on-risky: 最初のリスキーなテスト時に実行を停止します。
  • --stop-on-skipped: 最初のスキップされたテスト時に実行を停止します。
  • --stop-on-incomplete: 最初の不完全なテスト時に実行を停止します。
  • --fail-on-incomplete: 不完全なテストを失敗として扱います。
  • --fail-on-risky: リスキーなテストを失敗として扱います。
  • --fail-on-skipped: スキップされたテストを失敗として扱います。
  • --fail-on-warning: 警告を含むテストを失敗として扱います。
  • --cache-result: テスト結果をキャッシュファイルに書き込みます。
  • --do-not-cache-result: テスト結果をキャッシュファイルに書き込みません。
  • --order-by <order>: テストの実行順序を指定します: default|defects|depends|duration|no-depends|random|reverse|size。
  • --random-order-seed <N>: ランダムな順序でテストを実行する際に指定された乱数の種を使用します。

レポート

  • --colors <flag>: 出力に色を使用します ("never", "auto", "always")。
  • --columns <n>: プログレス出力に使用する列数。
  • --columns max: プログレス出力に最大列数を使用します。
  • --stderr: STDOUTの代わりにSTDERRに書き込みます。
  • --no-progress: テスト実行の進捗状況の出力を無効にします。
  • --no-results: テスト結果の出力を無効にします。
  • --no-output: 全ての出力を無効にします。
  • --display-incomplete: 不完全なテストの詳細を表示します。
  • --display-skipped: スキップされたテストの詳細を表示します。
  • --display-deprecations: テストによってトリガーされた非推奨事項の詳細を表示します。
  • --display-errors: テストによってトリガーされたエラーの詳細を表示します。
  • --display-notices: テストによってトリガーされた通知の詳細を表示します。
  • --display-warnings: テストによってトリガーされた警告の詳細を表示します。
  • --reverse-list: エラーを逆順で表示します。
  • --teamcity: デフォルトの進捗状況と結果の出力をTeamCity形式に置き換えます。
  • --testdox: デフォルトの結果出力をTestDox形式に置き換えます。
  • --compact: デフォルトの結果出力をコンパクト形式に置き換えます。

ログ

  • --log-junit <file>: テスト結果をJUnit XML形式でファイルに書き込みます。
  • --log-teamcity <file>: テスト結果をTeamCity形式でファイルに書き込みます。
  • --testdox-html <file>: テスト結果をTestDox形式(HTML)でファイルに書き込みます。
  • --testdox-text <file>: テスト結果をTestDox形式(プレーンテキスト)でファイルに書き込みます。
  • --log-events-text <file>: イベントをプレーンテキストとしてファイルにストリーミングします。
  • --log-events-verbose-text <file>: イベントをプレーンテキスト(テレメトリ情報付き)としてファイルにストリーミングします。
  • --no-logging: XML設定ファイルで設定されたログを無視します。

コードカバレッジ

  • --coverage: コードカバレッジレポートを生成し、標準出力に出力します。
  • --coverage --min=<value>: 必要な最小カバレッジ率を設定し、満たされていない場合は失敗します。
  • --coverage-crap4j <file>: コードカバレッジレポートをCrap4J XML形式でファイルに書き込みます。
  • --coverage-html <dir>: コードカバレッジレポートをHTML形式でディレクトリに書き込みます。
  • --coverage-php <file>: シリアル化されたコードカバレッジデータをファイルに書き込みます。
  • --coverage-text=<file>: コードカバレッジレポートをテキスト形式でファイルに書き込みます [デフォルト: 標準出力]。
  • --coverage-xml <dir>: コードカバレッジレポートをXML形式でディレクトリに書き込みます。
  • --warm-coverage-cache: 静的解析キャッシュをウォームアップします。
  • --coverage-filter <dir>: コードカバレッジレポートに<dir>を含めます。
  • --path-coverage: 行カバレッジに加えてパスカバレッジをレポートします。
  • --disable-coverage-ignore: コードカバレッジの無視に関するメタデータを無効にします。
  • --no-coverage: XML設定ファイルで設定されたコードカバレッジレポートを無視します。

プロファイリング

  • --profile: 最も遅い10個のテストを標準出力に出力します。

この章では、Pestが提供するCLIオプションの完全なリストを示しました。次のドキュメントでは、テスト依存関係について説明します: テスト依存関係