Microsoft.Testing.Platform CLI オプション リファレンス

この記事では、Microsoft.Testing.Platform コマンド ライン オプションの中心的なエントリ ポイントについて説明します。

プラットフォームのオプション

• @

  応答ファイルの名前を指定します。 応答ファイル名は、@文字と応答ファイル名の間に空白のない@文字の直後に続く必要があります。

  応答ファイル内のオプションは、コマンド ラインのその場所にあるかのように解釈されます。 円記号文字 \ を使用して行を連結することはできません。 応答ファイルを使用すると、ターミナルの制限を超える可能性がある非常に長いコマンドに役立ちます。 応答ファイルをインラインのコマンド ライン引数と組み合わせることができます。 例えば次が挙げられます。

  ./TestExecutable.exe @"filter.rsp" --timeout 10s
  

  filter.rsp は次の内容を含むことができます。

  --filter "A very long filter"
  

  または、1 つの rsp ファイルを使用して、タイムアウトとフィルターの両方を次のように指定できます。

  ./TestExecutable.exe @"arguments.rsp"
  

  --filter "A very long filter" --timeout 10s
  

  注

  dotnet testを使用する場合、SDK コマンド ライン パーサーは、応答ファイル内の各行が 1 つのトークンとして扱われる、1 行ごとのトークンアプローチを使用します。 その場合、各引数は別々の行に配置する必要があります。

  --filter
  A very long filter
  --timeout
  10s
  

• --config-file

  testconfig.json ファイルを指定します。

• --diagnostic

  診断ログを有効にします。 デフォルトのログ レベルは Trace です。 ファイルは、次の名前形式 log_[MMddHHssfff].diag で出力ディレクトリに書き込まれます。

• --diagnostic-synchronous-write

  組み込みのファイル ロガーにログの同期的な書き込みを強制します。 (プロセスがクラッシュした場合に) ログ エントリを少しも失いたくないときのシナリオに役立ちます。 これにより、テストの実行が遅くなります。

• --diagnostic-output-directory

  指定しない場合、診断ログの出力ディレクトリとして、ファイルはデフォルトの TestResults ディレクトリに生成されます。

• --diagnostic-file-prefix

  ログ ファイル名のプレフィックス。 既定値は "log" です。

• --diagnostic-verbosity

  --diagnostic スイッチを使用するときの詳細レベルを定義します。 使用できる値は Trace、Debug、Information、Warning、Error、Critical です。

• --exit-on-process-exit

  依存プロセスが終了した場合は、テスト プロセスを終了します。 PID を指定する必要があります。

• --help

  コマンドの使用方法を示した説明を出力します。

• --ignore-exit-code

  一部の 0 以外の終了コードを無視し、代わりに 0 として返すようにします。 詳細については、「特定の終了コードを無視する」を参照してください。

• --info

  .NET テスト アプリケーションに関する次のような詳細情報を表示します。

  • プラットフォーム。
  • 環境。
  • 各登録済みコマンド ライン プロバイダー (name、version、description、optionsなど)。
  • 登録されている各ツール (command、name、version、description、すべてのコマンド ライン プロバイダーなど)。

  この機能は、同じコマンド ライン オプションを登録する拡張機能や、拡張機能 (またはプラットフォーム) の複数のバージョン間で使用可能なオプションの変更を理解するのに使用されます。

• --list-tests

  使用可能なテストを一覧表示します。 テストは実行されません。

• --maximum-failed-tests

  テストの実行を停止するテストエラーの最大数を指定します。 このスイッチをサポートするには、フレームワーク作成者が IGracefulStopTestExecutionCapability 機能を実装する必要があります。 テストエラーの量に達したときの終了コードは 13 です。 詳細については、「Microsoft.Testing.Platform 終了コードの」を参照してください。

  注

  この機能は、バージョン 1.5 以降の Microsoft.Testing.Platform で使用できます。

• --minimum-expected-tests

  実行する必要があるテストの最小数を指定します。 既定では、少なくとも 1 つのテストが実行されることが想定されています。

• --results-directory

  テスト結果が配置されるディレクトリです。 指定されたディレクトリが存在しない場合は、作成されます。 既定値は、テスト アプリケーションを含むディレクトリ内の TestResults です。

• --timeout

  グローバル テストの実行タイムアウト。 1 つの引数を、<value>[h|m|s] が float である <value> 形式で文字列として受け取ります。

シナリオ別の拡張機能オプション

拡張機能のオプションをすばやく見つけるには、次の表を使用します。

Scenario	機能に関するドキュメント
コード カバレッジを収集する	コードカバレッジ
クラッシュ ダンプまたはハング ダンプを収集する	クラッシュ ダンプおよびハング ダンプ
テスト レポートの生成 (TRX など)	テスト レポート
ターミナル出力をカスタマイズする	ターミナル出力
ホスティング レベルのコントロールを適用する	ホット リロード
失敗したテストを再試行する	再試行
Microsoft Fakes を使用するテストを実行する	Microsoft Fakes
OpenTelemetry トレースとメトリックを出力する	OpenTelemetry

テスト アプリのオプションを検出する

--helpを使用してテスト実行可能ファイルを実行し、現在の拡張機能セットで使用できるオプションを一覧表示します。

登録済みのプロバイダーとオプションの高度な診断を行う場合は、 --infoを使用して実行します。

こちらも参照ください

• Microsoft.Testing.Platform の概要
• Microsoft.Testing.Platform の機能
• を使用したテスト dotnet test