VSTest.Console.exe のコマンド ライン オプション

VSTest.Console.exe は、テストを実行するためのコマンドライン ツールです。 コマンド ラインには、いくつかのオプションを任意の順序で指定できます。 これらのオプションは、「一般的なコマンドライン オプション」に一覧表示されています。

Note

Visual Studio の MSTest アダプターは、互換性のためにレガシ モード (mstest.exe によるテストの実行と同等) でも動作します。 レガシ モードでは、TestCaseFilter 機能を利用することはできません。 アダプターをレガシ モードに切り替えることができるのは、.testsettings ファイルが指定されている場合、runsettings ファイルで forcelegacymode が true に設定されている場合、または HostType などの属性を使用した場合です。

ARM アーキテクチャ ベースのコンピューターで自動テストを実行するには、VSTest.Console.exe を使用する必要があります。

開発者コマンド プロンプトを開いてコマンドライン ツールを使用します。ツールは "%Program Files(x86)%\Microsoft Visual Studio\<バージョン>\<エディション>\common7\ide\CommonExtensions\<プラットフォーム | Microsoft>" にもあります。

一般的なコマンドライン オプション

次の表は、VSTest.Console.exe のすべてのオプションとその簡単な説明の一覧です。 これと同じような概要は、コマンド ラインで「VSTest.Console/?」と入力すると表示できます。

オプション	説明
[テストファイル名]	指定されたファイルからテストを実行します。 複数のテスト ファイル名を指定するときは、スペースで区切ります。 例: mytestproject.dll、mytestproject.dll myothertestproject.exe
/Settings:[ファイル名]	データ コレクターなどの追加設定を指定してテストを実行します。 詳細については、「.runsettings ファイルを使用して単体テストを構成する」をご覧ください 例: /Settings:local.runsettings
/Tests:[テスト名]	指定した値を含む名前のテストを実行します。 このコマンドでは、名前空間を含む、完全なテスト名と照合します。 複数の値を指定するには、コンマで区切ります。 例: /Tests:TestMethod1,testMethod2 /Tests コマンドライン オプションを、/TestCaseFilter コマンドライン オプションと一緒に使用することはできません。
/Parallel	テストを並列で実行するように指定します。 既定では、マシン上のすべての利用可能なコア数まで使用できます。 使用するコアの数は、設定ファイルで構成できます。
/Enablecodecoverage	テストの実行で、データ診断アダプター CodeCoverage を有効にします。 設定ファイルで指定されていない場合は、既定の設定が使用されます。
/InIsolation	分離プロセスでテストを実行します。 この分離により、テストでエラーが発生しても vstest.console.exe プロセスが停止することは少なくなりますが、テストの実行速度は低下する可能性があります。
/UseVsixExtensions	このオプションでは、テストの実行の際に、vstest.console.exe プロセスでインストール済みの VSIX 拡張機能 (ある場合) を使用するかスキップするかを指定します。 このオプションは非推奨です。 Visual Studio の次のメジャー リリース以降、このオプションは削除される可能性があります。 NuGet パッケージとして利用可能な拡張機能の使用に移行してください。 例: /UseVsixExtensions:true
/TestAdapterPath:[パス]	vstest.console.exe プロセスで、テストの実行の際に指定されたパス (ある場合) からカスタム テスト アダプターを使用するように強制します。 例: /TestAdapterPath:[pathToCustomAdapters]
/Platform:[プラットフォームの種類]	現在のランタイムから決定されたプラットフォームではなく、指定されたプラットフォームを強制的に使用します。 このオプションは Windows 上で x86 および x64 プラットフォームのみを強制できます。 ARM オプションは破損しており、結果的に大半のシステムで x64 になります。 ARM64 などの有効な値の一覧に含まれていないランタイムで実行する場合は、このオプションを指定しないでください。 有効な値は x86、x64、ARM です。
/Framework: [フレームワークのバージョン]	テストの実行に使用する対象の .NET バージョンを指定します。 Framework35、Framework40、Framework45、FrameworkUap10、.NETCoreApp,Version=v1.1 のような値があります。 TargetFrameworkAttribute は、ご利用のアセンブリからこのオプションを自動的に検出するために使用されます。その属性が存在しない場合、既定値は Framework40 になります。 ご利用の .NET Core アセンブリから TargetFrameworkAttribute を削除する場合は、このオプションを明示的に指定する必要があります。 ターゲット フレームワークが Framework35 として指定されている場合、テストは CLR 4.0 の "互換性モード" で実行されます。 例: /Framework:framework40
/TestCaseFilter:[式]	指定した式に一致するテストを実行します。 <式> は、<プロパティ>=<値>[|<式>] という形式です。 例: /TestCaseFilter:"Priority=1" 例: /TestCaseFilter:"TestCategory=Nightly|FullyQualifiedName=Namespace.ClassName.MethodName" /TestCaseFilter コマンドライン オプションを、/Tests コマンドライン オプションと一緒に使用することはできません。 式の作成と使用については、「TestCase filter」(TestCase フィルター) を参照してください。
/?	使用方法に関する情報を表示します。
/Logger:[uri/friendlyname]	テスト結果のロガーを指定します。 複数のロガーを有効にするには、パラメーターを複数回指定します。 例: Visual Studio テスト結果ファイル (TRX) に結果をログに記録するには、 /Logger:trx [;LogFileName=<一意のファイル名の既定値>]
/ListTests: [ファイル名]	指定されたテスト コンテナーから探索されたテストを一覧表示します。 注: このオプションは /TestCaseFilters 、テストを一覧表示する場合は影響を与えず、実行されるテストのみを制御します。
/ListDiscoverers	インストール済みのテスト探索プログラムを一覧表示します。
/ListExecutors	インストール済みのテスト実行プログラムを一覧表示します。
/ListLoggers	インストール済みのテスト ロガーを一覧表示します。
/ListSettingsProviders	インストール済みのテスト設定プロバイダーを一覧表示します。
/Blame	変更履歴モードでテストを実行します。 このオプションは、テスト ホストがクラッシュする原因となる問題のあるテストを分離するために役立ちます。 クラッシュが検出されると、クラッシュ前に実行されたテストの順序をキャプチャするシーケンス ファイルが TestResults/<Guid>/<Guid>_Sequence.xml に作成されます。 詳細については、「Blame データ コレクター」を参照してください。
/Diag:[ファイル名]	指定されたファイルに診断トレース ログを書き込みます。
/ResultsDirectory:[path]	テスト結果ディレクトリが存在しない場合、指定されたパスに作成されます。 例: /ResultsDirectory:<pathToResultsDirectory>
/ParentProcessId:[parentProcessId]	現在のプロセスを起動する親プロセスのプロセス ID です。
/Port:[port]	ソケット接続およびイベント メッセージの受信用のポートです。
/Collect:[dataCollector friendlyName]	テストの実行のためのデータ コレクターを有効にします。 詳細。

ヒント

オプションと値の大文字と小文字は区別されません。

例

vstest.console.exe を実行するための構文は、次のとおりです。

vstest.console.exe [TestFileNames] [Options]

既定では、テストが検出されなくても、正常に終了すると、コマンドから 0 が返されます。 テストが検出されない場合に 0 以外の値を返す場合は、<TreatNoTestsAsError>true</TreatNoTestsAsError> runsettings オプションを使います。

次のコマンドでは、テスト ライブラリ myTestProject.dll の vstest.console.exe が実行されます。

vstest.console.exe myTestProject.dll

次のコマンドでは、複数のテスト ファイルを使用して vstest.console.exe が実行されます。 テスト ファイル名は次のようにスペースで区切ります。

vstest.console.exe myTestFile.dll myOtherTestFile.dll

次のコマンドでは、いくつかのオプションを使用して vstest.console.exe が実行されます。 分離プロセスで myTestFile.dll ファイル内のテストが実行され、Local.RunSettings ファイルで指定された設定が使用されます。 さらに、"Priority=1" とマークされているテストのみが実行され、結果は .trx ファイルに記録されます。

vstest.console.exe myTestFile.dll /Settings:Local.RunSettings /InIsolation /TestCaseFilter:"Priority=1" /Logger:trx

次のコマンドでは、テスト ライブラリ myTestProject.dll の vstest.console.exe が /blame オプションを使用して実行されます。

vstest.console.exe myTestFile.dll /blame

テスト ホストのクラッシュが発生した場合は、sequence.xml ファイルが生成されます。 このファイルには、クラッシュ時に実行されていた特定のテストまで (特定のテストを含む) の実行の順序での、テストの完全修飾名が含まれます。

テスト ホストのクラッシュが一切発生していない場合、sequence.xml ファイルは生成されません。

生成された sequence.xml ファイルの例を次に示します。

<?xml version="1.0"?>
<TestSequence>
  <Test Name="TestProject.UnitTest1.TestMethodB" Source="D:\repos\TestProject\TestProject\bin\Debug\TestProject.dll" />
  <Test Name="TestProject.UnitTest1.TestMethodA" Source="D:\repos\TestProject\TestProject\bin\Debug\TestProject.dll" />
</TestSequence>

UWP の例

UWP の場合、DLL ではなく appxrecipe ファイルを参照する必要があります。

vstest.console.exe /Logger:trx /Platform:x64 /framework:frameworkuap10 UnitTestsUWP\bin\x64\Release\UnitTestsUWP.build.appxrecipe