Add support to run appium-windows-driver for Windows apps

MADE-Apps · Mar 15, 2024 · 25e734a · 25e734a
1 parent f32288e
commit 25e734a
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/src/Legerity.Core/Android/AndroidAppManagerOptions.cs b/src/Legerity.Core/Android/AndroidAppManagerOptions.cs
@@ -149,11 +149,6 @@ public AndroidAppManagerOptions(
     /// </summary>
     public string DeviceId { get; set; }
 
-    /// <summary>
-    /// Gets or sets a value indicating whether to launch the Appium server instance.
-    /// </summary>
-    public bool LaunchAppiumServer { get; set; }
-
     /// <summary>
     /// Configures the <see cref="AppiumManagerOptions.AppiumOptions"/> with the specified additional options.
     /// </summary>

diff --git a/src/Legerity.Core/AppManager.cs b/src/Legerity.Core/AppManager.cs
@@ -223,9 +223,9 @@ private static WebDriver StartAndroidApp(AndroidAppManagerOptions androidOpts)
 
     private static WebDriver StartWindowsApp(WindowsAppManagerOptions winOpts)
     {
-        if (winOpts.LaunchWinAppDriver)
+        if (winOpts.LaunchAppiumServer || winOpts.LaunchWinAppDriver)
         {
-            WinAppDriverHelper.Run();
+            AppiumServerHelper.Run();
         }
 
         var app = new WindowsDriver(

diff --git a/src/Legerity.Core/AppiumManagerOptions.cs b/src/Legerity.Core/AppiumManagerOptions.cs
@@ -23,6 +23,11 @@ public AppiumOptions AppiumOptions
         set => DriverOptions = value;
     }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether to launch the Appium server instance.
+    /// </summary>
+    public bool LaunchAppiumServer { get; set; }
+
     /// <summary>
     /// Configures the <see cref="AppiumOptions"/> with the specified additional options.
     /// </summary>

diff --git a/src/Legerity.Core/IOS/IOSAppManagerOptions.cs b/src/Legerity.Core/IOS/IOSAppManagerOptions.cs
@@ -94,11 +94,6 @@ public IOSAppManagerOptions(
     /// </summary>
     public string AutomationName { get; set; } = "XCUITest";
 
-    /// <summary>
-    /// Gets or sets a value indicating whether to launch the Appium server instance.
-    /// </summary>
-    public bool LaunchAppiumServer { get; set; }
-
     /// <summary>
     /// Configures the <see cref="AppiumManagerOptions.AppiumOptions"/> with the specified additional options.
     /// </summary>

diff --git a/src/Legerity.Core/Windows/Helpers/WinAppDriverHelper.cs b/src/Legerity.Core/Windows/Helpers/WinAppDriverHelper.cs
@@ -9,6 +9,7 @@ namespace Legerity.Windows.Helpers;
 /// <summary>
 /// Defines a helper class for the WinAppDriver.
 /// </summary>
+[Obsolete("WinAppDriver is not well maintained and is not supported directly by Appium 5 due to W3C standards. Instead, install the appium-windows-driver for the Appium CLI, and use the AppiumServerHelper to initialize.")]
 public static class WinAppDriverHelper
 {
     /// <summary>

diff --git a/src/Legerity.Core/Windows/WindowsAppManagerOptions.cs b/src/Legerity.Core/Windows/WindowsAppManagerOptions.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace Legerity.Windows;
 
 using System.Collections.Generic;
@@ -49,6 +51,7 @@ public WindowsAppManagerOptions(string appId, params (string, object)[] addition
     /// <summary>
     /// Gets or sets a value indicating whether to launch the WinAppDriver if it is not already running.
     /// </summary>
+    [Obsolete("Please use LaunchAppiumServer instead. LaunchWinAppDriver will continue to function, however, the WinAppDriver will not be launched directly due to no direct support by the W3C standard implemented in Appium 5. This property will be removed in a future release.")]
     public bool LaunchWinAppDriver { get; set; }
 
     /// <summary>
@@ -70,7 +73,8 @@ public WindowsAppManagerOptions(string appId, params (string, object)[] addition
     public override void Configure()
     {
         base.Configure();
-        AppiumOptions.AddAdditionalAppiumOption("app", AppId);
+        AppiumOptions.App = AppId;
+        AppiumOptions.AutomationName = "Windows";
     }
 
     /// <summary>