winui-ui-testing

--- name: winui-ui-testing description: "Automated UI testing for Windows desktop apps — generate a batch test script with the `winapp ui` UI Automation harness, run all tests in one pass, read results. Covers element assertions, interactions, value checking (TextBox, ComboBox, ToggleSwitch), keyboard shortcuts and typing (send-keys), hover, drag-and-drop, touch and pen input, file pickers, flyouts, dialogs, persistence, accessibility audits, and screenshot/video capture. Works on any Windows app (Win32, WPF, WinForms, WinUI 3, packaged or unpackaged)." ---

### Scope — any Windows app

`winapp ui` drives Windows **UI Automation (UIA)**, the accessibility layer every Windows UI framework exposes, so the AutomationId-based approach in this skill works on **any** Windows desktop app: Win32, WPF, WinForms, and WinUI 3, packaged or unpackaged. The file-picker tests below already drive the OS's Win32 file dialog through the same verbs. For a non-WinUI app, use the same verbs and script template and skip the WinUI-specific gotchas (x:Bind `LostFocus` commit, ContentDialog selectors, MSIX relaunch).

### Approach

The goal of this skill is to validate UI and app functionality automatically, without manual interaction, by exercising the app's UI elements, verifying their state, and asserting that the app behaves as expected under test conditions.

There are two main approaches: 1. Interactive exploration — manually run the app, use `winapp ui <command>` to explore the UI tree, find AutomationIds, verify element properties, and test functionality interactively. This is useful for discovery, but slow and expensive if repeated for every test iteration. 2. Scripted batch testing — generate a `ui-tests.ps1` script that exercises all UI elements and asserts expected behavior in one pass. This allows you to run the tests automatically, capture results, and iterate quickly without manually interacting with the app each time.

Unless the user asked for interactive exploration, or you are unfamiliar with the code/app or need to explore the UI tree to discover AutomationIds for hidden or dynamically generated elements (flyouts, dialogs, lazy-loaded content), **prefer scripted batch testing** — it is faster, repeatable, and produces a record of pass/fail results that can be reviewed and acted on.

### `winapp ui` Verbs

- **Query:** `status`, `list-windows`, `inspect`, `search`, `get-property`, `get-value`, `get-focused`, `wait-for` - **Interact:** `invoke`, `click`, `set-value`, `focus`, `scroll`, `scroll-into-view` - **Advanced input:** `send-keys` (synthetic keyboard + accelerators), `hover` (tooltips/flyouts), `drag` (drag-drop, reorder, sliders), `touch` (tap/swipe/pinch/stretch), `pen` (stylus ink, pressure/tilt/eraser) - **Capture:** `screenshot`, `record` (H.264 MP4 video)

Run `winapp ui --cli-schema` for the complete command structure as JSON, or `winapp ui <verb> --help` for any single verb.

### Step 1: Use the Running App

If the app is already running, use its PID. **Do NOT relaunch** — use the PID already captured from the build step. If the app is not running, build and launch it using the guidance in the winui-dev-workflow skill.

### Step 2: Write the Test Script

**If you wrote the code:** Skip inspect — you already know all the AutomationIds and control structure from the XAML and code-behind. Write tests directly from that knowledge. Inspect misses popups, flyouts, dialogs, and lazy-loaded content anyway.

**If you're verifying code you didn't write:** Run inspect first to discover the UI: ```powershell winapp ui inspect -a <PID> --interactive ``` Then read the XAML files to find AutomationIds that aren't currently visible (flyout items, dialog buttons, secondary pages).

Create a `ui-tests.ps1` file that tests all the app's requirements in one pass:

```powershell # ui-tests.ps1 param([Parameter(Mandatory)][int]$AppPid) # NOTE: Do NOT name the parameter $Pid — it's read-only in PowerShell

$ErrorActionPreference = 'Continue' $pass = 0; $fail = 0; $results = @()

# Get main window HWND (avoids PopupHost interference with JSON parsing) $windows = winapp ui list-windows -a $AppPid --json 2>$null | ConvertFrom-Json $hwnd = ($windows | Where-Object { $_.title -ne "PopupHost" } | Select-Object -First 1).hwnd

function Test-UI { param([string]$Name, [scriptblock]$Script) # IMPORTANT: Inside $Script, use 'throw' to signal failure — NOT 'exit 1' # (exit terminates the entire script, not just the test) try { $output = & $Script 2>&1 if ($LASTEXITCODE -eq 0) { $script:pass++; $script:results += @{ name = $Name; status = "PASS" } } else { $script:fail++; $script:results += @{ name = $Name; status = "FAIL"; detail = "$output" } } } catch { $script:fail++; $script:results += @{ name = $Name; status = "FAIL"; detail = "$_" } } }

# ─── Element Existence ─── Test-UI "NavHome exists" { winapp ui wait-for "NavHome" -a $AppPid -t 3000 } Test-UI "NavSettings exists" { winapp ui wait-for "NavSettings" -a $AppPid -t 3000 }

# ─── Navigation ─── Test-UI "Navigate to Settings" { winapp ui invoke "NavSettings" -a $AppPid } Test-UI "Settings page loaded" { winapp ui wait-for "TxtUserName" -a $AppPid -t 3000 }

# ─── Interactions ─── Test-UI "Set username" { winapp ui set-value "TxtUserName" "TestUser" -a $AppPid } Test-UI "Click Save" { winapp ui invoke "BtnSave" -a $AppPid } # commits the TextBox binding Test-UI "Username value set" { winapp ui wait-for "TxtUserName" -a $AppPid --value "TestUser" -t 2000 }

# ─── Value assertions for different control types ─── Test-UI "Theme is System default" { winapp ui wait-for "CmbTheme" -a $AppPid --value "System default" -t 2000 } Test-UI "Logging is off" { winapp ui wait-for "TglLogging" -a $AppPid --value "Off" -t 2000 }

# ─── Accessibility Audit ─── # Only audit controls in the app's main window (exclude OS picker/popup controls) $allElements = (winapp ui inspect -a $AppPid --interactive --json 2>$null | ConvertFrom-Json).elements $appElements = @($allElements | Where-Object { $_.type -match 'Button|TextBox|ComboBox|CheckBox|ToggleSwitch|TabItem|Edit' -and $_.name -notmatch 'Minimize|Maximize|Close|System' -and # window chrome $_.className -notmatch 'PickerHost|#32770|CabinetWClass' # OS dialogs }) $missingId = @($appElements | Where-Object { -not $_.automationId }) if ($missingId.Count -eq 0) { $pass++; $results += @{ name = "All app controls have AutomationId"; status = "PASS" } } else { $fail++ $names = ($missingId | ForEach-Object { "$($_.type) '$($_.name)'" }) -join ", " $results += @{ name = "AutomationId coverage"; status = "FAIL"; detail = "Missing: $names" } }

# ─── State Screenshots (capture each meaningful state for visual review) ─── New-Item -ItemType Directory -Force -Path "screenshots" | Out-Null winapp ui screenshot -a $AppPid -o "screenshots/01-initial.png" 2>$null # ...take more screenshots after key interactions above (mode switches, dialogs opened, etc.)

# ─── Final Screenshot ─── winapp ui screenshot -a $AppPid -o "test-screenshot.png" 2>$null

# ─── Results ─── Write-Host "`nPassed: $pass | Failed: $fail" $results | Where-Object { $_.status -eq "FAIL" } | ForEach-Object { Write-Host " FAIL: $($_.name) — $($_.detail)" -ForegroundColor Red } $results | ConvertTo-Json | Out-File "test-results.json" if ($fail -gt 0) { exit 1 } else { exit 0 } ```

### What to Test

Write tests for **every requirement** from the user's prompt:

| Requirement type | Test approach | |---|---| | "Has a button that does X" | `search` to verify exists, `invoke` to click, `wait-for --value` to check result | | "Text field shows value" | `wait-for "TxtName" --value "expected"` — works for TextBox, TextBlock, labels | | "Status bar contains text" | `wait-for "StatusBar" --value "words" --contains` — substring match for dynamic content | | "Dropdown is set to X" | `wait-for "CmbTheme" --value "Dark"` — reads the selected item automatically | | "Toggle is on/off" | `wait-for "TglFeature" --value "On"` — reads the toggle state | | "Navigation between pages" | `invoke` nav item, `wait-for` a page-specific element to appear | | "Open file dialog" | `invoke` trigger, `list-windows` to find picker HWND, interact with `-w` | | "Save file dialog" | Same as open — find picker with `list-windows`, `set-value` filename, `invoke` Save | | "Right-click context menu" | `click --right` on element, `invoke` the flyout MenuItem | | "Keyboard shortcut (Ctrl+S, etc.)" | `send-keys "ctrl+s" --via send-input` then `wait-for` the result | | "Type into a TextBox/RichEditBox" | `send-keys "text" --target "Id" --via send-input` (real per-key input) | | "Tooltip / hover flyout appears" | `hover` the element, then `wait-for` the tooltip/flyout | | "Drag to reorder / resize / slider" | `drag <from> <to>` then `wait-for --value` the new state | | "Touch gesture (swipe/pinch/stretch)" | `touch -g swipe/pinch/stretch` then assert the result | | "Capture a repro clip of a flow" | `record -a PID --duration-sec N -o clip.mp4` | | "Confirmation dialog" | `invoke` trigger, `search` for dialog buttons, `invoke` Primary/Secondary/Close | | "Data persists" | Set values, `invoke` a button (to commit bindings), verify data file on disk (`Get-Content` + `ConvertFrom-Json`) | | "All controls accessible" | `inspect --interactive --json` + check all have AutomationId |

### Step 3: Run and Read Results

```powershell .\ui-tests.ps1 -AppPid <PID> ```

Read `test-results.json` for structured pass/fail. Only fix code if tests fail.

### Step 3.5: Look at the Screenshots

UIA assertions don't see clipping, overlap, wrong theming, or controls bleeding past their container — UIA returns `PASS` while the app is visually broken. **Capture screenshots with `winapp ui screenshot` and view each PNG.**

Capture the initial state and any state after a major interaction (the State Screenshots block in the script template above handles this).

**Visual checklist — fail the run if any item is `no`:** - [ ] No unintended scrollbars - [ ] No text ending in `…` that shouldn't be - [ ] Hero elements fully visible (not sliced) - [ ] Right-edge controls fully visible - [ ] No overlapping rows - [ ] Content uses the available width — no asymmetric dead zones (e.g. content pinned to one edge leaving empty space on the other) - [ ] Spacing intentional — not cramped, not unintentionally vast - [ ] Theming matches the user's ask (Light/Dark/HighContrast if relevant) - [ ] Focus/hover/error states render if tested

If the checklist fails, it's a bug — fix before declaring done. Window too small → grow per `winui-design` Step 4.

### Step 4: Fix and Rerun (if the user asked for it)

If tests fail: 1. Read the failure details from `test-results.json` 2. Batch-fix all issues in one pass 3. Rebuild with `.\BuildAndRun.ps1` (blocking mode — shows crash info if the fix broke something) 4. Rerun `.\ui-tests.ps1 -AppPid <PID>` (parse PID from the `launched (PID: XXXXX)` output)

**Maximum 2 fix-and-rerun cycles.** If the same tests keep failing after 2 cycles, report them as known issues and move on — do not keep iterating.

### Assertion Reference

Use `wait-for --value` as the primary assertion — it uses a smart fallback chain that reads the right value for any control type:

| Control type | `--value` reads from | Example | |---|---|---| | TextBlock / Label | Name property | `wait-for "LblTitle" --value "Home"` | | TextBox / NumberBox | ValuePattern | `wait-for "TxtName" --value "John"` | | RichEditBox | TextPattern | `wait-for "Editor" --value "Hello"` | | ComboBox | Selected item (SelectionPattern) | `wait-for "CmbTheme" --value "Dark"` | | ToggleSwitch | Toggle state (On/Off) | `wait-for "TglDark" --value "On"` | | CheckBox | Toggle state (On/Off) | `wait-for "ChkAgree" --value "On"` |

**Full assertion commands:**

| Assertion | Command | |---|---| | Element exists | `winapp ui w