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 类型可以驻留在未声明提供程序标记的库中。

警告

从 MSTest 4.4 开始,如果不支持动态代码(包括在 Native AOT 运行时),MSTest 将跳过对 AssemblyFixtureProviderAttribute 的发现。 对于本机 AOT,请使用直接在测试程序集中声明的固定例程方法。 MSTEST0072 分析器会报告它能够在生成时检测到的配置。

本地方法和重复提供程序

本地程序集生命周期方法会独立优先生效:

  • 本地 [AssemblyInitialize] 方法会重写共享的初始化。 共享清理仍可运行。
  • 本地 [AssemblyCleanup] 方法会重写共享的清理。 共享的初始化仍可运行。
  • 如果测试程序集同时声明这两个本地方法,MSTest 将跳过共享提供程序搜索。

该属性允许多个提供程序声明,但每个消耗的测试程序集最多可以使用一个初始化方法和一个清理方法。 如果多个符合条件的共享方法填充相同的槽,并且没有本地方法优先,MSTest 将报告错误。

MSTest 4.3.0 到 4.5.2 中的程序集加载副作用

在 MSTest 4.3.0 到 4.5.2 中,基于反射的提供程序发现会在遍历传递性引用图时,在检查提供程序标记之前,将引用的非框架程序集加载到测试进程中。 即使不存在任何共享固定例程提供程序,该搜索过程仍会加载那些原本未被使用且未标记的程序集。

这些额外的加载会改变 GetAssemblies() 的结果,并且在 Windows 上使用 .NET Framework 时还会锁定 DLL。

Important

如果测试依赖于未使用的程序集保持未加载状态,并且没有使用共享固定例程,那么对于受影响的版本,一个临时的解决方法是:同时声明一个本地 [AssemblyInitialize] 方法和一个本地 [AssemblyCleanup] 方法。 使用这两种本地方法时,MSTest 将跳过此提供程序扫描。 仅声明一个本地方法不会停止扫描。 该解决方法会绕过共享固定例程行为;它并不是 MSTest 要求的样板代码,也不会阻止其他代码加载程序集。

元数据优先的发现(未发布)

Important

元数据优先提供程序发现功能正在开发中。 MSTest 4.5.2 仍使用上述基于反射的搜索。 尚未分配固定的发布版本,且 4.5 版本的后向移植尚未被接受。

为避免仅仅因为提供程序扫描而引发加载,这种元数据优先的实现方式会直接从可移植可执行文件 (PE) 的元数据中读取程序集引用和提供程序标记。

仅基于元数据的决策需要匹配的程序集标识和由运行时绑定数据支持的路径。 在新式.NET上,MSTest 使用默认加载上下文的运行时提供的受信任平台程序集(TPA)映射。 在 .NET Framework 上,仅基于元数据的决策仅限于应用程序基本目录中未签名、区域性中立的引用,且不存在绑定或主机覆盖的情况。 对于满足这些要求的未加载的引用,MSTest 可以遍历未标记的程序集,而无需将它们加载到测试进程中。

附近的 DLL 或仅由组件依赖项解析程序建议的路径并不能确定运行时如何绑定引用。

实际提供程序、由使用者标记注册的 fixture 类型及其运行时依赖项仍可正常加载。 MSTest 保留现有的程序集绑定和加载上下文标识;同一上下文不会阻止首次加载程序集。

为了保留现有的运行时绑定行为,MSTest 在以下情况下使用运行时解析,而不是仅基于元数据的决策:

  • 受信任的元数据路径不可用,或者元数据读取或解析尝试失败。
  • 使用者使用自定义程序集加载上下文。
  • 即便其完整标识与引用匹配,也已加载具有请求的简单名称的程序集。
  • 在 .NET Framework 上,全局程序集缓存(GAC)、强名称绑定、加载的程序集映像、绑定重定向、codeBase条目或未知绑定或主机策略可能会影响解析。

回退诊断包括 using runtime resolution for AssemblyFixtureProvider discovery。 缺少元数据路径会生成信息级跟踪;元数据读取或解析失败会生成警告。 回退可以加载未标记的库,并在 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、或 TaskValueTask
  • 必须只有一个 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 会先释放测试类实例,然后再释放作用域。 应用程序仍负责管理宿主和根服务提供程序。

第一种基于反射的集成方式不支持 Native 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);
    }
}

构造函数与 TestInitialize:

方面 构造函数 TestInitialize
异步支持 否 是的
超时支持 否 是(具有 [Timeout] 属性)
执行顺序 First 构造函数之后
继承 先定义基础,再推导 先定义基础,再推导
异常行为 清理和处理操作不会运行(因为没有实例存在) “清理和处置”仍在运行

小窍门

我应该使用哪种方法? 构造函数通常是首选的,因为它们允许你使用 readonly 字段,从而强制实施不可变性,并让你的测试类更易于理解和分析。 需要异步初始化或超时支持时使用 TestInitialize 。

还可以结合这两种方法:使用构造函数对 readonly 字段进行简单的同步初始化,然后使用 TestInitialize 进行依赖于这些字段的额外异步设置。

可以选择性地启用代码分析器以强制实施一致的方法:

  • MSTEST0019 - 首选 TestInitialize 方法而不是构造函数
  • MSTEST0020 - 首选构造函数而不是 TestInitialize 方法

执行阶段

测试方法在安装完成后执行。 对于 async 测试方法,MSTest 等待返回的 Task 或 ValueTask。

警告

默认情况下,异步测试方法没有 SynchronizationContext 。 这不适用于在 UWP 和 WinUI 中 UI 线程上运行的 UITestMethod 测试。

清理阶段

使用 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 - 首选 Dispose 而非 TestCleanup 方法
  • MSTEST0022 - 首选 TestCleanup 而不是 Dispose 方法

如果启用了非 MSTest 分析器(如.NET代码分析规则),你可能会看到CA1001建议在测试类拥有可释放资源时实现释放模式。 这是预期行为,应遵循分析器的指南。

完成测试层级顺序

  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:全局生命周期方法会运行于每个测试上,因此应保持简洁。

另请参阅