Add first UI automation for workspaces editor

* empowering users to maximize OOBE to their heart desire (#37823)

empowering users to maximize to their heart desire

* Add More Elements support for UITestAutomation

* Add Mouse Click and Base Components Test

* Add FindMyMouse Tests for Enable and Disable

* Add Mouse Highlighter Enable/Disable Test Case

* Add Mouse Actions Support for UITest Framework

* Delete src/modules/MouseUtils/FindMyMouse.UITests/FindMyMouseSettingTests.cs

* Update NameSpace and remove redundant code

* Update the SessionHelper and Sleep Time for Actions

* Add SendKey for Session and Fix Spelling Errors

* Add Tests for Mouse Pointer Crosshairs Enable/Disable

* Add Sleep Time to Action Parameters

* Add Edit System Settings

* Add MouseJump Enable/Disable Tests

* Fix Pipeline error for MouseHighlighter

* Fix pipeline error

* Resolve Spelling errors

* Fix pipeline errors

* Add FindMyMouse Setting Tests

* Update the Sleep time

* Update Sleep Time

* Fix pipeline errors

* Revert pipeline settings

---------

Co-authored-by: Clint Rutkas <clint@rutkas.com>
Co-authored-by: Yaqing Mi (from Dev Box) <yaqingmi@microsoft.com>

PowerToys.sln

@@ -708,6 +708,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.CmdPal.Ext.System
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MouseUtils.UITests", "src\modules\MouseUtils\MouseUtils.UITests\MouseUtils.UITests.csproj", "{4E0AE3A4-2EE0-44D7-A2D0-8769977254A1}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WorkspacesEditorUITest", "src\modules\Workspaces\WorkspacesEditorUITest\WorkspacesEditorUITest.csproj", "{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|ARM64 = Debug|ARM64
@@ -2588,6 +2590,14 @@ Global
 		{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
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Debug|ARM64.ActiveCfg = Debug|ARM64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Debug|ARM64.Build.0 = Debug|ARM64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Debug|x64.ActiveCfg = Debug|x64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Debug|x64.Build.0 = Debug|x64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Release|ARM64.ActiveCfg = Release|ARM64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Release|ARM64.Build.0 = Release|ARM64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Release|x64.ActiveCfg = Release|x64
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -2859,6 +2869,7 @@ Global
 		{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}
+		{43E779F3-D83C-48B1-BA8D-1912DBD76FC9} = {A2221D7E-55E7-4BEA-90D1-4F162D670BBF}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {C3A2F9D1-7930-4EF4-A6FC-7EE0A99821D0}

src/common/UITestAutomation/Element/NavigationViewItem.cs

@@ -48,6 +48,32 @@ namespace Microsoft.PowerToys.UITest
                 msPostAction);
         }
 
+        /// <summary>
+        /// Click the ListItem element.
+        /// </summary>
+        /// <param name="rightClick">If true, performs a right-click; otherwise, performs a left-click. Default value is false</param>
+        /// <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 void ClickCenter(bool rightClick = false, int msPreAction = 500, int msPostAction = 500)
+        {
+            PerformAction(
+                (actions, windowElement) =>
+                {
+                    if (rightClick)
+                    {
+                        actions.ContextClick();
+                    }
+                    else
+                    {
+                        actions.Click();
+                    }
+
+                    actions.Build().Perform();
+                },
+                msPreAction,
+                msPostAction);
+        }
+
         /// <summary>
         /// Double Click the ListItem element.
         /// </summary>

src/common/UITestAutomation/ModuleConfigData.cs

@@ -30,6 +30,7 @@ namespace Microsoft.PowerToys.UITest
         FancyZone,
         Hosts,
         Runner,
+        Workspaces,
     }
 
     /// <summary>
@@ -95,6 +96,7 @@ namespace Microsoft.PowerToys.UITest
                 [PowerToysModule.FancyZone] = "FancyZones Layout",
                 [PowerToysModule.Hosts] = "Hosts File Editor",
                 [PowerToysModule.Runner] = "PowerToys",
+                [PowerToysModule.Workspaces] = "Workspaces Editor",
             };
 
             // Exe start path for the module if it exists.
@@ -104,6 +106,7 @@ namespace Microsoft.PowerToys.UITest
                 [PowerToysModule.FancyZone] = @"\..\..\..\PowerToys.FancyZonesEditor.exe",
                 [PowerToysModule.Hosts] = @"\..\..\..\WinUI3Apps\PowerToys.Hosts.exe",
                 [PowerToysModule.Runner] = @"\..\..\..\PowerToys.exe",
+                [PowerToysModule.Workspaces] = @"\..\..\..\PowerToys.WorkspacesEditor.exe",
             };
         }
 

src/modules/MouseUtils/MouseUtils.UITests/FindMyMouseTests.cs

@@ -97,6 +97,62 @@ namespace MouseUtils.UITests
             VerifySpotlightDisappears(ref settings);
         }
 
+        [TestMethod]
+        public void TestEnableFindMyMouse2()
+        {
+            LaunchFromSetting();
+
+            var settings = new FindMyMouseSettings();
+            settings.OverlayOpacity = "100";
+            settings.Radius = "80";
+            settings.InitialZoom = "1";
+            settings.AnimationDuration = "0";
+            settings.BackgroundColor = "FFFFFF";
+            settings.SpotlightColor = "000000";
+
+            var foundCustom = this.Find<Custom>("Find My Mouse");
+            Assert.IsNotNull(foundCustom);
+
+            if (CheckAnimationEnable(ref foundCustom))
+            {
+                foundCustom = this.Find<Custom>("Find My Mouse");
+            }
+
+            if (foundCustom != null)
+            {
+                foundCustom.Find<ToggleSwitch>("Enable Find My Mouse").Toggle(true);
+
+                // foundCustom.Find<ToggleSwitch>("Enable Find My Mouse").Toggle(false);
+                SetFindMyMouseActivationMethod(ref foundCustom, "Press Left Control twice");
+                Assert.IsNotNull(foundCustom, "Find My Mouse group not found.");
+                SetFindMyMouseAppearanceBehavior(ref foundCustom, ref settings);
+
+                var excludedApps = foundCustom.Find<TextBlock>("Excluded apps");
+                if (excludedApps != null)
+                {
+                    excludedApps.Click();
+                    excludedApps.Click();
+                }
+                else
+                {
+                    Assert.Fail("Excluded apps group not found.");
+                }
+            }
+            else
+            {
+                Assert.Fail("Find My Mouse group not found.");
+            }
+
+            // [Test Case]Test the different settings and verify they apply, Background color
+            // [Test Case]Test the different settings and verify they apply, Spotlight color
+            // [Test Case]Test the different settings and verify they apply, Spotlight radius
+            VerifySpotlightSettings(ref settings);
+
+            // [Test Case]Enable FindMyMouse. Then, without moving your mouse: Press any other key and verify the overlay disappears.
+            Session.SendKeys(Key.A);
+            VerifySpotlightDisappears(ref settings);
+        }
+
         [TestMethod]
         public void TestDisableFindMyMouse()
         {
@@ -232,7 +288,7 @@ namespace MouseUtils.UITests
 
         private void VerifySpotlightAppears(ref FindMyMouseSettings settings)
         {
-            Task.Delay(1000).Wait();
+            Task.Delay(2000).Wait();
 
             var location = Session.GetMousePosition();
             int radius = int.Parse(settings.Radius, CultureInfo.InvariantCulture);
@@ -338,7 +394,7 @@ namespace MouseUtils.UITests
                 Assert.IsNotNull(button);
                 button.Click();
 
-                var popupWindow = Session.Find<Window>("Popup");
+                var popupWindow = this.Find<Window>("Popup");
                 Assert.IsNotNull(popupWindow);
                 Task.Delay(1000).Wait();
                 var colorModelComboBox = this.Find<ComboBox>("Color model");

src/modules/MouseUtils/MouseUtils.UITests/MouseHighlighterTests.cs

@@ -164,7 +164,9 @@ namespace MouseUtils.UITests
             var colorBackground = Session.GetPixelColorString(location.Item1 + radius + 50, location.Item2 + radius + 50);
             Assert.AreNotEqual(expectedColor, colorBackground);
 
-            Session.MoveMouseTo(location.Item1 - 300, location.Item2);
+            // Drag the mouse
+            Session.MoveMouseTo(location.Item1 - 200, location.Item2);
+            Task.Delay(2000).Wait();
 
             location = Session.GetMousePosition();
             colorLeftClick = Session.GetPixelColorString(location.Item1, location.Item2);

src/modules/MouseUtils/MouseUtils.UITests/MouseJumpTests.cs

@@ -127,14 +127,17 @@ namespace MouseUtils.UITests
         private void LaunchFromSetting(bool showWarning = false, bool launchAsAdmin = false)
         {
             Session.SetMainWindowSize(WindowSize.Large);
+            Task.Delay(1000).Wait();
 
             // Goto Hosts File Editor setting page
             if (this.FindAll<NavigationViewItem>("Mouse utilities").Count == 0)
             {
                 // Expand Advanced list-group if needed
-                this.Find<NavigationViewItem>("Input / Output").Click();
+                this.Find<NavigationViewItem>("Input / Output").ClickCenter();
             }
 
+            // Click on the Mouse utilities
+            Task.Delay(2000).Wait();
             this.Find<NavigationViewItem>("Mouse utilities").Click();
         }
     }

src/modules/MouseUtils/MouseUtils.UITests/MousePointerCrosshairsTests.cs

@@ -129,7 +129,7 @@ namespace MouseUtils.UITests
 
         private void VerifyMousePointerCrosshairsAppears(ref MousePointerCrosshairsSettings settings)
         {
-            Task.Delay(500).Wait();
+            Task.Delay(1000).Wait();
             string expectedColor = string.Empty;
             expectedColor = "#" + settings.CrosshairsColor;
             var location = Session.GetMousePosition();
@@ -137,19 +137,19 @@ namespace MouseUtils.UITests
             int radius = int.Parse(settings.CenterRadius, CultureInfo.InvariantCulture);
 
             var color = Session.GetPixelColorString(location.Item1, location.Item2);
-            Assert.AreEqual(expectedColor, color);
+            Assert.AreEqual(expectedColor, color, "Center color check failed");
 
             var colorX = Session.GetPixelColorString(location.Item1 + 50, location.Item2);
-            Assert.AreEqual(expectedColor, colorX);
+            Assert.AreEqual(expectedColor, colorX, "Center x + 50 color check failed");
 
             colorX = Session.GetPixelColorString(location.Item1 - 50, location.Item2);
-            Assert.AreEqual(expectedColor, colorX);
+            Assert.AreEqual(expectedColor, colorX, "Center x - 50 color check failed");
 
             var colorY = Session.GetPixelColorString(location.Item1, location.Item2 + 50);
-            Assert.AreEqual(expectedColor, colorY);
+            Assert.AreEqual(expectedColor, colorY, "Center y + 50 color check failed");
 
             colorY = Session.GetPixelColorString(location.Item1, location.Item2 - 50);
-            Assert.AreEqual(expectedColor, colorY);
+            Assert.AreEqual(expectedColor, colorY, "Center y + 50 color check failed");
         }
 
         private void SetColor(ref Custom foundCustom, string colorName, string colorValue = "000000")

src/modules/Workspaces/WorkspacesEditorUITest/WorkspacesEditorTests.cs

@@ -0,0 +1,24 @@
+// 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.PowerToys.UITest;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace WorkspacesEditorUITest;
+
+[TestClass]
+public class WorkspacesEditorTests : UITestBase
+{
+    public WorkspacesEditorTests()
+        : base(PowerToysModule.Workspaces, WindowSize.Medium)
+    {
+    }
+
+    [TestMethod("WorkspacesEditor.Items.Present")]
+    [TestCategory("Workspaces UI")]
+    public void TestItemsPresents()
+    {
+        Assert.IsTrue(this.Has<Button>("Create Workspace"), "Should have create workspace button");
+    }
+}

src/modules/Workspaces/WorkspacesEditorUITest/WorkspacesEditorUITest.csproj

@@ -0,0 +1,28 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="..\..\..\Common.Dotnet.CsWinRT.props" />
+
+  <PropertyGroup>
+    <LangVersion>latest</LangVersion>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <OutputType>Library</OutputType>
+    <RunVSTest>false</RunVSTest>
+    <IsTestProject>true</IsTestProject>
+    <IsPackable>false</IsPackable>
+    <AssemblyName>PowerToys.Workspaces.UITests</AssemblyName>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <OutputPath>..\..\..\..\$(Platform)\$(Configuration)\tests\Workspaces.UITests\</OutputPath>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Appium.WebDriver" />
+    <PackageReference Include="MSTest" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\common\UITestAutomation\UITestAutomation.csproj" />
+  </ItemGroup>
+
+</Project>