ui-tests-migration

name ui-tests-migration description Migrate and stabilize PowerToys UI tests from WinAppDriver/Selenium to Microsoft.PowerToys.UITest.Next and winappcli. Use for ports, new UITest projects, flaky CI tests, persistent local-VM validation on Hyper-V, resettable clean-baseline runs, Settings IPC authentication/test signing, Explorer/Shell selection, preview handlers, thumbnail providers, hotkey activation, stateful process lifecycle, composed WinUI/WebView visual baselines, or cross-window/foreground failures. Covers APIs, scaffolding, test design, diagnostics, agentic execution, and CI hardening. Keywords: UI test, UITests, UITestAutomation.Next, winappcli, WinAppDriver, Selenium, Settings IPC, not-microsoft-signed, Authenticode, local VM, Hyper-V, checkpoint, migrate, flaky, CI stability, Explorer, Shell extension, WebView2. license Complete terms in LICENSE.txt PowerToys UI-Tests Migration (legacy → .Next ) Convert a PowerToys module's UI tests from the legacy WinAppDriver / Selenium / Appium harness ( Microsoft.PowerToys.UITest , in src/common/UITestAutomation/ ) to the new winappcli harness ( Microsoft.PowerToys.UITest.Next , in src/common/UITestAutomation.Next/ ). The new harness shells out to winapp.exe and parses its JSON — no WinAppDriver server on :4723, no Selenium/Appium NuGet packages, no WindowsElement / WindowsDriver . The public shape ( UITestBase , Session , Find<T> , By , element wrappers like ToggleSwitch ) is deliberately similar, so most of the work is mechanical API mapping plus reworking a few patterns that don't translate one-to-one (XPath selectors, stateful elements, instance mouse/keyboard helpers). When to use this skill Use this skill when the task is to: Port a module's existing legacy UI tests to .Next (e.g. "migrate the ScreenRuler UI tests to the new framework", "convert FancyZones.UITests to winappcli"). Create a new [Module].UITests.Next project that re-implements the legacy tests with the new harness, leaving the old project in place. Stand up brand-new .Next UI tests for a module that has no UI tests at all, by reading the module's human test sign-off markdown (e.g. ColorPickerUITest.md ) and turning each manual checklist item into an automated test. Validate a new or migrated suite in a local Windows VM through an unattended build/package/deploy/run/TRX/diagnose loop. Use a retained VM for fast iteration and a restored baseline checkpoint when clean-profile behavior matters. This skill is the how : the framework differences, the API mapping, the project scaffolding, the naming rules, the recurring PowerToys test recipes, and the build/validate loop. The what (which module, which tests) comes from the calling prompt. Reference implementation — read these working examples before porting anything. They are the ground truth for "what good looks like" with each harness: New ( .Next ) : ColorPickerEndToEndTests.cs — full end-to-end scenario (navigate Settings → toggle module → read shortcut → fire hotkey → read overlay → click-capture → inspect editor), driven entirely through winappcli . Legacy : TestSpacing.cs TestHelper.cs — a UITestBase subclass plus a static helper that navigates, toggles, reads the shortcut, fires the hotkey, and validates the clipboard. Worked Scenario-A port (validated 5/5, where the legacy suite scored 0/5 locally) : the ScreenRuler suite ported from the legacy project above lives in ScreenRuler.UITests.Next/TestHelper.cs 5 test classes. It is the canonical port reference — cross-window toolbar discovery via Session.FromProcess , a DPI-aware app.manifest , cursor centering, and patient hotkey activation are all there because real runs needed them (see references/patterns-and-pitfalls.md ). Stateful/visual reference (validated 15/15 across Win10 x64, Win11 x64, and ARM64) : PeekFilePreviewTests.cs demonstrates stable Explorer Shell selection, toggle-hotkey activation, process-preserving pinning tests, renderer readiness, and composed WinUI/WebView visual baselines. Explorer/Shell-extension reference (validated across x64 and ARM64 CI) : FileExplorerAddonsTests.cs demonstrates class-scoped runner reuse, one-time Shell restart, state-aware Preview pane activation, exact Shell selection, deterministic icon sizes, provider-log readiness, and failure media captured before Explorer teardown. Read references/explorer-shell-tests.md before testing Explorer. Required reads (in order) This SKILL.md — the decision tree (which scenario), the naming rules, the high-level workflow, and the build/validate loop. references/framework-differences.md — the conceptual deltas you MUST internalize before writing code: winappcli engine, stateless elements, selector grammar (no XPath/CssSelector), session scopes (window vs process), lifecycle/hygiene/module pre-enablement, multi-window discovery, and what the new harness does NOT (yet) provide. references/api-mapping.md — the line-by-line cheat sheet: namespaces, By , Element actions/properties, Session , UITestBase , the static Keyboard/Mouse/Clipboard helpers, and the element-wrapper catalog. Keep this open while editing. references/project-setup.md — csproj scaffold, naming/placement rules, .slnx registration, and how to build & run a .Next project. Uses the templates/ starter files. references/porting-workflow.md — the two end-to-end playbooks: A) port existing legacy tests, and B) author tests from a human sign-off markdown when none exist. references/patterns-and-pitfalls.md — adaptable recipes for the recurring PowerToys patterns (toggle a module + verify its process, read the activation shortcut from a ShortcutControl , fire a global hotkey reliably, inspect the clipboard, discover overlay/editor windows) and the gotchas that bite during migration. references/explorer-shell-tests.md — required for tests involving Explorer, preview handlers, thumbnail providers, Shell selection, view modes, or Shell restarts. Covers lifecycle boundaries, authoritative signals, and failure evidence. references/ci-stability.md — the CI-stability capstone: the Win32-window vs UIA-element mental model, state-boundary worksheet, stable-sample waits, retry semantics, foreground/integrity constraints, process lifecycle, composed visual capture, and a pre-flight checklist to apply BEFORE the first CI push. It also covers Release Runner/Settings IPC authentication, the existing CI companion-signing mechanism, and why a visible Settings toggle must never be rescued with a settings-file/restart fallback. Read this to spend one CI iteration instead of six. ui-tests-local-vm — the live desktop execution loop: scaffold or reuse a persistent Hyper-V VM, run as a true standard user, refresh only changed payloads, iterate through durable TRX/evidence, and restore or recreate the baseline for clean-profile validation. Pick your scenario flowchart TD A[Module to migrate] --> B{Does a legacy<br/>UITests project exist?} B -- Yes --> C["Scenario A: PORT<br/>Create [Module].UITests.Next<br/>Re-implement each legacy test"] B -- No --> D{Is there a human test<br/>sign-off .md?} D -- Yes --> E["Scenario B: GREENFIELD<br/>Create [Module].UITests<br/>Turn each checklist item into a test"] D -- No --> F[Ask the user for the<br/>test spec / sign-off doc] Scenario Trigger New project name Source of test cases A — Port A legacy [Module].UITests (or similar) project already exists and references UITestAutomation.csproj [Module].UITests.Next — keep the .Next suffix so it lives alongside the legacy project The existing legacy test methods (1:1 re-implementation) B — Greenfield The module has no UI tests at all [Module].UITests — drop the .Next suffix; there's nothing to live alongside The module's human sign-off markdown (manual checklist), e.g. ColorPickerUITest.md Place the new project under src/modules/[Module]/Tests/[Module].UITests.Next/ (or …/Tests/[Module].UITests/ for Scenario B). If the module already keeps tests in a different Tests/ layout, match the module's existing convention rather than forcing this one — see references/project-setup.md . Keep it abstract. Every PowerToys module is unique and the legacy tests were written by different people in different styles. Treat the recipes in this skill as adaptable patterns , not a rigid script. Re-create the intent and assertions of each test; do not mechanically translate brittle, harness-specific scaffolding (Selenium Actions , XPath walks, manual driver attaches) when the new harness has a cleaner idiom. High-level workflow Create a TODO list and work top-to-bottom. Each step links to the reference that drives it. - [ ] 1. Identify the module + scenario (A port / B greenfield) — this SKILL.md "Pick your scenario" - [ ] 1a. Read the module's developer docs — `doc/devdocs/modules/<module>.md` (if the exact file is missing, search `doc/devdocs/`, including `doc/devdocs/common/`) — to learn its development-cycle specifics BEFORE writing tests: how its shell extensions / context menus register, whether they need a **Release** build (`NDEBUG`) or a **signed** sparse MSIX package, and any Explorer-restart or first-run needs. Skipping this produces opaque failures — e.g. a context-menu entry never appears because a Debug build compiles registration out, or an unsigned `.msix` fails to register (`0x800B0100`). - [ ] 2. Read the two reference examples (ColorPicker .Next + ScreenRuler legacy) end-to-end - [ ] 3. Inventory the source: • Scenario A → list every [TestMethod] + shared helper in the legacy project • Scenario B → read the module's sign-off .md; list each manual checklist item • For each workflow → list every external boundary (runner, Explorer, HWND, renderer, compositor, child process) and its authoritative ready signal — references/porting-workflow.md - [ ] 4. Internalize the deltas — references/framework-differences.md - [ ] 5. Scaffold the new project (csproj + PerMonitorV2 app.manifest from templates, name per the table, register in .slnx) — references/project-setup.md - [ ] 6. Re-implement tests, mapping each API as you go — references/api-mapping.md + recipes from references/patterns-and-pitfalls.md - [ ] 6a. If Explorer/Shell is involved, apply references/explorer-shell-tests.md - [ ] 7. Apply the CI-stability checklist BEFORE building — references/ci-stability.md (stable authoritative signals, retry classification, foreground/integrity, lifecycle reset scope, non-activating helper processes, composed capture, DPI manifest, single-module enable, first-run suppression) - [ ] 7a. If a test changes a module's enabled state through Settings, keep the real Settings UI + immediate runtime assertion. Verify the selected UITest project is covered by the existing `$requiresAuthenticatedSettingsIpc` companion-signing path in `.pipelines/v2/templates/job-test-project.yml`; never add a test-side settings/restart fallback for Release CI — [references/ci-stability.md](references/ci-stability.md#principle-5a--keep-module-lifecycle-tests-on-real-release-settings-ipc) - [ ] 8. Build the new project to exit code 0 — this SKILL.md "Build & validate" - [ ] 9. Run one deterministic test in the local VM and diagnose the first failure — ../ui-tests-local-vm/SKILL.md - [ ] 10. Rerun the focused test after each fix, then widen to the complete module suite with bounded timeouts; parse TRX and verify durable evidence export - [ ] 11. If the local VM is unavailable or unsupported, run on another live desktop or report the exact environmental blocker; do not silently stop at compile validation Build & validate The .Next harness needs winapp.exe only at run time, not build time — the project has zero managed dependency on the engine. So you can always compile-verify a migration even on an agent with no winappcli installed. # 0. FIRST build of a brand-new project: restore so the assets file exists, otherwise the build # fails with NETSDK1004 "Assets file ... project.assets.json not found". dotnet restore src\modules\<Module>\Tests\<Module>.UITests.Next\<Module>.UITests.Next.csproj -p:Platform=x64 # (Equivalently, run tools\build\build-essentials.cmd once at the start of the session.) # 1. Build just the new test project (fast inner loop). Prefer the repo build script. tools\build\build.cmd -Path src\modules\<Module>\Tests\<Module>.UITests.Next -Platform x64 -Configuration Debug # Exit code 0 = success; non-zero = failure. On failure read the errors log next to the project: # build.<Configuration>.<Platform>.errors.log # Do not substitute `dotnet build` when UITestAutomation.Next's COM references are in the graph: # .NET SDK MSBuild cannot run ResolveComReference and fails with MSB4803. Use the repo script or # Visual Studio's full-framework MSBuild.exe; use `dotnet restore` only to create project.assets.json. # 2. Run (needs a live desktop). A .Next project is a Microsoft.Testing.Platform Exe — run the # produced exe directly with a TRX report; filter to one test/category for a tight loop. $exe = "<repo>\x64\Debug\tests\<Module>.UITests.Next\net10.0-windows10.0.26100.0\<Module>.UITests.Next.exe" & $exe --filter "TestCategory=<Cat>" --report-trx --report-trx-filename run.trx --results-directory <dir> # --filter accepts "TestCategory=X" or "FullyQualifiedName~Y"; omit it to run everything. # Exit 0 = all passed. Parse the .trx for per-test outcomes + failure messages. Default to persistent local VM validation — ui-tests-local-vm . It keeps the interactive desktop and staged tools, refreshes only changed archives, and returns durable status/TRX/evidence. Do not modify stabilized tests merely to improve a VM-specific pass rate when the task only asks whether the execution loop works. Finish clean-profile claims from a restored known baseline or a fresh named VM volume. Design for CI stability up-front — references/ci-stability.md . Before the first push, walk its pre-flight checklist (authoritative-signal retries instead of fixed sleeps, navigation via UIA invoke, interaction-scoped foreground checks, non-activating helpers, Win32 window/overlay detection, screen-capture cold-start handling, DPI manifest, single-module enable, first-run suppression). Most "passes local, fails CI" loops come from skipping one of these; applying them proactively is how you spend one CI iteration instead of six. Run it in a loop: write → build → run → diagnose → repeat. UI tests surface environment-real failures (DPI scaling, cursor position, hotkey-arming races) that only a live run reveals. Start with one deterministic test (e.g. the activation/toggle test), get it green, then widen. Diagnose from the artifacts, not from the assertion message. Every failed test attaches a desktop screenshot, and in pipeline mode an MP4 of the run. Open them before forming any theory — especially before concluding the product is broken. An assertion can only say "found 0 rows"; the screenshot says whether the list was empty or whether your selector was wrong. This is the single highest-leverage habit in the agentic loop: skipping it cost ~8 iterations and a confident but entirely wrong product-defect report on File Locksmith (see references/patterns-and-pitfalls.md Pitfall 26). If there is no video, find out why rather than proceeding blind — the harness now prints the reason (a clean Windows image without the Visual C++ redistributable cannot load the native encoder). First, run the legacy suite once for a baseline — and run it ELEVATED. The legacy harness launches PowerToys via ProcessStartInfo { Verb = "runas" } (elevated), so a non-elevated test host can't complete the launch and every test fails at startup with a misleading Win32Exception cascade — a false 0/N that looks like "the tests are broken" but is purely the run method. (That's why VS Test Explorer passes them: VS runs as admin.) Run from an elevated terminal: start WinAppDriver.exe on 127.0.0.1:4723 , then run the built DLL with vstest.console.exe (see references/porting-workflow.md §A0 for the -Verb RunAs recipe). A measurement failure on a scaled (non-100%) display is usually a pre-existing DPI issue (Pitfall 12), not something the port must reproduce — the ScreenRuler legacy suite scores 4/5 elevated here (Bounds fails at 150% scale) while the .Next port scores 5/5 . .Next tests themselves need no elevation (the new harness launches the runner non-elevated). Always build to exit code 0 before declaring the migration done. Fix every compile error — do not leave // TODO: port this stubs that break the build. Running the tests requires a live interactive desktop plus winapp.exe ( winget install Microsoft.winappcli , or set WINAPP_CLI_PATH ). The whole PowerToys runner is