MSTest 生命週期

MSTest 為測試類別與測試方法提供明確的生命週期,讓您能在測試執行的不同階段執行設定與拆除操作。 了解生命週期有助於撰寫有效率的測試並避免常見陷阱。

生命週期概述

生命週期分為四個階段,依最高層級(組裝)到最低層級(測試方法)執行:

  1. 組裝層級:測試組件載入與卸載時執行一次
  2. 類別級別:每個測試類別僅執行一次
  3. 全域測試層級:在組裝中每個測試方法前後執行
  4. 測試級別:針對每個測試方法運行(包括參數化測試中的每個資料列)

元件層級生命週期

組裝生命週期方法在測試組裝檔載入與卸載時執行一次。 用這些工具做昂貴的一次性設定,例如資料庫初始化或服務啟動。

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!);
    }
}

需求

  • 方法必須是 public static
  • 回傳類型: void、 Task,或 ValueTask (MSTest v3.3+)
  • AssemblyInitialize 需要一個 TestContext 參數
  • AssemblyCleanup 接受零參數或單一 TestContext 參數(MSTest 3.8+)
  • 每個組件僅允許每種屬性一個
  • 必須在標示為[TestClass]的類別中。

小提示

相關分析儀:

含有 AssemblyFixtureProvider 的共用裝配夾具

備註

AssemblyFixtureProviderAttribute 是在 MSTest 4.3.0 中引入的。

預設情況下, [AssemblyInitialize] 且 [AssemblyCleanup] 必須在使用這些方法的測試組件中宣告。 用 AssemblyFixtureProviderAttribute 來公開共用夾具類型的這些方法。 MSTest 會在每個使用共享方法的測試組件中執行一次共享方法,而非在整個測試執行期間只執行一次。

// In a shared library.
public static class SharedAssemblyFixtures
{
    [AssemblyInitialize]
    public static void Init(TestContext context)
    {
        // Runs once per consuming test assembly.
    }

    [AssemblyCleanup]
    public static void Cleanup()
    {
    }
}

若要讓參考共用程式庫的測試組件可存取 SharedAssemblyFixtures,請 在共用程式庫中加入以下組件層級屬性:

[assembly: AssemblyFixtureProvider(typeof(SharedAssemblyFixtures))]

當共用函式庫可透過其編譯組件參考存取時,使用共用函式庫的測試組件就不需要重複該屬性。 MSTest 會自動搜尋非框架組件參考圖,包括傳遞參考。 標記器用來識別組件所供應的夾具類型;它不會將使用該夾具的測試組件納入提供者探索機制。

自動發現會跟隨已編譯組件中繼資料中所發出的引用,而非每個 ProjectReference 或 PackageReference。 如果共享函式庫只包含測試固定裝置,且消費者未另行參考其型別,編譯器可能會從組件參考圖中省略該函式庫。 僅有專案或套件參考並不保證能被發現。

若要明確註冊一個僅用於夾具的函式庫,或若無法修改共用函式庫,請將 [assembly: AssemblyFixtureProvider(typeof(SharedAssemblyFixtures))] 放入使用該函式庫的測試組件中。 該標記器同時提供明確的編譯參考與夾具註冊。 你不需要在執行時呼叫函式庫 API 來強制載入。 參考的 Fixture 類型可能存在於未宣告 provider marker 的函式庫中。

警告

從 MSTest 4.4 開始,當不支援動態程式碼時,MSTest 會略過 AssemblyFixtureProviderAttribute 探索,包括原生 AOT 執行。 使用 Native AOT 測試組件中直接宣告的夾具方法。 MSTEST0072 分析器會報告它可在建置時偵測到的組態。

本地方法與重複提供者

本機組件生命週期方法會各自優先套用:

  • 本地 [AssemblyInitialize] 方法覆蓋共享初始化。 共用清理仍然可以執行。
  • 區域 [AssemblyCleanup] 方法會覆寫共用清理作業。 共享初始化仍可執行。
  • 若測試組合同時宣告兩個本地方法,MSTest 則跳過共享提供者搜尋。

該屬性允許多個提供者宣告,但每個消耗測試組件最多只能使用一個初始化方法和一個清理方法。 若多個合格共享方法填滿同一插槽,且無本地方法優先,MSTest 會報告錯誤。

MSTest 4.3.0 至 4.5.2 中的組裝載入副作用

在 MSTest 4.3.0 至 4.5.2 中,基於反射的提供者發現會在測試流程走過傳遞參考圖時,將參考的非框架組件載入測試程序,在檢查提供者標記之前。 即使沒有共用夾具供應商,搜尋仍可載入原本未使用且未標記的組件。

這些額外的載入作業可能會改變GetAssemblies()結果,並在使用 .NET Framework 的 Windows 上鎖定 DLL。

Important

如果你的測試依賴未使用的組件維持未載入狀態且不使用共用夾具,針對受影響的版本,暫時的因應措施是宣告 兩者:本機 [AssemblyInitialize] 方法和本機 [AssemblyCleanup] 方法。 在這兩種本機方法中,MSTest 都會跳過此提供者掃描。 只宣告一個局部方法並不會停止掃描。 這個變通方法可以繞過共用測試夾具的行為;它不是 MSTest 必須的樣板,也不會阻止其他程式碼載入組件。

中繼資料優先探索(未公開)

Important

以元資料為優先的提供者探索正在開發中。 MSTest 4.5.2 仍使用上述基於反射的搜尋。 尚未分配固定發行版本,且未接受 4.5 維護版本的回移植。

為避免僅因提供者掃描造成的負載,以元資料為優先的實作會從可攜式執行檔(PE)元資料讀取組件參考與提供者標記。

僅中繼資料的決策需要相符的組件識別,以及由執行階段繫結資料支援的路徑。 在現代 .NET 上,MSTest 使用預設載入上下文中執行時提供的可信平台組件(TPA)映射。 在 .NET Framework 中,僅限中繼資料的判斷僅限於應用程式基目錄中未簽名、文化中立的參考,沒有繫結或主機覆寫。 對於符合這些要求的未載入參考,MSTest 可以遍歷未標記的組件,而不必將其載入測試程序。

僅靠元件相依性解析器建議的 DLL 或路徑,無法確定執行階段如何繫結該參考項目。

實際提供者、由 consumer 標記註冊的固定裝置類型及其執行階段相依性仍可正常載入。 MSTest 保留現有的組件繫結與載入內容識別;相同的內容並不妨礙首次組件載入。

為了保留現有的執行時綁定行為,MSTest 在以下情況下使用執行時解析,而非僅中繼資料的決策:

  • 受信任的中繼資料路徑無法使用,或中繼資料讀取或解析嘗試失敗。
  • 消費者則使用自訂的組件載入內容。
  • 即使其完整識別與參考相符,擁有該簡單名稱的組件已經載入。
  • 在 .NET Framework 中,全域組件快取(GAC)、強命名繫結、已載入的組件映像、繫結重新導向、codeBase 項目,或未知的繫結或主機原則都可能影響解析。

備用診斷包括 using runtime resolution for AssemblyFixtureProvider discovery。 遺失的元資料路徑會產生資訊性痕跡;元資料讀取或解析失敗會產生警告。 後援機制可以在 Windows 上載入未標記的函式庫,並在 Windows 的 .NET Framework 上鎖定它們的 DLL。 因此,元資料優先發現並不保證所有被參考的組件都保持未載入或可刪除。

現有的標記放置規則、本地方法優先順序、重複提供者診斷及原生AOT限制仍然適用。

無論 .runsettings 或 testconfig.json 都不提供可啟用或停用共享提供者探索的開關。 關於可用的設定選項,請參見 配置 MSTest。

類別層級生命週期

類別生命週期方法在每個測試類別中執行一次,分別在該類別中所有測試方法之前和之後執行一次。 在類別中使用這些方法來共享測試的配置。

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);
    }
}

需求

  • 方法必須是 public static
  • 回傳類型: void、 Task,或 ValueTask (MSTest v3.3+)
  • ClassInitialize 需要一個 TestContext 參數
  • ClassCleanup 接受零參數或單一 TestContext 參數(MSTest 3.8+)
  • 每種職業的每種屬性只能有一個

備註

自 MSTest 4.2 起,MSTest 會將 ClassCleanup 和 AssemblyCleanup 中的失敗回報為個別的測試結果。 獨立結果使清理失敗更容易在測試瀏覽器與 TRX 報告中辨識。

繼承行為

控制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
    }
}
繼承行為 Description
None (預設值) 初始化僅針對宣告類別進行
BeforeEachDerivedClass 在每個衍生類別之前完成初始化執行

小提示

相關分析儀:

  • MSTEST0010 - 驗證 ClassInitialize 簽名。
  • MSTEST0011 - 驗證 ClassCleanup 簽名。
  • MSTEST0034 - 建議使用 ClassCleanupBehavior.EndOfClass。

全球測試階段生命週期

備註

全域測試生命週期屬性於 MSTest 3.10.0 中引入。

全域測試生命週期方法會在整個組件中執行 於每個 測試方法前後,無需在每個測試類別中新增程式碼。

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}");
    }
}

需求

  • 方法必須是 public static
  • 回傳類型: void、 Task或 ValueTask
  • 必須有恰好一個 TestContext 參數
  • 必須在標示為[TestClass]的類別中。
  • 在整個組件中允許多種具有這些屬性的方法

備註

當多個 GlobalTestInitialize 或 GlobalTestCleanup 方法存在時,執行順序並不保證。 從 MSTest 4.4 開始,全域固定裝置方法支援 [Timeout] 以及專用的 全域固定裝置逾時設定。

小提示

相關分析器: MSTEST0050 - 驗證全域測試夾具方法。

測試層級生命週期

每個測試方法都會執行其階段性的生命週期。 對於參數化測試,生命週期會對每個資料列執行。

從主機服務建立測試類別

從 MSTest 4.5 開始,實驗性 MSTest.Extensions.Hosting 套件允許由應用程式擁有的 Microsoft.Extensions.Hosting 容器建立 MSTest 測試類別。

在同一台運行 MTP 的主機上註冊整合:

HostApplicationBuilder builder = Host.CreateApplicationBuilder();
builder.Services.AddSingleton<MyApplicationService>();
builder.Services.AddMSTestTestClassInjection();

測試類別可透過公開建構子請求註冊服務及可選的精確 TestContext 參數:

[TestClass]
public sealed class MyTests(MyApplicationService service, TestContext testContext)
{
    [TestMethod]
    public void ServiceIsAvailable() => Assert.IsNotNull(service);
}

此整合會為每次測試叫用建立一個相依性插入範圍,包括每個資料列和每次重試。 TestInitialize,測試方法,並 TestCleanup 共享相同的測試類別實例與作用域。 清理後,MSTest 會丟棄測試類別實例,然後丟棄作用域。 應用程式仍然擁有主機和根服務提供者。

第一個以反射為基礎的整合不支援原生 AOT、瀏覽器 WebAssembly、AOT 編譯或 MSTest 來源產生。 AddMSTestTestClassInjection API 使用 MSTESTEXP 診斷 ID,且可能會在未來版本中變更。 關於主機設定,請參見 Microsoft。擴充整合。

小提示

相關分析器:MSTEST0063 會驗證建構函式是否適用於由主機擁有的相依性插入,而 MSTEST0088 會報告不支援的建置模式。

設置階段

使用 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);
    }
}

建構器與測試初始化:

層面 建構函式 測試初始化
非同步支援 否 Yes
暫停支援 否 是的(帶有 [Timeout] 屬性)
執行順序 第一 建構器之後
遺產 基礎然後推導 基礎然後推導
例外行為 清理與處理不會執行(沒有實例) 清理與處理系統仍在運行

小提示

我應該使用哪一種方法? 建構子一般較受偏好,因為它們允許使用 readonly 欄位,這能強制不變性,並讓你的測試類別更容易理解。 當你需要非同步初始化或逾時支援時使用 TestInitialize 。

你也可以結合兩種方法:用建構子來做 readonly 簡單的同步初始化,並用 TestInitialize 來做依賴這些欄位的額外非同步設定。

你可以選擇啟用程式碼分析器,以強制執行一致的方法:

  • MSTEST0019 - 偏好 TestInitialize 方法勝過建構子
  • MSTEST0020 - 偏好建構子而非 TestInitialize 方法。

執行階段

測試方法在設定完成後執行。 對於 async 測試方法,MSTest 等待返回 Task 或 ValueTask。

警告

非同步測試方法預設不會有SynchronizationContext。 這不適用於 UITestMethod UWP 和 WinUI 的測試,因為它們是在 UI 執行緒上執行。

清理階段

使用 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 (若實作)

小提示

你可以選擇啟用程式碼分析器,以強制執行一致的清理方法:

  • MSTEST0021 - 偏好處置而非測試清理方法
  • MSTEST0022 - 偏好 TestCleanup 而非 Dispose 方法

如果你啟用了非 MSTest 分析器,例如.NET程式碼分析規則,你可能會看到 CA1001建議在測試類別擁有可拋棄資源時實作丟棄模式。 這是預期中的行為,你應該遵循分析器的指示。

完整的測試層級順序

  1. 建立測試類別實例(建構子)
  2. Set 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:每個測試都會執行全域生命週期方法,因此保持簡便。

另請參閱