小窍门
在选择运行程序配置之前,请参阅 测试平台概述。
有多种方法可用来运行 MSTest 测试,具体取决于你的需要。 可以从 IDE(例如,Visual Studio、Visual Studio Code 或 JetBrains Rider)或命令行或 CI 服务(如 GitHub Actions 或 Azure DevOps)运行测试。
从历史上看,MSTest 依赖于 VSTest 在所有上下文中运行测试,但从版本 3.2.0 开始,MSTest 有自己的测试运行程序。 这个新的 Runner 比 VSTest 更轻量、更快,建议使用它来运行 MSTest 测试。
VSTest 与 MTP
MSTest 支持使用 VSTest 和 Microsoft.Testing.Platform (MTP)运行测试。 MTP 的支持是由 MSTest 测试运行器提供的,它可以在所有上下文中运行测试(例如,持续集成(CI)流水线、CLI、Visual Studio 测试资源管理器和 VS Code 文本资源管理器)。 MSTest 运行程序直接嵌入到你的 MSTest 测试项目中,并且不需要其他应用程序依赖项(例如用于运行测试的 vstest.console 或 dotnet test)。 但是,你仍然可以使用 dotnet test.
MSTest 运行程序是开放源代码,在 MTP 库中生成。 可以在 Microsoft.Testing.Platform GitHub 存储库中找到 代码。 MSTest 运行程序随附于 MSTest in 3.2.0 或更高版本。
使用 .NET 10 SDK 及更高版本时,请在 dotnet test 中选择 global.json 的专用 MTP 模式。 从 .NET 11 预览版 6 开始,可以使用环境变量替代当前进程的DOTNET_TEST_RUNNER选择。 有关支持的输入、SDK 版本要求和 MTP 专用选项,请参阅dotnet test使用 MTP。
编程式测试发现与执行
对于自定义测试 UI、集成测试服务或报表生成器,请选择与测试平台匹配的接口:
| 要求 | 接口 | Details |
|---|---|---|
| 使用元数据和实时结果从.NET代码发现和运行 MTP 测试。 | MTP 服务器模式客户端 | 从 MTP 2.4 开始, Microsoft.Testing.Platform.ServerMode.Client.Sources 提供类型化发现和执行方法。 包注入内部 C# 类型;其他.NET语言可以调用 C# 包装器。 |
| 通过命令行进程发现 MTP 测试,并使用结构化元数据。 | --list-tests json |
可在 MTP 2.3 或更高版本中使用。 阅读 JSON 文档,然后使用 --filter-uid 运行所选测试。 文本格式不是计算机可读的 API。 |
| 保留现有的 VSTest 发现和执行集成。 | Microsoft.TestPlatform.TranslationLayer |
将 VsTestConsoleWrapper 与 vstest.console 及兼容的 VSTest 适配器一起使用。 该包装器使用的是 VSTest 协议,而不是原生 MTP 协议。 |
| 在测试进程内使用测试元数据或生成自定义报告。 | MTP 扩展 | 实现一个 IDataConsumer 以使用框架发布的消息。 此扩展点不是外部测试客户端 API。 |
MTP 支持发现和执行。 无需分析终端输出或生成 Process.Start 包装器以使用其类型化服务器模式客户端。 有关完整的 C# 示例和Visual Basic调用方,请参阅从.NET发现和运行测试。
发现可以包括 MSTest 类别和自定义 TestProperty 元数据。 可用字段取决于框架和传输;这两个 API 都不会将任意内存中属性都序列化。 请参阅使用更新和元数据。
对于现有 VsTestConsoleWrapper 集成,请保留与 VSTest 兼容的项目配置和适配器,直到你迁移该客户端。 框架的 VSTest 兼容性不会使 VSTest 转换层成为每个 MTP 测试应用程序的客户端。 有关兼容性层的范围,请参阅 VSTest Bridge。
在 MSTest 项目中启用 MTP
使用 MSTest SDK 极大地简化了 MTP 及其扩展的项目配置、版本管理和对齐方式。
MSTest.Sdk
Microsoft.NET.Sdk替换为项目 SDK,默认情况下启用 MTP:
<Project Sdk="MSTest.Sdk/4.1.0">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
</Project>
注释
仅当您的项目能够使用 MSTest.Sdk 作为其基础 SDK 时,Microsoft.NET.Sdk 才能运行。 如果project需要其他 SDK,请不要将<Project Sdk="...">值替换为 MSTest.Sdk。
例如,某些 ASP.NET Core集成测试项目使用Microsoft.NET.Sdk.Web。
MSTest.Sdk派生自 Microsoft.NET.Sdk,因此它不会导入提供的 ASP.NET Core SDK 目标Microsoft.NET.Sdk.Web。
还可以手动配置 MSTest,而不是使用 MSTest.Sdk。 当项目需要其他顶级 SDK(例如, Microsoft.NET.Sdk.Web)时,需要手动配置,但也可以使用标准 Microsoft.NET.Sdk进行选择。 添加 EnableMSTestRunner 属性,并在项目文件中将 OutputType 设置为 Exe。 然后添加项目所需的 MSTest 引用。 确保使用的是 MSTest 3.2.0 或更高版本,并更新到可用的最新 MSTest 版本。
请考虑以下示例项目文件:
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<!-- Enable Microsoft.Testing.Platform, this is an opt-in feature -->
<EnableMSTestRunner>true</EnableMSTestRunner>
<TestingPlatformDotnetTestSupport>true</TestingPlatformDotnetTestSupport>
<!--
Displays error on console in addition to the log file. Note that this feature comes with a performance impact.
For more information, visit https://learn.microsoft.com/dotnet/core/testing/unit-testing-with-dotnet-test#show-failure-per-test
-->
<TestingPlatformShowTestsFailure>true</TestingPlatformShowTestsFailure>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<!--
MSTest meta package is the recommended way to reference MSTest.
It's equivalent to referencing:
Microsoft.NET.Test.Sdk
MSTest.TestAdapter
MSTest.TestFramework
MSTest.Analyzers
Starting with 3.8, it also includes:
Microsoft.Testing.Extensions.TrxReport
Microsoft.Testing.Extensions.CodeCoverage
-->
<PackageReference Include="MSTest" Version="4.1.0" />
</ItemGroup>
</Project>
小窍门
为了确保解决方案中的所有测试项目都使用 MSTest 运行程序,请在 EnableMSTestRunner 文件中设置 TestingPlatformDotnetTestSupport 和 属性,而不是单个project文件。
配置和筛选器
.runsettings
MTP 通过命令行选项支持--settings。 有关受支持的 MSTest 条目的完整列表,请参阅 “配置 MSTest:Runsettings”。 以下命令显示了各种用法示例。
使用 dotnet run:
dotnet run --project Contoso.MyTests -- --settings config.runsettings
使用 dotnet exec:
dotnet exec Contoso.MyTests.dll --settings config.runsettings
-或-
dotnet Contoso.MyTests.dll --settings config.runsettings
使用可执行文件:
Contoso.MyTests.exe --settings config.runsettings
测试筛选器
可以使用命令行选项无缝地提供测试--filter。 以下命令显示了一些示例。
使用 dotnet run:
dotnet run --project Contoso.MyTests -- --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"
使用 dotnet exec:
dotnet exec Contoso.MyTests.dll --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"
-或-
dotnet Contoso.MyTests.dll --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"
使用可执行文件:
Contoso.MyTests.exe --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"