PowerToys/src/common/UITestAutomation/UITestBase.cs

// 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.Collections.ObjectModel;
using System.Diagnostics;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using OpenQA.Selenium;

namespace Microsoft.PowerToys.UITest
{
    /// <summary>
    /// Base class that should be inherited by all Test Classes.
    /// </summary>
    [TestClass]
    public class UITestBase : IDisposable
    {
        public required TestContext TestContext { get; set; }

        public required Session Session { get; set; }

        public bool IsInPipeline { get; }

        public static MonitorInfoData.ParamsWrapper MonitorInfoData { get; set; } = new MonitorInfoData.ParamsWrapper() { Monitors = new List<MonitorInfoData.MonitorInfoDataWrapper>() };

        private readonly PowerToysModule scope;
        private readonly WindowSize size;
        private SessionHelper? sessionHelper;
        private System.Threading.Timer? screenshotTimer;
        private string? screenshotDirectory;

        public UITestBase(PowerToysModule scope = PowerToysModule.PowerToysSettings, WindowSize size = WindowSize.UnSpecified)
        {
            this.IsInPipeline = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("platform"));
            Console.WriteLine($"Running tests on platform: {Environment.GetEnvironmentVariable("platform")}");
            if (IsInPipeline)
            {
                NativeMethods.ChangeDisplayResolution(1920, 1080);
                NativeMethods.GetMonitorInfo();

                // Escape Popups before starting
                System.Windows.Forms.SendKeys.SendWait("{ESC}");
            }

            this.scope = scope;
            this.size = size;
        }

        /// <summary>
        /// Initializes the test.
        /// </summary>
        [TestInitialize]
        public void TestInit()
        {
            CloseOtherApplications();
            if (IsInPipeline)
            {
                screenshotDirectory = Path.Combine(this.TestContext.TestResultsDirectory ?? string.Empty, "UITestScreenshots_" + Guid.NewGuid().ToString());
                Directory.CreateDirectory(screenshotDirectory);

                // Take screenshot every 1 second
                screenshotTimer = new System.Threading.Timer(ScreenCapture.TimerCallback, screenshotDirectory, TimeSpan.Zero, TimeSpan.FromMilliseconds(1000));

                // Escape Popups before starting
                System.Windows.Forms.SendKeys.SendWait("{ESC}");
            }

            this.sessionHelper = new SessionHelper(scope).Init();
            this.Session = new Session(this.sessionHelper.GetRoot(), this.sessionHelper.GetDriver(), scope, size);
        }

        /// <summary>
        /// Cleanups the test.
        /// </summary>
        [TestCleanup]
        public void TestCleanup()
        {
            if (IsInPipeline)
            {
                screenshotTimer?.Change(Timeout.Infinite, Timeout.Infinite);
                Dispose();
                if (TestContext.CurrentTestOutcome is UnitTestOutcome.Failed
                    or UnitTestOutcome.Error
                    or UnitTestOutcome.Unknown)
                {
                    Task.Delay(1000).Wait();
                    AddScreenShotsToTestResultsDirectory();
                }
            }

            this.Session.Cleanup();
            this.sessionHelper!.Cleanup();
        }

        public void Dispose()
        {
            screenshotTimer?.Dispose();
            GC.SuppressFinalize(this);
        }

        /// <summary>
        /// Finds an element by selector.
        /// Shortcut for this.Session.Find<T>(by, timeoutMS)
        /// </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 5000).</param>
        /// <returns>The found element.</returns>
        protected T Find<T>(By by, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.Find<T>(by, timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Find<Element>(name, timeoutMS)
        /// </summary>
        /// <typeparam name="T">The class of the element, should be Element or its derived class.</typeparam>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>The found element.</returns>
        protected T Find<T>(string name, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.Find<T>(By.Name(name), timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Find<Element>(by, timeoutMS)
        /// </summary>
        /// <param name="by">The selector to find the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>The found element.</returns>
        protected Element Find(By by, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.Find(by, timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Find<Element>(name, timeoutMS)
        /// </summary>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>The found element.</returns>
        protected Element Find(string name, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.Find(name, timeoutMS, global);
        }

        /// <summary>
        /// Has only one Element or its derived class by selector.
        /// </summary>
        /// <typeparam name="T">The class of the element, should be Element or its derived class.</typeparam>
        /// <param name="by">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if only has one element, otherwise false.</returns>
        public bool HasOne<T>(By by, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.FindAll<T>(by, timeoutMS, global).Count == 1;
        }

        /// <summary>
        /// Shortcut for this.Session.HasOne<Element>(by, timeoutMS)
        /// </summary>
        /// <param name="by">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if only has one element, otherwise false.</returns>
        public bool HasOne(By by, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.HasOne<Element>(by, timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.HasOne<T>(name, timeoutMS)
        /// </summary>
        /// <typeparam name="T">The class of the element, should be Element or its derived class.</typeparam>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if only has one element, otherwise false.</returns>
        public bool HasOne<T>(string name, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.HasOne<T>(By.Name(name), timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.HasOne<Element>(name, timeoutMS)
        /// </summary>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if only has one element, otherwise false.</returns>
        public bool HasOne(string name, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.HasOne<Element>(name, timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Has<T>(by, timeoutMS)
        /// </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 5000).</param>
        /// <returns>True if  has one or more element, otherwise false.</returns>
        public bool Has<T>(By by, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.FindAll<T>(by, timeoutMS, global).Count >= 1;
        }

        /// <summary>
        /// Shortcut for this.Session.Has<Element>(by, timeoutMS)
        /// </summary>
        /// <param name="by">The selector to find the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if  has one or more element, otherwise false.</returns>
        public bool Has(By by, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.Has<Element>(by, timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Has<T>(By.Name(name), timeoutMS)
        /// </summary>
        /// <typeparam name="T">The class of the element, should be Element or its derived class.</typeparam>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if  has one or more element, otherwise false.</returns>
        public bool Has<T>(string name, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.Has<T>(By.Name(name), timeoutMS, global);
        }

        /// <summary>
        /// Shortcut for this.Session.Has<Element>(name, timeoutMS)
        /// </summary>
        /// <param name="name">The name of the element.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>True if  has one or more element, otherwise false.</returns>
        public bool Has(string name, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.Has<Element>(name, timeoutMS, global);
        }

        /// <summary>
        /// Finds all elements by selector.
        /// Shortcut for this.Session.FindAll<T>(by, timeoutMS)
        /// </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 5000).</param>
        /// <returns>A read-only collection of the found elements.</returns>
        protected ReadOnlyCollection<T> FindAll<T>(By by, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.FindAll<T>(by, timeoutMS, global);
        }

        /// <summary>
        /// Finds all elements by selector.
        /// Shortcut for this.Session.FindAll<Element>(By.Name(name), timeoutMS)
        /// </summary>
        /// <typeparam name="T">The class of the elements, should be Element or its derived class.</typeparam>
        /// <param name="name">The name of the elements.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>A read-only collection of the found elements.</returns>
        protected ReadOnlyCollection<T> FindAll<T>(string name, int timeoutMS = 5000, bool global = false)
            where T : Element, new()
        {
            return this.Session.FindAll<T>(By.Name(name), timeoutMS, global);
        }

        /// <summary>
        /// Finds all elements by selector.
        /// Shortcut for this.Session.FindAll<Element>(by, timeoutMS)
        /// </summary>
        /// <param name="by">The selector to find the elements.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>A read-only collection of the found elements.</returns>
        protected ReadOnlyCollection<Element> FindAll(By by, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.FindAll<Element>(by, timeoutMS, global);
        }

        /// <summary>
        /// Finds all elements by selector.
        /// Shortcut for this.Session.FindAll<Element>(By.Name(name), timeoutMS)
        /// </summary>
        /// <param name="name">The name of the elements.</param>
        /// <param name="timeoutMS">The timeout in milliseconds (default is 5000).</param>
        /// <returns>A read-only collection of the found elements.</returns>
        protected ReadOnlyCollection<Element> FindAll(string name, int timeoutMS = 5000, bool global = false)
        {
            return this.Session.FindAll<Element>(By.Name(name), timeoutMS, global);
        }

        /// <summary>
        /// Scrolls the page
        /// </summary>
        /// <param name="scrollCount">The number of scroll attempts.</param>
        /// <param name="direction">The direction to scroll.</param>
        /// <param name="msPreAction">Pre-action delay in milliseconds.</param>
        /// <param name="msPostAction">Post-action delay in milliseconds.</param>
        public void Scroll(int scrollCount = 5, string direction = "Up", int msPreAction = 500, int msPostAction = 500)
        {
            MouseActionType mouseAction = direction == "Up" ? MouseActionType.ScrollUp : MouseActionType.ScrollDown;
            for (int i = 0; i < scrollCount; i++)
            {
                Session.PerformMouseAction(mouseAction, msPreAction, msPostAction); // Ensure settings are visible
            }
        }

        /// <summary>
        /// Captures the last screenshot when the test fails.
        /// </summary>
        protected void CaptureLastScreenshot()
        {
            // Implement your screenshot capture logic here
            // For example, save a screenshot to a file and return the file path
            string screenshotPath = Path.Combine(this.TestContext.TestResultsDirectory ?? string.Empty, "last_screenshot.png");

            this.Session.Root.GetScreenshot().SaveAsFile(screenshotPath, ScreenshotImageFormat.Png);

            // Save screenshot to screenshotPath & upload to test attachment
            this.TestContext.AddResultFile(screenshotPath);
        }

        /// <summary>
        /// Retrieves the color of the pixel at the specified screen coordinates.
        /// </summary>
        /// <param name="x">The X coordinate on the screen.</param>
        /// <param name="y">The Y coordinate on the screen.</param>
        /// <returns>The color of the pixel at the specified coordinates.</returns>
        public Color GetPixelColor(int x, int y)
        {
            return WindowHelper.GetPixelColor(x, y);
        }

        /// <summary>
        /// Retrieves the color of the pixel at the specified screen coordinates as a string.
        /// </summary>
        /// <param name="x">The X coordinate on the screen.</param>
        /// <param name="y">The Y coordinate on the screen.</param>
        /// <returns>The color of the pixel at the specified coordinates.</returns>
        public string GetPixelColorString(int x, int y)
        {
            return WindowHelper.GetPixelColorString(x, y);
        }

        /// <summary>
        /// Gets the size of the display.
        /// </summary>
        /// <returns>
        /// A tuple containing the width and height of the display.
        /// </returns
        public Tuple<int, int> GetDisplaySize()
        {
            return WindowHelper.GetDisplaySize();
        }

        /// <summary>
        /// Sends a combination of keys.
        /// </summary>
        /// <param name="keys">The keys to send.</param>
        public void SendKeys(params Key[] keys)
        {
            this.Session.SendKeys(keys);
        }

        /// <summary>
        /// Sends a sequence of keys.
        /// </summary>
        /// <param name="keys">An array of keys to send.</param>
        public void SendKeySequence(params Key[] keys)
        {
            this.Session.SendKeySequence(keys);
        }

        /// <summary>
        /// Gets the current position of the mouse cursor as a tuple.
        /// </summary>
        /// <returns>A tuple containing the X and Y coordinates of the cursor.</returns>
        public Tuple<int, int> GetMousePosition()
        {
            return this.Session.GetMousePosition();
        }

        /// <summary>
        /// Gets the screen center coordinates.
        /// </summary>
        /// <returns>(x, y)</returns>
        public (int CenterX, int CenterY) GetScreenCenter()
        {
            return WindowHelper.GetScreenCenter();
        }

        public bool IsWindowOpen(string windowName)
        {
            return WindowHelper.IsWindowOpen(windowName);
        }

        /// <summary>
        /// Moves the mouse cursor to the specified screen coordinates.
        /// </summary>
        /// <param name="x">The new x-coordinate of the cursor.</param>
        /// <param name="y">The new y-coordinate of the cursor.</param
        public void MoveMouseTo(int x, int y)
        {
            this.Session.MoveMouseTo(x, y);
        }

        protected void AddScreenShotsToTestResultsDirectory()
        {
            if (screenshotDirectory != null)
            {
                foreach (string file in Directory.GetFiles(screenshotDirectory))
                {
                    this.TestContext.AddResultFile(file);
                }
            }
        }

        /// <summary>
        /// Restart scope exe.
        /// </summary>
        public void RestartScopeExe()
        {
            this.sessionHelper!.RestartScopeExe();
            this.Session = new Session(this.sessionHelper.GetRoot(), this.sessionHelper.GetDriver(), this.scope, this.size);
            return;
        }

        /// <summary>
        /// Restart scope exe.
        /// </summary>
        public void ExitScopeExe()
        {
            this.sessionHelper!.ExitScopeExe();
            return;
        }

        private void CloseOtherApplications()
        {
            // Close other applications
            var processNamesToClose = new List<string>
            {
                "PowerToys",
                "PowerToys.Settings",
                "PowerToys.FancyZonesEditor",
            };
            foreach (var processName in processNamesToClose)
            {
                foreach (var process in Process.GetProcessesByName(processName))
                {
                    process.Kill();
                    process.WaitForExit();
                }
            }
        }

        public class NativeMethods
        {
            [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
            public struct DISPLAY_DEVICE
            {
                public int cb;
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
                public string DeviceName;
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
                public string DeviceString;
                public int StateFlags;
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
                public string DeviceID;
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
                public string DeviceKey;
            }

            [DllImport("user32.dll")]
            private static extern int EnumDisplaySettings(IntPtr deviceName, int modeNum, ref DEVMODE devMode);

            [DllImport("user32.dll")]
            private static extern int EnumDisplaySettings(string deviceName, int modeNum, ref DEVMODE devMode);

            [DllImport("user32.dll", CharSet = CharSet.Ansi)]
            private static extern bool EnumDisplayDevices(IntPtr lpDevice, int iDevNum, ref DISPLAY_DEVICE lpDisplayDevice, int dwFlags);

            [DllImport("user32.dll")]
            private static extern int ChangeDisplaySettings(ref DEVMODE devMode, int flags);

            [DllImport("user32.dll", CharSet = CharSet.Ansi)]
            private static extern int ChangeDisplaySettingsEx(IntPtr lpszDeviceName, ref DEVMODE lpDevMode, IntPtr hwnd, uint dwflags, IntPtr lParam);

            private const int DM_PELSWIDTH = 0x80000;
            private const int DM_PELSHEIGHT = 0x100000;

            public const int ENUM_CURRENT_SETTINGS = -1;
            public const int CDS_TEST = 0x00000002;
            public const int CDS_UPDATEREGISTRY = 0x01;
            public const int DISP_CHANGE_SUCCESSFUL = 0;
            public const int DISP_CHANGE_RESTART = 1;
            public const int DISP_CHANGE_FAILED = -1;

            [StructLayout(LayoutKind.Sequential)]
            public struct DEVMODE
            {
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
                public string DmDeviceName;
                public short DmSpecVersion;
                public short DmDriverVersion;
                public short DmSize;
                public short DmDriverExtra;
                public int DmFields;
                public int DmPositionX;
                public int DmPositionY;
                public int DmDisplayOrientation;
                public int DmDisplayFixedOutput;
                public short DmColor;
                public short DmDuplex;
                public short DmYResolution;
                public short DmTTOption;
                public short DmCollate;
                [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
                public string DmFormName;
                public short DmLogPixels;
                public int DmBitsPerPel;
                public int DmPelsWidth;
                public int DmPelsHeight;
                public int DmDisplayFlags;
                public int DmDisplayFrequency;
                public int DmICMMethod;
                public int DmICMIntent;
                public int DmMediaType;
                public int DmDitherType;
                public int DmReserved1;
                public int DmReserved2;
                public int DmPanningWidth;
                public int DmPanningHeight;
            }

            public static void GetMonitorInfo()
            {
                int deviceIndex = 0;
                DISPLAY_DEVICE d = default(DISPLAY_DEVICE);
                d.cb = Marshal.SizeOf(d);

                Console.WriteLine("monitor list :");
                while (EnumDisplayDevices(IntPtr.Zero, deviceIndex, ref d, 0))
                {
                    Console.WriteLine($"monitor {deviceIndex + 1}:");
                    Console.WriteLine($"  name: {d.DeviceName}");
                    Console.WriteLine($"  string: {d.DeviceString}");
                    Console.WriteLine($"  ID: {d.DeviceID}");
                    Console.WriteLine($"  key: {d.DeviceKey}");
                    Console.WriteLine();

                    DEVMODE dm = default(DEVMODE);
                    dm.DmSize = (short)Marshal.SizeOf<DEVMODE>();
                    int modeNum = 0;
                    while (EnumDisplaySettings(d.DeviceName, modeNum, ref dm) > 0)
                    {
                        MonitorInfoData.Monitors.Add(new MonitorInfoData.MonitorInfoDataWrapper()
                        {
                            DeviceName = d.DeviceName,
                            DeviceString = d.DeviceString,
                            DeviceID = d.DeviceID,
                            DeviceKey = d.DeviceKey,
                            PelsWidth = dm.DmPelsWidth,
                            PelsHeight = dm.DmPelsHeight,
                            DisplayFrequency = dm.DmDisplayFrequency,
                        });
                        Console.WriteLine($"  mode {modeNum}: {dm.DmPelsWidth}x{dm.DmPelsHeight} @ {dm.DmDisplayFrequency}Hz");
                        modeNum++;
                    }

                    deviceIndex++;
                    d.cb = Marshal.SizeOf(d); // Reset the size for the next device
                }
            }

            public static void ChangeDisplayResolution(int PelsWidth, int PelsHeight)
            {
                Screen screen = Screen.PrimaryScreen!;
                if (screen.Bounds.Width == PelsWidth && screen.Bounds.Height == PelsHeight)
                {
                    return;
                }

                DEVMODE devMode = default(DEVMODE);
                devMode.DmDeviceName = new string(new char[32]);
                devMode.DmFormName = new string(new char[32]);
                devMode.DmSize = (short)Marshal.SizeOf<DEVMODE>();

                int modeNum = 0;
                while (EnumDisplaySettings(IntPtr.Zero, modeNum, ref devMode) > 0)
                {
                    Console.WriteLine($"Mode {modeNum}: {devMode.DmPelsWidth}x{devMode.DmPelsHeight} @ {devMode.DmDisplayFrequency}Hz");
                    modeNum++;
                }

                devMode.DmPelsWidth = PelsWidth;
                devMode.DmPelsHeight = PelsHeight;

                int result = NativeMethods.ChangeDisplaySettings(ref devMode, NativeMethods.CDS_TEST);

                if (result == DISP_CHANGE_SUCCESSFUL)
                {
                    result = ChangeDisplaySettings(ref devMode, CDS_UPDATEREGISTRY);
                    if (result == DISP_CHANGE_SUCCESSFUL)
                    {
                        Console.WriteLine($"Changing display resolution to {devMode.DmPelsWidth}x{devMode.DmPelsHeight}");
                    }
                    else
                    {
                        Console.WriteLine($"Failed to change display resolution. Error code: {result}");
                    }
                }
                else if (result == DISP_CHANGE_RESTART)
                {
                    Console.WriteLine($"Changing display resolution to {devMode.DmPelsWidth}x{devMode.DmPelsHeight} requires a restart");
                }
                else
                {
                    Console.WriteLine($"Failed to change display resolution. Error code: {result}");
                }
            }
        }
    }
}