使用 MSTest 執行測試

小提示

在選擇跑道配置前,請參考 測試平台概述。

根據您的需求,有數種方式可執行 MSTest 測試。 你可以從 IDE(例如 Visual Studio、Visual Studio Code 或 JetBrains Rider)執行測試,或從指令列執行,或是從 CI 服務(如 GitHub Actions 或 Azure DevOps)執行。

歷史上,MSTest 依賴 VSTest 來執行所有情境下的測試,但從 3.2.0 版本開始,MSTest 擁有自己的測試執行器。 這個新的執行器比 VSTest 更輕量且更快速,是執行 MSTest 測試的建議方式。

VSTest 與 MTP 的比較

MSTest 支援同時使用 VSTest 與 Microsoft.Testing.Platform (MTP) 進行測試。 MTP 的支援由 MSTest 執行器驅動,能在所有情境下執行測試(例如持續整合(CI)pipelines、CLI、Visual Studio測試檔案管理器及 VS Code 文本檔案管理器)。 MSTest 執行器直接嵌入你的 MSTest 測試專案中,且不需要其他應用程式相依,例如 vstest.console 或 dotnet test,來執行測試。 不過,你仍然可以用dotnet test來執行測試。

MSTest 測試執行器是開源的,並且構建於 MTP 函式庫之上。 你可以在 microsoft/testfx GitHub 倉庫中找到 程式碼。 MSTest 測試器隨 MSTest in 3.2.0 或更新版本捆綁提供。

使用 .NET 10 SDK 和更新版本時,請在 global.json 中選取 dotnet test 的專用 MTP 模式。 從 .NET 11 開始,你可以用DOTNET_TEST_RUNNER環境變數覆蓋目前程序的那個選擇。 關於支援的輸入、SDK 版本要求及 MTP 專屬選項,請參見 dotnet test with MTP。

以程式方式進行測試探索與執行

對於自訂測試 UI、整合測試服務或報告產生器,請選擇與你的測試平台相符的介面:

Requirement Interface 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 呼叫器,請參閱 Discover and run tests from .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>

Note

MSTest.Sdk 只有當你的專案可以使用 Microsoft.NET.Sdk 作為其基礎 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屬性和設定OutputTypeExe。 然後加入你專案所需的 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:執行設定」。 以下指令展示了各種使用範例。

使用 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"

另請參閱