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-04 10:16:24 +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/ModuleConfigData.cs
+++ b/src/common/UITestAutomation/ModuleConfigData.cs
@@ -0,0 +1,72 @@
+// 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.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("UITestBase")]
+[assembly: InternalsVisibleTo("Session")]
+
+namespace Microsoft.PowerToys.UITest
+{
+    /// <summary>
+    /// This file manages the configuration of modules for UI tests.
+    /// </summary>
+    /// <remarks>
+    /// How to add a new module:
+    /// 1. Define the new module in the PowerToysModule enum.
+    /// 2. Add the exe window name to the ModuleWindowName dictionary in the ModuleConfigData constructor.
+    /// 3. Add the exe path to the ModulePath dictionary in the ModuleConfigData constructor.
+    /// </remarks>
+
+    /// <summary>
+    /// Represents the modules in PowerToys.
+    /// </summary>
+    public enum PowerToysModule
+    {
+        PowerToysSettings,
+        FancyZone,
+        Hosts,
+    }
+
+    internal class ModuleConfigData
+    {
+        private Dictionary<PowerToysModule, string> ModulePath { get; }
+
+        // Singleton instance of ModuleConfigData.
+        private static readonly Lazy<ModuleConfigData> SingletonInstance = new Lazy<ModuleConfigData>(() => new ModuleConfigData());
+
+        public static ModuleConfigData Instance => SingletonInstance.Value;
+
+        public const string WindowsApplicationDriverUrl = "http://127.0.0.1:4723";
+
+        public Dictionary<PowerToysModule, string> ModuleWindowName { get; }
+
+        private ModuleConfigData()
+        {
+            // The exe window name for each module.
+            ModuleWindowName = new Dictionary<PowerToysModule, string>
+            {
+                [PowerToysModule.PowerToysSettings] = "PowerToys Settings",
+                [PowerToysModule.FancyZone] = "FancyZones Layout",
+                [PowerToysModule.Hosts] = "Hosts File Editor",
+            };
+
+            // Exe start path for the module if it exists.
+            ModulePath = new Dictionary<PowerToysModule, string>
+            {
+                [PowerToysModule.PowerToysSettings] = @"\..\..\..\WinUI3Apps\PowerToys.Settings.exe",
+                [PowerToysModule.FancyZone] = @"\..\..\..\PowerToys.FancyZonesEditor.exe",
+                [PowerToysModule.Hosts] = @"\..\..\..\WinUI3Apps\PowerToys.Hosts.exe",
+            };
+        }
+
+        public string GetModulePath(PowerToysModule scope) => ModulePath[scope];
+
+        public string GetWindowsApplicationDriverUrl() => WindowsApplicationDriverUrl;
+
+        public string GetModuleWindowName(PowerToysModule scope) => ModuleWindowName[scope];
+    }
+}