PowerToys/doc/releases/tests-checklist-template.md

Install tests

• install a previous version on a clean machine (a clean machine doesn't have the %localappdata%\Microsoft\PowerToys folder)
• open the Settings and for each module change at least one option
• open the FancyZones editor and create two custom layouts:
  • a canvas layout with 2 zones, use unicode chars in the layout's name
  • one from grid template using 4 zones and splitting one zone
  • apply the custom canvas layout to the primary desktop
  • create a virtual desktop and apply the custom grid layout
  • if you have a second monitor apply different templates layouts for the primary desktop and for the second virtual desktop
• install the new version (it will uninstall the old version and install the new version)

• verify the settings are preserved and FancyZones configuration is still the same

Functional tests

Regressions:

• https://github.com/microsoft/PowerToys/issues/1414#issuecomment-593529038
• https://github.com/microsoft/PowerToys/issues/1524

Localization

Change the Winodws language to a language different than English. Then verify if the following screens change their language:

• System tray menu items
• Settings
• OOBE (What's new)
• Keyboard Manager Editor
• Color Picker (check the tooltips)
• FancyZones Editor
• Power Rename (new WinUI 3 may not be localized)
• Image Resizer
• Shortcut Guide (Windows controls are localized)
• File Explorer menu entries for Image Resizer and Power Rename

General Settings

Admin mode:

• restart PT and verify it runs as user
• restart as admin and set "Always run as admin"
• restart PT and verify it runs as admin

• if it's not on, turn on "Run at startup"

• reboot the machine and verify PT runs as admin (it should not prompt the UAC dialog)

• turn Always run as admin" off

• reboot the machine and verify it now runs as user

Modules on/off:

• turn off all the modules and verify all module are off
• restart PT and verify that all module are still off in the settings page and they are actually inactive
• turn on all the module, all module are now working
• restart PT and verify that all module are still on in the settings page and they are actually working

Color Picker

• Enable the Color Picker in settings and ensure that the hotkey brings up Color Picker
  • when PowerToys is running unelevated on start-up
  • when PowerToys is running as admin on start-up
  • when PowerToys is restarted as admin, by clicking the restart as admin button in the settings

• Change Activate Color Picker shortcut and check the new shortcut is working
• Try all three Activation behaviors(Color Picker with editor mode enabled, Editor, Color Picker only)
• Change Color format for clipboard and check if the correct format is copied from the Color picker
• Try to copy color formats to the clipboard from the Editor
• Check Show color name and verify if color name is shown in the Color picker
• Enable one new format, disable one existing format, reorder enabled formats and check if settings are populated to the Editor
• Select a color from the history in the Editor
• Remove color from the history in the Editor
• Open the Color Picker from the Editor
• Open Adjust color from the Editor
• Check Color Picker logs for errors

FancyZones Editor

• Open editor from the settings
• Open editor with a shortcut
• Create a new layout (grid and canvas)
• Duplicate a template and a custom layout
• Delete layout
• Edit templates (number of zones, spacing, distance to highlight adjacent zones). Verify after reopening the editor that saved settings are kept the same.
• Edit canvas layout: zones size and position, create or delete zones.
• Edit grid layout: split, merge, resize zones.
• Check Save and apply and Cancel buttons behavior after editing.
• Assign a layout to each monitor.
• Assign keys to quickly switch layouts (custom layouts only), Win + Ctrl + Alt + number.

FancyZones

• Switch between Allow zones to span across monitors on and off. Verify that layouts are applied correctly in both cases.
• Change zone colors and opacity.
• Exclude some apps, verify that they're not applicable to a zone.
• Launch PT in user mode, try to assign a window with administrator privileges to a zone. Verify the notification is shown.
• Launch PT in administrator mode, assign a window with administrator privileges.
• Create virtual desktop, verify that there are the same layouts as applied to the previous virtual desktop.
• After creating a virtual desktop apply another layout or edit the applied one. Verify that the other virtual desktop layout wasn't changed.
• Delete an applied custom layout in the Editor, verify that there is no layout applied instead of it.

• Switch between layouts with quick keys.
  • Switch with Win + Ctrl + Alt + key
  • Switch with just a key while dragging a window.
• Change screen resolution or scaling.
  • Assign grid layout, verify that the assigned layout fits the screen. NOTE: canvas layout could not fit the screen if it was created on a monitor with a different resolution.

• Disable FZ
• Re-enable FZ, verify that everything is in the same state as it was before disabling.

• Test layout resetting. Before testing
  • Remove all virtual desktops
  • Remove CurrentVirtualDesktop from \HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\SessionInfo\1\VirtualDesktops
  • Remove VirtualDesktopIDs from \HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\VirtualDesktops

• Test screen locking

  • Set custom layouts on each monitor
  • Lock screen / unplug monitor / plug monitor
  • Verify that layouts weren't reset to defaults

• Test restart

  • Set custom layouts on each monitor
  • Restart the computer
  • Verify that layouts weren't reset to defaults

File Explorer Add-ons

• Running as user:
  • go to PowerToys repo root
  • verify the README.md Preview Pane shows the correct content
  • go to PowerToys repo and visit src\runner\svgs
  • verify Preview Pane works for the SVG files
  • verify the Icon Preview works for the SVG file (loop through different icon preview sizes)
• Running as admin:
  • open the Settings and turn off the Preview Pane and Icon Previous toggles
  • go to PowerToys repo root
  • verify the README.md Preview Pane doesn't show any content
  • go to PowerToys repo and visit src\runner\svgs
  • verify Preview Pane doesn't show the preview for the SVG files
  • the Icon Preview for the existing SVG will still show since the icons are cached (you can also use cleanmgr.exe to clean all thumbnails cached in your system). You may need to restart the machine for this setting to apply as well.
  • copy and paste one of the SVG file and verify the new file show the generic SVG icon

Image Resizer

• Disable the Image Resizer and check that Resize images is absent in the context menu

• Enable the Image Resizer and check that Resize images is present in the context menu

• Remove one image size and add a custom image size. Open the Image Resize window from the context menu and verify that changes are populated

• Resize one image

• Resize multiple images

• Open the image resizer to resize a .gif file and verify the "Gif files with animations may not be correctly resized." warning appears.

• Resize images with Fill option

• Resize images with Fit option

• Resize images with Stretch option

• Resize images using dimension: Centimeters

• Resize images using dimension: Inches

• Resize images using dimension: Percents

• Resize images using dimension: Pixels

• Change Filename format to %1 - %2 - %3 - %4 - %5 - %6 and check if the new format is applied to resized images

• Check Use original date modified and verify that modified date is not changed for resized images. Take into account that Resize the original pictures(don't create copy) should be selected

• Check Make pictures smaller but not larger and verify that smaller pictures are not resized

• Check Resize the original pictures (don't create copies) and verify that the original picture is resized and a copy is not created

• Uncheck Ignore the orientation of pictures and verify that swapped width and height will actually resize a picture if the width is not equal to the height

Keyboard Manager

UI Validation:

• In Remap keys, add and remove rows to validate those buttons. While the blank rows are present, pressing the OK button should result in a warning dialog that some mappings are invalid.
• Using only the Type buttons, for both the remap windows, try adding keys/shortcuts in all the columns. The right-side column in both windows should accept both keys and shortcuts, while the left-side column will accept only keys or only shortcuts for Remap keys and Remap shortcuts respectively. Validate that the Hold Enter and Esc accessibility features work as expected.
• Using the drop downs try to add key to key, key to shortcut, shortcut to key and shortcut to shortcut remapping and ensure that you are able to select remapping both by using mouse and by keyboard navigation.
• Validate that remapping can be saved by pressing the OK button and re-opening the windows loads existing remapping.

Remapping Validation:

For all the remapping below, try pressing and releasing the remapped key/shortcut and pressing and holding it. Try different behaviors like releasing the modifier key before the action key and vice versa.

• Test key to key remapping
  • A->B
  • Ctrl->A
  • A->Ctrl
  • Win->B (make sure Start menu doesn't appear accidentally)
  • B->Win (make sure Start menu doesn't appear accidentally)
  • A->Disable
  • Win->Disable
• Test key to shortcut remapping
  • A->Ctrl+V
  • B->Win+A
• Test shortcut to shortcut remapping
  • Ctrl+A->Ctrl+V
  • Win+A->Ctrl+V
  • Ctrl+V->Win+A
  • Win+A->Win+F
• Test shortcut to key remapping
  • Ctrl+A->B
  • Ctrl+A->Win
  • Win+A->B

• Test app-specific remaps
  • Similar remaps to above with Edge (entered as msedge), VSCode (entered as code) and cmd. For cmd try admin and non-admin (requires PT to run as admin)
  • Try some cases where focus is lost due to the shortcut. Example remapping to Alt+Tab or Alt+F4

• Test switching between remapping while holding down modifiers - Eg. Ctrl+D->Ctrl+A and Ctrl+E->Ctrl+V, hold Ctrl and press D followed by E. Should select all and paste over it in a text editor. Similar steps for Windows key shortcuts.

PowerRename

• Check if disable and enable of the module works.
• Check that with the Show icon on context menu icon is shown and vice versa.
• Check if Appear only in extended context menu works.
• Enable/disable autocomplete.
• Enable/disable Show values from last use.

• Select several files and folders and check PowerRename options:
  • Make Uppercase/Lowercase/Titlecase (could be selected only one at the time)
  • Exclude Folders/Files/Subfolder Items (could be selected several)
  • Item Name/Extension Only (one at the time)
  • Enumerate Items
  • Case Sensitive
  • Match All Occurrences. If checked, all matches of text in the Search field will be replaced with the Replace text. Otherwise, only the first instance of the Search for text in the file name will be replaced (left to right).
  • Use regular expressions
    • Search with an expression (e.g. (.*).png)
    • Replace with an expression (e.g. foo_$1.png)
    • Replace using file creation date and time (e.g. $hh-$mm-$ss-$fff $DD_$MMMM_$YYYY)
    • Turn on Use Boost library and test with Perl Regular Expression Syntax (e.g. (?<=t)est)
  • File list filters.
    • In the preview window uncheck some items to exclude them from renaming.
    • Click on the Renamed column to filter results.
    • Click on the Original column to cycle between checked and unchecked items.

PowerToys Run

• Enable PT Run in settings and ensure that the hotkey brings up PT Run
  • when PowerToys is running unelevated on start-up
  • when PowerToys is running as admin on start-up
  • when PowerToys is restarted as admin, by clicking the restart as admin button in settings.
• Check that each of the plugins is working:
  • Program - launch a Win32 application
  • Program - launch a Win32 application as admin
  • Program - launch a packaged application
  • Calculator - ensure a mathematical input returns a correct response and is copied on enter.
  • Windows Search - open a file on the disk.
  • Windows Search - find a file and copy file path.
  • Windows Search - find a file and open containing folder.
  • Shell - execute a command. Enter the action keyword >, followed by the query, both with and without space (e.g. > ping localhost).
  • Folder - Search and open a sub-folder on entering the path.
  • Uri - launch a web page on entering the uri.
  • Window walker - Switch focus to a running window.
  • Service - start, stop, restart windows service. Enter the action keyword ! to get the list of services.
  • Registry - navigate through the registry tree and open registry editor. Enter the action keyword : to get the root keys.
  • Registry - navigate through the registry tree and copy key path.
  • System - test lock.
  • System - test empty recycle bin.
  • System - test shutdown.

• Disable PT Run and ensure that the hotkey doesn't bring up PT Run.

• Test tab navigation.

• Test Plugin Manager
  • Enable/disable plugins and verify changes are picked up by PT Run
  • Change Direct activation phrase and verify changes are picked up by PT Run
  • Change Include in global result and verify changes picked up by PT Run
  • Clear Direct activation phrase and uncheck Include in global result. Verify a warning message is shown.
  • Disable all plugins and verify the warning message is shown.

Shortcut Guide

• Run PowerToys as user:
  • Verify Win + Shift + / opens the guide
  • Change the hotkey to a different shortcut (e.g. Win + /) and verify it works
  • Set Shortcut Guide to start with a Windows key press and verify it works.
• Restore the Win + Shift + / hotkey.
  • Open the guide and close it pressing Esc
  • Open the guide and close it pressing and releasing the Win key
• With PowerToys running as a user, open an elevated app and keep it on foreground:
  • Verify Win + Shift + / opens the guide
  • Verify some of the shortcuts shown in the guide work and the guide is closed when pressed

OOBE

• Quit PowerToys
• Delete %localappdata%\Microsoft\PowerToys

• Start PowerToys and verify OOBE opens

• Visit each OOBE section and for each section:
  • open the Settings for that module
  • verify the Settings work as expected (toggle some controls on/off etc.)
  • close the Settings
  • if it's available, test the Launch module name button
• Close OOBE

• Open the Settings and from the General page open OOBE using the Welcome to PowerToys link

Mouse Utils

Find My Mouse:

• Enable FindMyMouse. Then, without moving your mouse:
  • Press Left Ctrl twice and verify the overlay appears.
  • Press any other key and verify the overlay disappears.
  • Press Left Ctrl twice and verify the overlay appears.
  • Press a mouse button and verify the overlay disappears.
• Disable FindMyMouse. Verify the overlay no longer appears when you press Left Ctrl twice.
• Enable FindMyMouse. Then, without moving your mouse:
  • Press Left Ctrl twice and verify the overlay appears.
• Enable the "Do not activate on game mode" option. Start playing a game that uses CG native full screen.
  • Verify the overlay no longer appears when you press Left Ctrl twice.
• Disable the "Do not activate on game mode" option. Start playing the same game.
  • Verify the overlay appears when you press Left Ctrl twice. (though it'll likely minimize the game)
• Test the different settings and verify they apply:
  • Overlay opacity
  • Background color
  • Spotlight color
  • Spotlight radius
  • Spotlight initial zoom (1x vs 9x will show the difference)
  • Animation duration

Mouse Highlighter:

• Enable Mouse Highlighter. Then:
  • Press the activation shortcut and press left and right click somewhere, verifying the hightlights are applied.
  • With left mouse button pressed, drag the mouse and verify the hightlight is dragged with the pointer.
  • With right mouse button pressed, drag the mouse and verify the hightlight is dragged with the pointer.
  • Press the activation shortcut again and verify no highlights appear when the mouse buttons are clicked.
  • Disable Mouse Highlighter and verify that the module is not activated when you press the activation shortcut.
• Test the different settings and verify they apply:
  • Change activation shortcut and test it
  • Left button highlight color
  • Right button highlight color
  • Opacity
  • Radius
  • Fade delay
  • Fade duration

VCM

• Check "Hide toolbar when both camera and micrphone are unmuted" and verify that it works
• Uncheck it, mute the microphone with the hotkey and make sure the toolbar doesn't hide after a timeout
• Go to some video conference application settings, e.g. meet.google.com, Microsoft Teams, Skype. "Select PowerToys VideoConference Mute" camera as an active device and try to mute it with a hotkey
• Go to Control Panel -> Sound -> Recording -> select default mic -> open its properties -> Levels. Now mute the microphone with a corresponding hotkey and verify that mute icon on the right side of volume slider reflects its muted status.
• Verify that changing "toolbar position" setting works
• Select an overlay image and verify that muting camera now shows the image instead of black screen. (Don't forget to restart the application which uses the camera).
• Try to select an overlay image when PT process is elevated. (Currently doesn't work)

Awake

• Try out the features and see if they work, no list at this time.

Always on Top

• Try out the features and see if they work, no list at this time.