Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.87 KB

UITests.md

File metadata and controls

91 lines (69 loc) · 2.87 KB

UI tests framework

A specialized UI test framework for PowerToys that makes it easy to write UI tests for PowerToys modules or settings. Let's start writing UI tests!

Before running tests

Running tests

  • Exit PowerToys if it's running.

  • Open PowerToys.sln in Visual Studio and build the solution.

  • Run tests in the Test Explorer (Test > Test Explorer or Ctrl+E, T).

How to add the first UI tests for your modules

  • Create a new project and add the following references to the project file. Change the OutputPath to your own module's path.

    	<PropertyGroup>
		<OutputType>Library</OutputType>
		<!-- This is a UI test, so don't run as part of MSBuild -->
		<RunVSTest>false</RunVSTest>
	</PropertyGroup>

	<PropertyGroup>
		<OutputPath>..\..\..\..\$(Platform)\$(Configuration)\tests\KeyboardManagerUITests\</OutputPath>
	</PropertyGroup>

	<ItemGroup>
	    <PackageReference Include="MSTest" />
	    <ProjectReference Include="..\..\..\common\UITestAutomation\UITestAutomation.csproj" />
	    <Folder Include="Properties\" />
  </ItemGroup>

  • Inherit your test class from UITestBase.

    Set Scope: The default scope starts from the PowerToys settings UI. If you want to start from your own module, set the constructor as shown below:

    Specify Scope:

    [TestClass]
public class RunFancyZonesTest : UITestBase
{
    public RunFancyZonesTest()
        : base(PowerToysModule.FancyZone)
    {
    }
}

  • Then you can start using session to perform the UI operations.

Example

using Microsoft.PowerToys.UITest;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace UITests_KeyboardManager
{
    [TestClass]
    public class RunKeyboardManagerUITests : UITestBase
    {
        [TestMethod]
        public void OpenKeyboardManagerEditor()
        {
            // Open KeyboardManagerEditor
            this.Session.Find<Button>(By.Name("Remap a key")).Click();
            this.Session.Attach("Remap keys");

            // Maximize window
            var window = Session.Find<Window>(By.Name("Remap keys")).Maximize();

            // Add Key Remapping
            this.Session.Find<Button>(By.Name("Add key remapping")).Click();
            window.Close();

            // Back to Settings
            this.Session.Attach(PowerToysModule.PowerToysSettings);
        }
    }
}

Extra tools and information

Accessibility Tools: While working on tests, you may need a tool that helps you to view the element's accessibility data, e.g. for finding the button to click. For this purpose, you could use AccessibilityInsights