UITestAutomation Framework (#37461)

* Add UITestAutomation framework * add code comments * Optimized code format * Optimized code format * Update commons and add keyboard manager ui test project * Optimized code format * test scope and fix fancyzone exe path * Add readme * Optimize helper functions and UI test method * Fix spelling errors and restore module UI tests * Restore Indent * Update NOTICE.md * Update comments to Session and Elements * Update comments for Button and Window * delete unnecessary code * change FindElementByName to FindElmenet * Update comments for ModuleConfigData * Update readme and comments * Remove extra comments * change public property * Optimize code readability * add default Attach Function * change attach function name * Update comments to XML format * Hide by internal functions * Update readme * Refine the framework * Fix process start position and update readme * Remove Enum PowerToysModuleWindow * Update attach comments * Update ModuleConfigData comments --------- Co-authored-by: Zhaopeng Wang (from Dev Box) <zhaopengwang@microsoft.com> Co-authored-by: Xiaofeng Wang (from Dev Box) <xiaofengwang@microsoft.com> Co-authored-by: urnotdfs <709586527@qq.com>
2026-04-09 04:37:30 +02:00 · 2025-02-20 13:25:20 +08:00
parent a1a02889d5
commit 9453e38881
12 changed files with 889 additions and 0 deletions
--- a/src/common/UITestAutomation/Session.cs
+++ b/src/common/UITestAutomation/Session.cs
@@ -0,0 +1,129 @@
+// 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.ObjectModel;
+using System.IO;
+using System.Reflection;
+using System.Runtime.InteropServices;
+using System.Xml.Linq;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Appium;
+using OpenQA.Selenium.Appium.Windows;
+using OpenQA.Selenium.Interactions;
+
+namespace Microsoft.PowerToys.UITest
+{
+    /// <summary>
+    /// Provides interfaces for interacting with UI elements.
+    /// </summary>
+    public class Session
+    {
+        private WindowsDriver<WindowsElement> Root { get; set; }
+
+        private WindowsDriver<WindowsElement> WindowsDriver { get; set; }
+
+        [DllImport("user32.dll")]
+        private static extern bool SetForegroundWindow(nint hWnd);
+
+        public Session(WindowsDriver<WindowsElement> root, WindowsDriver<WindowsElement> windowsDriver)
+        {
+            this.Root = root;
+            this.WindowsDriver = windowsDriver;
+        }
+
+        /// <summary>
+        /// Finds an element by selector.
+        /// </summary>
+        /// <typeparam name="T">The class of the element, should be Element or its derived class.</typeparam>
+        /// <param name="by">The selector to find the element.</param>
+        /// <param name="timeoutMS">The timeout in milliseconds (default is 3000).</param>
+        /// <returns>The found element.</returns>
+        public T Find<T>(By by, int timeoutMS = 3000)
+            where T : Element, new()
+        {
+            Assert.IsNotNull(this.WindowsDriver, $"WindowsElement is null in method Find<{typeof(T).Name}> with parameters: by = {by}, timeoutMS = {timeoutMS}");
+            var foundElement = FindElementHelper.Find<T, WindowsElement>(
+                () =>
+                {
+                    var element = this.WindowsDriver.FindElement(by.ToSeleniumBy());
+                    Assert.IsNotNull(element, $"Element not found using selector: {by}");
+                    return element;
+                },
+                this.WindowsDriver,
+                timeoutMS);
+
+            return foundElement;
+        }
+
+        /// <summary>
+        /// Finds all elements by selector.
+        /// </summary>
+        /// <typeparam name="T">The class of the elements, should be Element or its derived class.</typeparam>
+        /// <param name="by">The selector to find the elements.</param>
+        /// <param name="timeoutMS">The timeout in milliseconds (default is 3000).</param>
+        /// <returns>A read-only collection of the found elements.</returns>
+        public ReadOnlyCollection<T>? FindAll<T>(By by, int timeoutMS = 3000)
+            where T : Element, new()
+        {
+            Assert.IsNotNull(this.WindowsDriver, $"WindowsElement is null in method FindAll<{typeof(T).Name}> with parameters: by = {by}, timeoutMS = {timeoutMS}");
+            var foundElements = FindElementHelper.FindAll<T, WindowsElement>(
+                () =>
+                {
+                    var elements = this.WindowsDriver.FindElements(by.ToSeleniumBy());
+                    Assert.IsTrue(elements.Count > 0, $"Elements not found using selector: {by}");
+                    return elements;
+                },
+                this.WindowsDriver,
+                timeoutMS);
+
+            return foundElements;
+        }
+
+        /// <summary>
+        /// Attaches to an existing PowerToys module.
+        /// </summary>
+        /// <param name="module">The PowerToys module to attach to.</param>
+        /// <returns>The attached session.</returns>
+        public Session Attach(PowerToysModule module)
+        {
+            string windowName = ModuleConfigData.Instance.GetModuleWindowName(module);
+            return this.Attach(windowName);
+        }
+
+        /// <summary>
+        /// Attaches to an existing exe by string window name.
+        /// The session should be attached when a new app is started.
+        /// </summary>
+        /// <param name="windowName">The window name to attach to.</param>
+        /// <returns>The attached session.</returns>
+        public Session Attach(string windowName)
+        {
+            if (this.Root != null)
+            {
+                var window = this.Root.FindElementByName(windowName);
+                Assert.IsNotNull(window, $"Failed to attach. Window '{windowName}' not found");
+
+                var windowHandle = new nint(int.Parse(window.GetAttribute("NativeWindowHandle")));
+                SetForegroundWindow(windowHandle);
+                var hexWindowHandle = windowHandle.ToString("x");
+                var appCapabilities = new AppiumOptions();
+                appCapabilities.AddAdditionalCapability("appTopLevelWindow", hexWindowHandle);
+                appCapabilities.AddAdditionalCapability("deviceName", "WindowsPC");
+                this.WindowsDriver = new WindowsDriver<WindowsElement>(new Uri(ModuleConfigData.Instance.GetWindowsApplicationDriverUrl()), appCapabilities);
+                Assert.IsNotNull(this.WindowsDriver, "Attach WindowsDriver is null");
+
+                // Set implicit timeout to make element search retry every 500 ms
+                this.WindowsDriver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(3);
+            }
+            else
+            {
+                Assert.IsNotNull(this.Root, $"Failed to attach to the window '{windowName}'. Root driver is null");
+            }
+
+            return this;
+        }
+    }
+}