MSTest ライフサイクル

MSTest には、テスト クラスとテスト メソッドの明確に定義されたライフサイクルが用意されており、テスト実行のさまざまな段階でセットアップ操作と破棄操作を実行できます。 ライフサイクルを理解することは、効率的なテストを記述し、一般的な落とし穴を回避するのに役立ちます。

ライフサイクルの概要

ライフサイクルは、最高レベル (アセンブリ) から最下位レベル (テスト メソッド) に実行される 4 つのステージにグループ化されます。

1. アセンブリ レベル: テスト アセンブリの読み込みとアンロード時に 1 回実行されます
2. クラス レベル: テスト クラスごとに 1 回実行
3. グローバル テスト レベル: アセンブリ内のすべてのテスト メソッドの前後に実行されます
4. テスト レベル: 各テスト メソッドに対して実行されます (パラメーター化されたテストの各データ行を含む)

アセンブリ レベルのライフサイクル

アセンブリ ライフサイクル メソッドは、テスト アセンブリの読み込みとアンロード時に 1 回実行されます。 データベースの初期化やサービスの起動など、コストの高い 1 回限りのセットアップに使用します。

AssemblyInitialize および AssemblyCleanup

[TestClass]
public class AssemblyLifecycleExample
{
    private static IHost? _host;

    [AssemblyInitialize]
    public static async Task AssemblyInit(TestContext context)
    {
        // Runs once before any tests in the assembly
        _host = await StartTestServerAsync();
        context.WriteLine("Test server started");
    }

    [AssemblyCleanup]
    public static async Task AssemblyCleanup(TestContext context)
    {
        // Runs once after all tests complete
        // TestContext parameter available in MSTest 3.8+
        if (_host != null)
        {
            await _host.StopAsync();
        }
    }

    private static Task<IHost> StartTestServerAsync()
    {
        // Server initialization
        return Task.FromResult<IHost>(null!);
    }
}

Requirements

• メソッドは〘 public static
• 戻り値の型: void、 Task、または ValueTask (MSTest v3.3 以降)
• AssemblyInitialize には、1 つの TestContext パラメーターが必要です
• AssemblyCleanup 0 個のパラメーターまたは 1 つの TestContext パラメーターを受け取ります (MSTest 3.8 以降)
• アセンブリごとに許可される各属性の 1 つだけ
• でマークされたクラスに存在する必要があります [TestClass]

クラス レベルのライフサイクル

クラス ライフサイクル メソッドは、テスト クラスごとに、そのクラスのすべてのテスト メソッドの前後に 1 回実行されます。 これらは、クラス内のテスト間で共有されるセットアップに使用します。

ClassInitialize および ClassCleanup

[TestClass]
public class ClassLifecycleExample
{
    private static HttpClient? _client;

    [ClassInitialize]
    public static void ClassInit(TestContext context)
    {
        // Runs once before any tests in this class
        _client = new HttpClient
        {
            BaseAddress = new Uri("https://api.example.com")
        };
    }

    [ClassCleanup]
    public static void ClassCleanup()
    {
        // Runs after all tests in this class complete
        _client?.Dispose();
    }

    [TestMethod]
    public async Task GetUsers_ReturnsSuccess()
    {
        HttpResponseMessage response = await _client!.GetAsync("/users");
        Assert.IsTrue(response.IsSuccessStatusCode);
    }
}

Requirements

• メソッドは〘 public static
• 戻り値の型: void、 Task、または ValueTask (MSTest v3.3 以降)
• ClassInitialize には、1 つの TestContext パラメーターが必要です
• ClassCleanup 0 個のパラメーターまたは 1 つの TestContext パラメーターを受け取ります (MSTest 3.8 以降)
• クラスごとに許可される各属性の 1 つだけ

継承の振る舞い

ClassInitializeを使って、派生クラスがInheritanceBehaviorを実行するかどうかを制御します。

[TestClass]
public class BaseTestClass
{
    [ClassInitialize(InheritanceBehavior.BeforeEachDerivedClass)]
    public static void BaseClassInit(TestContext context)
    {
        // Runs before each derived class's tests
    }
}

[TestClass]
public class DerivedTestClass : BaseTestClass
{
    [TestMethod]
    public void DerivedTest()
    {
        // BaseClassInit runs before this class's tests
    }
}

グローバルテストレベルライフサイクル

グローバル テスト ライフサイクル メソッドは、各テスト クラスにコードを追加する必要なく、アセンブリ全体 のすべての テスト メソッドの前後に実行されます。

GlobalTestInitialize および GlobalTestCleanup

[TestClass]
public class GlobalTestLifecycleExample
{
    [GlobalTestInitialize]
    public static void GlobalTestInit(TestContext context)
    {
        // Runs before every test method in the assembly
        context.WriteLine($"Starting test: {context.TestName}");
    }

    [GlobalTestCleanup]
    public static void GlobalTestCleanup(TestContext context)
    {
        // Runs after every test method in the assembly
        context.WriteLine($"Finished test: {context.TestName}");
    }
}

Requirements

• メソッドは〘 public static
• 戻り値の型: void、 Task、または ValueTask
• TestContext パラメーターは正確に 1 つである必要があります。
• でマークされたクラスに存在する必要があります [TestClass]
• これらの属性を持つ複数のメソッドがアセンブリ全体で許可される

試験段階のライフサイクル

テスト レベルのライフサイクルは、すべてのテスト メソッドに対して実行されます。 パラメーター化されたテストの場合、ライフサイクルはデータ行ごとに実行されます。

セットアップ フェーズ

テストごとのセットアップには、 TestInitialize またはコンストラクターを使用します。

[TestClass]
public class TestLevelSetupExample
{
    private Calculator? _calculator;

    public TestLevelSetupExample()
    {
        // Constructor runs before TestInitialize
        // Use for simple synchronous initialization
    }

    [TestInitialize]
    public async Task TestInit()
    {
        // Runs before each test method
        // Supports async, attributes like Timeout
        _calculator = new Calculator();
        await _calculator.InitializeAsync();
    }

    [TestMethod]
    public void Add_TwoNumbers_ReturnsSum()
    {
        int result = _calculator!.Add(2, 3);
        Assert.AreEqual(5, result);
    }
}

コンストラクターと TestInitialize:

実行フェーズ

テスト メソッドは、セットアップが完了した後に実行されます。 asyncテスト メソッドの場合、MSTest は返されたTaskまたはValueTaskを待機します。

クリーンアップ フェーズ

テストごとのクリーンアップには、 TestCleanup または IDisposable/IAsyncDisposable を使用します。

[TestClass]
public class TestLevelCleanupExample
{
    private HttpClient? _client;

    [TestInitialize]
    public void TestInit()
    {
        _client = new HttpClient();
    }

    [TestCleanup]
    public void TestCleanup()
    {
        if (_client != null)
        {
            _client.Dispose();
        }
    }

    [TestMethod]
    public async Task GetData_ReturnsSuccess()
    {
        HttpResponseMessage response = await _client!.GetAsync("https://example.com");
        Assert.IsTrue(response.IsSuccessStatusCode);
    }
}

クリーンアップの実行順序 (基本に派生):

1. TestCleanup (派生クラス)
2. TestCleanup (基底クラス)
3. DisposeAsync (実装されている場合)
4. Dispose (実装されている場合)

テスト段階の順序を完了する

1. テスト クラス (コンストラクター) のインスタンスを作成する
2. プロパティ TestContext 設定する (存在する場合)
3. GlobalTestInitialize メソッドを実行する
4. TestInitialize メソッドを基底から派生クラスまで実行する
5. テスト メソッドの実行
6. 結果で TestContext を更新する ( Outcome プロパティなど)
7. TestCleanup メソッドを実行する (派生クラスから基本クラスへ)
8. GlobalTestCleanup メソッドを実行する
9. DisposeAsyncを実行する (実装されている場合)
10. Disposeを実行する (実装されている場合)

ベスト プラクティス

1. 適切なスコープを使用する: 冗長な作業を回避するために、セットアップを最も高いレベルに配置します。

2. セットアップを高速に保つ: 実行時間の長いセットアップは、すべてのテストに影響します。 コストの高いリソースについては、遅延初期化を検討してください。

3. 適切にクリーンアップする: 常にリソースをクリーンアップして、テストの干渉とメモリ リークを防ぎます。

4. 非同期を正しく処理する: 戻り値の型async Taskを使用し、async voidではなく非同期ライフサイクル メソッドにしてください。

5. テストの分離を検討する: 各テストは独立している必要があります。 テスト間で変更可能な状態を共有しないようにします。

6. GlobalTest を慎重に使用する: グローバル ライフサイクル メソッドは、すべてのテストに対して実行されるため、軽量に保ちます。

こちらも参照ください

• MSTest でテストを記述する
• テストの実行と制御
• TestContext クラス