Microsoft.Testing.Platform アーキテクチャ

新しいテストプラットフォームへようこそ。その機能を理解しやすくするために、まず、テストを登録して実行する方法を示す簡単な例から始めます。この基本的な例では、コア機能と、すぐに開始する方法を確実に理解できます。

注

この記事のすべての概念は、完全なサンプルとして Microsoft Test Framework リポジトリで例示されています。詳細については、サンプルコードを参照してください。

手順 1: 単純なテストアプリケーションを登録して実行する

この最初の例では、テストアプリケーションを宣言して実行するための基本的な手順について説明します。この簡単な方法により、最小限のセットアップでプラットフォームの使用をすぐに開始できます。

手順 2: プラットフォームの拡張

最初のテストアプリケーションを作成する方法を確認したら、拡張機能の例を調べて、テストアプリケーション拡張機能を取り巻く概念の一部を説明します。

手順 3: 拡張ポイントの包括的な概要

基本に慣れたら、さまざまな拡張ポイントを掘り下げます。これには以下が含まれます。

プラットフォームとテストフレームワークの機能: プラットフォームとテストフレームワークによって提供されるあらゆる機能を理解し、それらを効果的に活用できます。
カスタムテストフレームワーク: カスタムテストフレームワークを記述して登録する方法。テスト環境を特定の要件に合わせて調整できます。
In-Process およびアウトプロセス拡張機能: インプロセス拡張機能とアウトプロセス拡張機能の両方を記述および登録する方法の詳細な手順により、プラットフォームを拡張する方法に柔軟性が提供されます。
実行順序: カスタム拡張機能のシームレスな統合と操作を保証するために、さまざまな拡張ポイントの実行順序を明確にします。

手順 4: 利用可能なサービスとヘルパー

最後に、プラットフォーム内で使用可能なサービスとヘルパー関数の完全な一覧を確認します。このセクションは、すべてのツールを自由に活用して、堅牢で効率的なテスト拡張機能を作成するのに役立つリファレンスとして機能します。

この構造化されたアプローチに従うことで、基本的な使用方法から高度なカスタマイズまで、テストプラットフォームの包括的な理解を得ることができます。始めて、プラットフォームが提供できる可能性を最大限に引き出しましょう。

手順 1: 単純なテストアプリケーションを登録して実行する

このドキュメントでは、テストプラットフォームのアーキテクチャを紹介するために、ホストとしてクラシックコンソールアプリケーション (Windows 用) を使用します。このドキュメントのサンプルは C# で記述されていますが、.NET Ecma 仕様をサポートする任意の言語でテストプラットフォームを使用し、.NET でサポートされている任意の OS で実行できます。プラットフォームを使用するには、 Microsoft.Testing.Platform.dll アセンブリを参照するだけです。このアセンブリは、 https://www.nuget.org/packages/Microsoft.Testing.Platformで入手できる公式の NuGet パッケージを通じて使用できます。

コンソールプロジェクト Contoso.UnitTests.exeでは、次の Main メソッドによってエントリポイントが定義されます。

public static async Task<int> Main(string[] args)
{
    ITestApplicationBuilder builder = await TestApplication.CreateBuilderAsync(args);
    
    builder.RegisterTestFramework();
    
    using ITestApplication testApp = await builder.BuildAsync();
    
    return await testApp.RunAsync();
}

このコードには、MSTest などのテストフレームワークを RegisterTestFramework 経由で登録する場合を除き、テストセッションの実行に必要なすべてのものが含まれます。このコードについては、後のセクションで説明します。

注

既定の動作では、テストプラットフォーム MSBuild タスクによってエントリポイントが自動的に生成されます。これを行うには、 Microsoft.Testing.Platform.MSBuild パッケージをプロジェクトに追加します。

Contoso.UnitTests.exeアプリケーションが開始されると、標準の Windows プロセスが作成され、テストプラットフォームは登録済みのテストフレームワークと対話してテストセッションを実行します。

この作業を実行するために、1 つのプロセスが作成されます。

テストプラットフォームには、次のようなテストセッション情報をターミナルに書き込む組み込みのディスプレイデバイスが含まれています。

Microsoft(R) Testing Platform Execution Command Line Tool
Version: 1.1.0+8c0a8fd8e (UTC 2024/04/03)
RuntimeInformation: win-x64 - .NET 9.0.0-preview.1.24080.9
Copyright(c) Microsoft Corporation.  All rights reserved.
Passed! - Failed: 0, Passed: 1, Skipped: 0, Total: 1, Duration: 5ms - Contoso.UnitTests.dll (win-x64 - .NET 9.0.0-preview.1.24080.9)

注

ITestApplication.RunAsync()呼び出しによって返される既知の終了コードは、プラットフォーム出口コードで詳しく説明されています。

手順 2: プラットフォームの拡張

テストの実行では、通常、コードカバレッジ情報または同様の情報を収集してコードの品質を評価します。このようなワークロードでは、テストホストプロセスの開始前に構成が必要になる場合があります (環境変数の設定など)。

テストプラットフォームでは、 アウトプロセス 拡張機能を使用することで、これに対応します。アウトプロセス拡張機能を使用して実行すると、テストプラットフォームは複数のプロセスを開始し、適切に管理します。

次の例では、 TestHostController 拡張機能を使用してコードカバレッジ機能を登録する方法を示します。

ITestApplicationBuilder builder = await TestApplication.CreateBuilderAsync(args);

builder.RegisterTestFramework();
builder.AddCodeCoverage();

using ITestApplication testApp = await builder.BuildAsync();

return await testApp.RunAsync();

builder.AddCodeCoverage();は、プロセス外の拡張ポイントであるTestHostController拡張ポイントを内部的に使用します。

public static class TestApplicationBuilderExtensions
{
    public static ITestApplicationBuilder AddCodeCoverage(
        this ITestApplicationBuilder builder)
    {
        builder.TestHostControllers
               .AddEnvironmentVariableProvider(/* ... */);
        
        // ...
        
        return builder;
    }
}

api AddEnvironmentVariableProvider のパラメーターについては、後のセクションで説明します。

今回 Contoso.UnitTests.exe 実行すると、 TestHostController 拡張機能が登録されていることがテストプラットフォームによって検出されます。その結果、 Contoso.UnitTests.exe プロセスの別のインスタンスが子プロセスとして開始されます。これは、 AddEnvironmentVariableProvider API に登録されている拡張機能で必要に応じて環境変数を適切に設定するために行われます。

プロセスレイアウトは次のようになります。

注

この例では、開始プロセスを正しく処理し、すべてのコマンドライン引数を子プロセスに伝達するコンソールアプリケーションレイアウトを想定しています。別のホストを使用している場合は、エントリポイントコードによってプロセスエントリポイント ("Main") が適切なコードブロックに正しく転送されるようにする必要があります。ランタイムは、単に同じコマンドライン引数を使用して起動します。

上記のセクションでは、テストプラットフォームのアーキテクチャについて簡単に説明します。現在の機能拡張ポイントは、次の 2 つのカテゴリに分かれています。

インプロセス 拡張機能には、テストアプリケーションビルダーの TestHost プロパティを使用してアクセスできます。インプロセスとは、テストフレームワークと同じプロセスで実行されることを意味します。
```
ITestApplicationBuilder builder = await TestApplication.CreateBuilderAsync(args);

builder.RegisterTestFramework();

builder.TestHost.AddXXX(/* ... */);
```
実際、最も重要な拡張ポイントは、インプロセス テストフレームワーク (RegisterTestFramework) です。これは唯一必須のフレームワークです。
プロセス外拡張機能 には、テストアプリケーションビルダーの TestHostControllers プロパティを使用してアクセスできます。これらの拡張機能は、テストフレームワークとは別のプロセスで実行され、"監視" されます。
```
ITestApplicationBuilder builder = await TestApplication.CreateBuilderAsync(args);

builder.TestHostControllers.AddXXX(/* ... */);
```

手順 3: 拡張ポイントの包括的な概要

まず、さまざまな拡張ポイントに進む前に、機能の概念を理解することから始めましょう。

手順 4: 利用可能なサービス

テストプラットフォームは、テストフレームワークと拡張ポイントの両方に貴重なサービスを提供します。これらのサービスは、構成へのアクセス、コマンドライン引数の解析と取得、ログファクトリの取得、ログシステムへのアクセスなどの一般的なニーズに対応します。 IServiceProvider は、テストプラットフォームの サービスロケーターパターン を実装します。

これらのサービスにアクセスして使用する方法に関するすべてのサービス、ヘルパー、技術情報は、 Microsoft.Testing.Platform Services のドキュメントに記載されています。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-06-17

次の方法で共有

Microsoft.Testing.Platform アーキテクチャ

手順 1: 単純なテスト アプリケーションを登録して実行する

手順 2: プラットフォームの拡張

手順 3: 拡張ポイントの包括的な概要

手順 4: 利用可能なサービス

フィードバック

その他のリソース

手順 1: 単純なテストアプリケーションを登録して実行する