使用 MSTest 和 Microsoft.Testing.Platform 测试 UWP 和 WinUI 3 应用

使用Microsoft。Testing.Platform (MTP)在 UWP 和 WinUI 3 应用程序中运行 MSTest 测试。 应用程序充当测试主机,并拥有其 UI 线程和进程生存期。

Important

本文中所述的完整Windows应用程序支持矩阵适用于 MSTest 4.5 和 MTP 2.5。 在稳定版本发布之前,请使用匹配的 4.5 和 2.5 预览包。 如果直接管理 MTP 包,请使平台和扩展包版本保持一致。

选择应用程序模型

MSTest.Sdk 通过 MTP 支持以下Windows应用程序模型:

应用程序模型 打包和信任 测试主机启动 运行命令
经典 UWP (uap10.0) 已打包的应用容器 完全受信任的辅助进程会注册该包,并通过应用程序用户模型 ID (AUMID) 激活应用。 MSBuild,使用 InvokeTestingPlatform 目标
现代 UWP(基于 .NET 10 和 UseUwp) 已打包的 AppContainer 完全信任的 sidecar 注册包,并通过 AUMID 激活应用。 MSBuild,使用 InvokeTestingPlatform 目标
打包的 WinUI 3 打包的完全信任 完全信任的 sidecar 注册包,并通过 AUMID 激活应用。 dotnet run 或 dotnet test --project
解压缩的 WinUI 3 无包标识,完全信任 MTP 直接启动应用可执行文件。 dotnet run 或 dotnet test --project
WinUI 3 packagedClassicApp 与 TrustLevel="appContainer" 已打包的 AppContainer 完全信任辅助组件会激活该应用,并在 MTP 通信管道上对其确切对应的包安全标识符(SID)进行授权。 dotnet msbuild,使用 InvokeTestingPlatform 目标

打包和沙盒是两个彼此独立的选项。 打包的 WinUI 3 桌面应用具有包标识,但默认作为完全信任进程运行。 UWP 应用始终在 AppContainer 中运行。 仅当已打包的 WinUI 3 应用在其清单中设置了 TrustLevel="appContainer" 时,它才会在 AppContainer 中运行。

对于较旧的 MSTest 或 MTP 版本,请保留 UWP 项目的现有 VSTest 配置。 在 UWP 和 AppContainer 主机上进行原生 MTP 执行需要 MSTest 4.5 和 MTP 2.5。

了解 MTP 应用模型 sidecar

对于打包的应用,初始测试工具进程无法在包内运行。 MSTest.Sdk 启动一个完全受信任的边车控制器,该控制器:

  • 负责准备命令行参数,并处理取消、重试、报告和退出代码。
  • 注册构建输出包,并通过 AUMID 激活清单中指定的应用程序。
  • 仅当 AppContainer 主机连接到 MTP 命名管道时,才授权所选的包 SID。
  • 从包专用存储中恢复 TRX、转储、诊断和重试产物。

测试应用程序仍在其自己的进程中托管 MTP 和 MSTest。 UWP 运行不需要 Microsoft.NET.Test.Sdk、vstest.console、UwpTestHostRuntimeProvider 或 Visual Studio 部署运行时。

对于 UWP windowsApp 应用,Windows 不是通过常规进程参数,而是通过 LaunchActivatedEventArgs.Arguments 提供一个激活字符串。 在创建 MTP 生成器之前进行调用 PackagedAppExtensions.GetTestApplicationArguments 。 打包的应用扩展将还原原始参数数组和控制器连接元数据。

对于 WinUI 3(包括 AppContainer 中运行的 WinUI 3 packagedClassicApp),请使用正常的进程参数。

满足先决条件

使用适用于项目的先决条件:

  • 将 .NET SDK 10 或更高版本用于 MSTest 4.5 工具链和 dotnet test --project。
  • 对于 UWP,请使用 Visual Studio 中的桌面版 MSBuild,并安装 通用 Windows 平台 工作负载以及所需的 Windows SDK。 这些组件仅提供生成时支持。
  • 对于 WinUI 3,请安装Windows应用程序开发工具并引用兼容的Windows 应用 SDK版本。
  • 对于打包的测试应用,启用 Windows 开发人员模式或配置旁加载,以便 Windows 可以注册未签名的生成输出布局。
  • 对于 AppContainer 测试应用程序,请以未提升权限的用户身份运行控制器。

配置 UWP 测试

配置新式 UWP 项目

使用 MSTest.Sdk 4.5 或更高版本,以带有 Windows 平台版本的 .NET 10 为目标,并将 UseUwp 设置为 true。 保留现有的 UWP XAML、MSIX、架构和 Native AOT 设置。

Visual Studio通常在生成期间启用UseUwpTools。 当 UseUwpTools 为 true 时,或者当 UseUwp 为 true 且 UseUwpTools 尚未设置时,MSTest.Sdk 会选择 UWP 应用程序模型。

如果你只需要在非 UWP 的 MTP 测试应用程序中使用 UWP 引用,请将 UseUwpTools 设置为 false。 然后,SDK 会使用直接 MTP 运行器,除非另一种打包应用程序模型需要边车。

有关完整的项目,请参阅 新式 UWP MTP 示例。

配置经典 UWP 项目

保留现有 uap10.0 项目形状、桌面 MSBuild 工具链和 UWP 扩展 SDK。 导入 MSTest.Sdk 4.5 或更高版本,并启用 MSTest 运行程序和 MTP。 MSTest.Sdk 提供与 UAP 兼容的启动、适配器和运行时资产。

有关完整的项目,请参阅 经典 UWP MTP 示例。

运行 UWP 测试

打开适用于 Visual Studio 的开发人员 PowerShell。 为具体体系结构构建解决方案,然后调用 MTP:

msbuild UwpTests.sln /restore /p:Configuration=Release /p:Platform=x64
msbuild UwpTests.csproj /t:InvokeTestingPlatform /p:Configuration=Release /p:Platform=x64 /p:TestingPlatformCommandLineArguments="--report-trx"

第二个命令注册包,通过 AUMID 激活应用,运行常规测试和 UI 线程测试,从包存储复制结果项目,并返回测试运行退出代码。

配置 WinUI 3 测试

使用 MSTest.Sdk 4.5 或更高版本,将 UseWinUI 设置为 true,并以 Windows 专用的目标框架为目标。 对于打包式激活,请使用 Windows 平台版本 10.0.19041.0 或更高版本。

在 WinUI 应用中托管 MTP

对于自托管 WinUI 测试应用,请在 OnLaunched 中创建并激活测试窗口,然后发布其调度程序队列:

_window = new UnitTestAppWindow();
_window.Activate();
UITestMethodAttribute.DispatcherQueue = _window.DispatcherQueue;

运行生成的 MTP 帮助程序,将其结果赋给 Environment.ExitCode,关闭窗口,然后调用 Exit:

Environment.ExitCode = await MicrosoftTestingPlatformApplication.RunAsync(
    Environment.GetCommandLineArgs()[1..]);

对于创建或访问 WinUI 对象的测试,请使用 UITestMethod。 对不需要 UI 线程的测试,请使用 TestMethod。

Warning

不要将 [assembly: WinUITestTarget(...)] 添加到自托管 WinUI 测试应用中。 该属性会为独立的测试主机启动 WinUI 应用程序,但自托管应用已调用 Application.Start。

配置未打包的应用

将 WindowsPackageType 设置为 None。 该应用没有 MSIX 标识或 AppxManifest.xml,因此 MTP 会直接启动其可执行文件。 请勿手动添加打包的应用扩展。

当项目满足以下条件时,Windows 应用 SDK通常会注入其启动初始值设定项:

  • WindowsPackageType 是 None。
  • OutputType 是 Exe 或 WinExe。
  • WindowsAppSDKSelfContained 不是 true。

如果加载你的测试库的主机不是 Windows 应用 SDK 应用,请在该库中将 WindowsAppSdkBootstrapInitialize 设置为 true。

VSTest 不支持未打包的 WinUI 3 测试应用,因为它的 WinUI 提供程序需要 AppX 清单。

有关完整的项目,请参阅 未打包的 WinUI MTP 示例。

配置已打包的完全信任应用程序

保留默认打包版 WinUI 配置及其 Package.appxmanifest。 MSTest.Sdk 会为已打包的项目自动引用并注册 Microsoft.Testing.Extensions.PackagedApp。

也不要调用 AddPackagedAppDeployment。 MTP 运行只能注册一个测试主机启动器。 仅当自定义启动器负责程序包激活时,才将设置为。

有关完整的项目,请参阅 打包的 WinUI MTP 示例。

配置 AppContainer 应用

在 WinUI 包清单中,将应用程序配置为 packagedClassicApp 并设置 TrustLevel="appContainer"。 MTP 2.5 对控制器和扩展管道上的确切包 SID 进行授权。 它既不赋予 ALL APPLICATION PACKAGES,也不需要环回豁免。

以非提升权限运行边车进程。 使用 InvokeTestingPlatform 目标,以便 sidecar 能够将结果和诊断信息从软件包 LocalState 复制到所请求的结果目录。

有关完整的项目,请参阅 AppContainer WinUI MTP 示例。

运行 WinUI 3 测试

为具体体系结构生成。 对于打包的完全信任应用或未打包应用,请运行:

dotnet build -p:Platform=x64
dotnet test --project . --no-build -p:Platform=x64

还可以使用 dotnet run --no-build -p:Platform=x64。

对于 AppContainer WinUI 应用,请使用 sidecar 目标和绝对结果目录:

dotnet msbuild .\WinUITests.csproj -t:InvokeTestingPlatform -p:Platform=x64 "-p:TestingPlatformCommandLineArguments=--report-trx --results-directory C:\TestResults"

请勿 dotnet exec 用于 WinUI 应用。 WinUI 会相对于进程路径解析 PRI 资源。

排查设置问题

症状 检查
该应用报告了对 Application.Start 的多次调用。 WinUITestTarget从自承载 WinUI 测试应用中删除该属性。
测试运行已完成,但进程保持打开状态。 关闭测试窗口,并在 MTP 运行完成后调用 Exit 。
失败的测试返回进程退出代码 0。 将 MTP 运行结果分配给 Environment.ExitCode。
未打包的 WinUI 在运行时报告缺少 AppxManifest.xml。 确认项目使用 MTP 而不是 VSTest。
打包的运行无法注册或激活应用。 确认Windows目标框架、开发人员模式或旁加载策略、体系结构和清单可执行文件条目。
AppContainer 主机无法连接到控制器。 使用 MSTest 4.5 和 MTP 2.5 或更高版本,并以非提升权限运行控制器。
AppContainer 报告未复制到指定的目录。 使用 InvokeTestingPlatform 并指定绝对结果目录。

另见