MSTest の構成

Microsoft テスト フレームワークである MSTest は、.NET アプリケーション向けテスト フレームワークです。 これにより、テストの記述および実行が可能になり、Visual Studio と Visual Studio Code テスト エクスプローラー、.NET CLI、および多くの CI パイプラインに統合されたテスト スイートを提供できます。

MSTest は、完全にサポートされているオープンソースのクロスプラットフォーム テスト フレームワークで、GitHub でホストされ、サポートされているすべての .NET ターゲット (.NET Framework、.NET Core、.NET、UWP、WinUI など) で動作します。

実行設定

.runsettings ファイルを使って、単体テストの実行方法を構成できます。 runsettings とプラットフォームに関連する構成の詳細については、VSTest の runsettings のドキュメント、または MSTest ランナーの runsettings のドキュメントを確認してください。

MSTest 要素

次の runsettings エントリを使用すると、MSTest の動作を構成できます。

タイムアウト値は、ミリ秒単位の正の整数である必要があります。 タイムアウトなしで実行するには、 0に設定するのではなく、エントリを省略します。 グローバルテストフィクスチャタイムアウトは、対応する TestInitializeTimeout または TestCleanupTimeout 値を継承します。

TestRunParameter 要素

<TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
</TestRunParameters>

テスト実行パラメーターは、実行時にテストで使用できる変数と値を定義する方法を提供します。 パラメーターには MSTest TestContext.Properties プロパティを使ってアクセスします。

private string _appUrl;
public TestContext TestContext { get; set; }

[TestMethod]
public void HomePageTest()
{
    string _appUrl = TestContext.Properties["webAppUrl"];
}

テスト実行パラメーターを使用するには、パブリックの TestContext プロパティをテスト クラスに追加します。

.runsettings ファイルの例

次の XML は、一般的な .runsettings ファイルの内容を示しています。 このコードをコピーし、自分のニーズに合わせて編集します。

ファイルの各要素には既定値があるため、省略可能です。

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>

  <!-- Parameters used by tests at runtime -->
  <TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
    <Parameter name="webAppUserName" value="Admin" />
    <Parameter name="webAppPassword" value="Password" />
  </TestRunParameters>

  <!-- MSTest -->
  <MSTest>
    <MapInconclusiveToFailed>True</MapInconclusiveToFailed>
    <CaptureTraceOutput>false</CaptureTraceOutput>
    <DeleteDeploymentDirectoryAfterTestRunIsComplete>False</DeleteDeploymentDirectoryAfterTestRunIsComplete>
    <DeploymentEnabled>False</DeploymentEnabled>
    <ConsiderFixturesAsSpecialTests>False</ConsiderFixturesAsSpecialTests>
    <AssemblyResolution>
      <Directory path="D:\myfolder\bin\" includeSubDirectories="false"/>
    </AssemblyResolution>
  </MSTest>

</RunSettings>

testconfig.json

MSTest を使用してテストを実行する場合は、testconfig.json ファイルを使用してテスト ランナーの動作を構成できます。 testconfig.json ファイルは、テスト ランナーの構成設定を含む JSON ファイルです。 このファイルは、テスト ランナーとテスト実行環境を構成するために使用されます。 詳細については、 MTP testconfig.json ドキュメントを参照してください。

MSTest 3.7 以降では、同じ構成ファイルで MSTest の実行を構成することもできます。 次のセクションでは、testconfig.json ファイルで使用できる設定について説明します。

MSTest 4.3.3 以降では、.NET Framework の実行では、testconfig.jsonのコメントと末尾のコンマも受け入れられます。

MSTest 要素

MSTest 設定は、以降のセクションで説明する機能ごとにグループ化されます。

assemblyResolution 設定

このセクションのすべての設定は、assemblyResolution 要素に属しています。

例：

{
  "mstest": {
    "assemblyResolution": {
        { "path": "...", "includeSubDirectories": "true/false" }
    }
  }
}

deployment 設定

このセクションのすべての設定は、deployment 要素に属しています。

例：

{
  "mstest": {
    "deployment": {
        "deleteDeploymentDirectoryAfterTestRunIsComplete": true,
        "deployTestSourceDependencies": true,
        "enabled": true
    }
  }
}

output 設定

このセクションのすべての設定は、output 要素に属しています。

例：

{
  "mstest": {
    "output": {
        "captureTrace": false
    }
  }
}

parallelism 設定

このセクションのすべての設定は、parallelism 要素に属しています。

例：

{
  "mstest": {
    "parallelism": {
        "enabled": true,
        "scope": "method",
        "workers": 32
    }
  }
}

execution 設定

このセクションのすべての設定は、execution 要素に属しています。

例：

{
  "mstest": {
    "execution": {
        "considerEmptyDataSourceAsInconclusive": false,
        "considerFixturesAsSpecialTests": false,
        "mapInconclusiveToFailed": true,
        "mapNotRunnableToFailed": true,
        "treatClassAndAssemblyCleanupWarningsAsErrors": false,
        "treatDiscoveryWarningsAsErrors": false
    }
  }
}

timeout 設定

このセクションのすべての設定は、timeout 要素に属しています。

例：

{
  "mstest": {
    "timeout": { "globalTestInitialize": 30000, "globalTestCleanup": 30000 }
  }
}

testconfig.json ファイルの例

次の JSON は、一般的な .testconfig.json ファイルの内容を示しています。 このコードをコピーし、自分のニーズに合わせて編集します。

ファイルの各要素には既定値があるため、省略可能です。

{
  "platformOptions": {
    "resultDirectory": "./TestResults"
  },
  "mstest": {
    "execution": {
        "mapInconclusiveToFailed": true,
        "disableAppDomain": true,
        "considerFixturesAsSpecialTests": false
    },
    "parallelism": {
        "enabled": true,
        "scope": "method"
    },
    "output": {
        "captureTrace": false
    }
  }
}

MSBuild プロパティ

MSTest 4.3 以降では、プロジェクト ファイルからアセンブリ レベルの並列化を選択するか、Directory.Build.props属性を作成せずに[assembly: Parallelize]します。 これらのプロパティは、ビルド時に対応するアセンブリ属性を出力するため、 GenerateAssemblyInfo を true する必要があります (SDK スタイルのプロジェクトの既定)。

MSTest は、ビルド中に両方のプロパティを検証します。 無効なスコープ値、整数以外のワーカー数、および None スコープと組み合わせたワーカー数は、ビルドに失敗します。 生成された属性は重複するため、ソースで [assembly: Parallelize] または [assembly: DoNotParallelize] も宣言しないでください。 GenerateAssemblyInfoがfalse場合は、代わりにソースで属性を宣言します。

次の例では、 Directory.Build.props ファイルをインポートするすべてのテスト プロジェクトに対して、4 つの worker を使用してメソッド レベルの並列化を有効にします。

<Project>
  <PropertyGroup>
    <MSTestParallelizeScope>MethodLevel</MSTestParallelizeScope>
    <MSTestParallelizeWorkers>4</MSTestParallelizeWorkers>
  </PropertyGroup>
</Project>