UI Test Automation for FindMyMouse Enable/Disable and MouseHighlighter Enable/Disable

PowerToys.sln

@@ -706,6 +706,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RegistryPreview.FuzzTests",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.CmdPal.Ext.System", "src\modules\cmdpal\Exts\Microsoft.CmdPal.Ext.System\Microsoft.CmdPal.Ext.System.csproj", "{64B88F02-CD88-4ED8-9624-989A800230F9}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MouseUtils.UITests", "src\modules\MouseUtils\MouseUtils.UITests\MouseUtils.UITests.csproj", "{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|ARM64 = Debug|ARM64
@@ -2574,14 +2576,18 @@ Global
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Debug|ARM64.Build.0 = Debug|ARM64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Debug|x64.ActiveCfg = Debug|x64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Debug|x64.Build.0 = Debug|x64
-		{64B88F02-CD88-4ED8-9624-989A800230F9}.Debug|x86.ActiveCfg = Debug|x64
-		{64B88F02-CD88-4ED8-9624-989A800230F9}.Debug|x86.Build.0 = Debug|x64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|ARM64.ActiveCfg = Release|ARM64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|ARM64.Build.0 = Release|ARM64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|x64.ActiveCfg = Release|x64
 		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|x64.Build.0 = Release|x64
-		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|x86.ActiveCfg = Release|x64
-		{64B88F02-CD88-4ED8-9624-989A800230F9}.Release|x86.Build.0 = Release|x64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Debug|ARM64.ActiveCfg = Debug|ARM64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Debug|ARM64.Build.0 = Debug|ARM64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Debug|x64.ActiveCfg = Debug|x64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Debug|x64.Build.0 = Debug|x64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Release|ARM64.ActiveCfg = Release|ARM64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Release|ARM64.Build.0 = Release|ARM64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Release|x64.ActiveCfg = Release|x64
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -2852,6 +2858,7 @@ Global
 		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A0} = {F05E590D-AD46-42BE-9C25-6A63ADD2E3EA}
 		{5702B3CC-8575-48D5-83D8-15BB42269CD3} = {929C1324-22E8-4412-A9A8-80E85F3985A5}
 		{64B88F02-CD88-4ED8-9624-989A800230F9} = {ECB8E0D1-7603-4E5C-AB10-D1E545E6F8E2}
+		{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1} = {322566EF-20DC-43A6-B9F8-616AF942579A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {C3A2F9D1-7930-4EF4-A6FC-7EE0A99821D0}

src/common/UITestAutomation/Element/ComboBox.cs

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace Microsoft.PowerToys.UITest
+{
+    public class ComboBox : Element
+    {
+        private static readonly string ExpectedControlType = "ControlType.ComboBox";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ComboBox"/> class.
+        /// </summary>
+        public ComboBox()
+        {
+            this.TargetControlType = ComboBox.ExpectedControlType;
+        }
+
+        /// <summary>
+        /// Select the item of the ComboBox.
+        /// </summary>
+        /// <param name="value">The text to select from the list view.</param>
+        public void Select(string value)
+        {
+            this.Find<NavigationViewItem>(value).Click();
+        }
+    }
+}

src/common/UITestAutomation/Element/Custom.cs

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerToys.UITest
+{
+    public class Custom : Element
+    {
+        private static readonly string ExpectedControlType = "ControlType.Custom";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Custom"/> class.
+        /// </summary>
+        public Custom()
+        {
+            this.TargetControlType = Custom.ExpectedControlType;
+        }
+    }
+}

src/common/UITestAutomation/Element/Element.cs

@@ -113,9 +113,10 @@ public string ControlType
         /// Click the UI element.
         /// </summary>
         /// <param name="rightClick">If true, performs a right-click; otherwise, performs a left-click. Default value is false</param>
-        public virtual void Click(bool rightClick = false)
+        public virtual void Click(bool rightClick = false, int msPreAction = 500, int msPostAction = 500)
         {
-            PerformAction((actions, windowElement) =>
+            PerformAction(
+                (actions, windowElement) =>
             {
                 actions.MoveToElement(windowElement);
 
@@ -132,7 +133,9 @@ public virtual void Click(bool rightClick = false)
                 }
 
                 actions.Build().Perform();
-            });
+            },
+                msPreAction,
+                msPostAction);
         }
 
         /// <summary>

src/common/UITestAutomation/Element/Group.cs

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerToys.UITest
+{
+    public class Group : Element
+    {
+        private static readonly string ExpectedControlType = "ControlType.Group";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Group"/> class.
+        /// </summary>
+        public Group()
+        {
+            this.TargetControlType = Group.ExpectedControlType;
+        }
+    }
+}

src/common/UITestAutomation/Element/NavigationViewItem.cs

@@ -24,9 +24,12 @@ public NavigationViewItem()
         /// Click the ListItem element.
         /// </summary>
         /// <param name="rightClick">If true, performs a right-click; otherwise, performs a left-click. Default value is false</param>
-        public override void Click(bool rightClick = false)
+        /// <param name="msPreAction">Pre action delay in milliseconds. Default value is 500</param>
+        /// <param name="msPostAction">Post action delay in milliseconds. Default value is 500</param>
+        public override void Click(bool rightClick = false, int msPreAction = 500, int msPostAction = 500)
         {
-            PerformAction((actions, windowElement) =>
+            PerformAction(
+                (actions, windowElement) =>
             {
                 actions.MoveToElement(windowElement, 10, 10);
 
@@ -40,7 +43,9 @@ public override void Click(bool rightClick = false)
                 }
 
                 actions.Build().Perform();
-            });
+            },
+                msPreAction,
+                msPostAction);
         }
 
         /// <summary>

src/common/UITestAutomation/Element/Slider.cs

@@ -0,0 +1,119 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.Appium.Windows;
+
+namespace Microsoft.PowerToys.UITest
+{
+    public class Slider : Element
+    {
+        private static readonly string ExpectedControlType = "ControlType.Slider";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Slider"/> class.
+        /// </summary>
+        public Slider()
+        {
+            this.TargetControlType = Slider.ExpectedControlType;
+        }
+
+        /// <summary>
+        /// Gets the value of a Slider (WindowsElement)
+        /// </summary>
+        /// <returns>The integer value of the slider</returns>
+        public int GetValue()
+        {
+            return this.Text == string.Empty ? 0 : int.Parse(this.Text);
+        }
+
+        /// <summary>
+        /// Sets the value of a Slider (WindowsElement) to the specified integer value.
+        /// Throws an exception if the value is out of the slider's valid range.
+        /// </summary>
+        /// <param name="targetValue">The target integer value to set</param>
+        public void SetValue(int targetValue)
+        {
+            // Read range and current value
+            int min = int.Parse(this.GetAttribute("RangeValue.Minimum"));
+            int max = int.Parse(this.GetAttribute("RangeValue.Maximum"));
+            int current = int.Parse(this.Text);
+
+            // Use Assert to check if the target value is within the valid range
+            Assert.IsTrue(
+                targetValue >= min && targetValue <= max,
+                $"Target value {targetValue} is out of range (min: {min}, max: {max}).");
+
+            // Compute difference
+            int diff = targetValue - current;
+            if (diff == 0)
+            {
+                return;
+            }
+
+            string key = diff > 0 ? OpenQA.Selenium.Keys.Right : OpenQA.Selenium.Keys.Left;
+            int steps = Math.Abs(diff);
+
+            for (int i = 0; i < steps; i++)
+            {
+                this.SendKeys(key);
+
+                // Thread.Sleep(2);
+            }
+
+            // Final check
+            int finalValue = int.Parse(this.Text);
+            Assert.AreEqual(
+                targetValue, finalValue, $"Slider value mismatch: expected {targetValue}, but got {finalValue}.");
+        }
+
+        /// <summary>
+        /// Sets the value of a Slider (WindowsElement) to the specified integer value.
+        /// Throws an exception if the value is out of the slider's valid range.
+        /// </summary>
+        /// <param name="targetValue">The target integer value to set</param>
+        public void QuickSetValue(int targetValue)
+        {
+            // Read range and current value
+            int min = int.Parse(this.GetAttribute("RangeValue.Minimum"));
+            int max = int.Parse(this.GetAttribute("RangeValue.Maximum"));
+            int current = int.Parse(this.Text);
+
+            // Use Assert to check if the target value is within the valid range
+            Assert.IsTrue(
+                targetValue >= min && targetValue <= max,
+                $"Target value {targetValue} is out of range (min: {min}, max: {max}).");
+
+            // Compute difference
+            int diff = targetValue - current;
+            if (diff == 0)
+            {
+                return;
+            }
+
+            string key = diff > 0 ? OpenQA.Selenium.Keys.Right : OpenQA.Selenium.Keys.Left;
+            int steps = Math.Abs(diff);
+
+            int maxKeysPerSend = 50;
+            int fullChunks = steps / maxKeysPerSend;
+            int remainder = steps % maxKeysPerSend;
+            for (int i = 0; i < fullChunks; i++)
+            {
+                SendKeys(new string(key[0], maxKeysPerSend));
+                Thread.Sleep(2);
+            }
+
+            if (remainder > 0)
+            {
+                SendKeys(new string(key[0], remainder));
+                Thread.Sleep(2);
+            }
+
+            // Final check
+            int finalValue = int.Parse(this.Text);
+            Assert.AreEqual(
+                targetValue, finalValue, $"Slider value mismatch: expected {targetValue}, but got {finalValue}.");
+        }
+    }
+}

src/common/UITestAutomation/KeyboardHelper.cs

@@ -17,6 +17,8 @@ namespace Microsoft.PowerToys.UITest
     public enum Key
     {
         Ctrl,
+        LCtrl,
+        RCtrl,
         Alt,
         Shift,
         Tab,
@@ -122,6 +124,12 @@ public static void ReleaseKey(Key key)
             ReleaseVirtualKey(TranslateKeyHex(key));
         }
 
+        public static void SendKey(Key key)
+        {
+            PressVirtualKey(TranslateKeyHex(key));
+            ReleaseVirtualKey(TranslateKeyHex(key));
+        }
+
         /// <summary>
         /// Translates a key to its corresponding SendKeys representation.
         /// </summary>
@@ -133,6 +141,10 @@ private static string TranslateKey(Key key)
             {
                 case Key.Ctrl:
                     return "^";
+                case Key.LCtrl:
+                    return "^";
+                case Key.RCtrl:
+                    return "^";
                 case Key.Alt:
                     return "%";
                 case Key.Shift:
@@ -285,6 +297,12 @@ private static byte TranslateKeyHex(Key key)
                     return 0x12;  // Alt Key - 0x12 in hex
                 case Key.Shift:
                     return 0x10;  // Shift Key - 0x10 in hex
+                case Key.LCtrl:
+                    return 0xA2;  // Left Ctrl Key - 0xA2 in hex
+                case Key.RCtrl: // Right Ctrl Key - 0xA3 in hex
+                    return 0xA3;
+                case Key.A:
+                    return 0x41;  // A Key - 0x41 in hex
                 default:
                     throw new ArgumentException($"Key {key} is not supported, Please add your key at TranslateKeyHex for translation to hex.");
             }

src/common/UITestAutomation/ModuleConfigData.cs

@@ -29,6 +29,7 @@ public enum PowerToysModule
         PowerToysSettings,
         FancyZone,
         Hosts,
+        Runner,
     }
 
     /// <summary>
@@ -93,6 +94,7 @@ private ModuleConfigData()
                 [PowerToysModule.PowerToysSettings] = "PowerToys Settings",
                 [PowerToysModule.FancyZone] = "FancyZones Layout",
                 [PowerToysModule.Hosts] = "Hosts File Editor",
+                [PowerToysModule.Runner] = "PowerToys",
             };
 
             // Exe start path for the module if it exists.
@@ -101,6 +103,7 @@ private ModuleConfigData()
                 [PowerToysModule.PowerToysSettings] = @"\..\..\..\WinUI3Apps\PowerToys.Settings.exe",
                 [PowerToysModule.FancyZone] = @"\..\..\..\PowerToys.FancyZonesEditor.exe",
                 [PowerToysModule.Hosts] = @"\..\..\..\WinUI3Apps\PowerToys.Hosts.exe",
+                [PowerToysModule.Runner] = @"\..\..\..\PowerToys.exe",
             };
         }