Update Appium dependency to v5 (#18)

jfversluis · web-flow · commit 03a13bbebad2 · 2024-07-03T13:11:47.000+02:00
* Update Appium dependency to v5

* Update Plugin.Maui.UITestHelpers.Appium.csproj

* Update AppiumLifecycleActions.cs

* Update AppiumLifecycleActions.cs
diff --git a/samples/UITests.Android/UITests.Android.csproj b/samples/UITests.Android/UITests.Android.csproj
@@ -13,7 +13,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Appium.WebDriver" Version="5.0.0-rc.7" />
+		<PackageReference Include="Appium.WebDriver" Version="5.0.0" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NUnit" Version="4.1.0" />
 		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
diff --git a/samples/UITests.Windows/UITests.Windows.csproj b/samples/UITests.Windows/UITests.Windows.csproj
@@ -13,7 +13,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Appium.WebDriver" Version="5.0.0-rc.7" />
+		<PackageReference Include="Appium.WebDriver" Version="5.0.0" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NUnit" Version="4.1.0" />
 		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
diff --git a/samples/UITests.iOS/UITests.iOS.csproj b/samples/UITests.iOS/UITests.iOS.csproj
@@ -13,7 +13,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Appium.WebDriver" Version="5.0.0-rc.7" />
+		<PackageReference Include="Appium.WebDriver" Version="5.0.0" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NUnit" Version="4.1.0" />
 		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
diff --git a/samples/UITests.macOS/UITests.macOS.csproj b/samples/UITests.macOS/UITests.macOS.csproj
@@ -13,7 +13,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Appium.WebDriver" Version="5.0.0-rc.7" />
+		<PackageReference Include="Appium.WebDriver" Version="5.0.0" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NUnit" Version="4.1.0" />
 		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
diff --git a/src/Plugin.Maui.UITestHelpers.Appium/Actions/AppiumLifecycleActions.cs b/src/Plugin.Maui.UITestHelpers.Appium/Actions/AppiumLifecycleActions.cs
@@ -1,4 +1,5 @@
 ﻿using OpenQA.Selenium.Appium.Android;
+using OpenQA.Selenium.Appium.Windows;
 using Plugin.Maui.UITestHelpers.Core;
 
 namespace Plugin.Maui.UITestHelpers.Appium
@@ -60,11 +61,13 @@ CommandResponse LaunchApp(IDictionary<string, object> parameters)
 					{ "bundleId", _app.GetAppId() },
 				});
 			}
-			else if (_app.GetTestDevice() == TestDevice.Windows)
+			else if (_app.Driver is WindowsDriver windowsDriver)
 			{
-#pragma warning disable CS0618 // Type or member is obsolete
-				_app.Driver.LaunchApp();
-#pragma warning restore CS0618 // Type or member is obsolete
+				// Appium driver removed the LaunchApp method in 5.0.0, so we need to use the executeScript method instead
+				// Currently the appium-windows-driver reports the following commands as compatible:
+				//   startRecordingScreen,stopRecordingScreen,launchApp,closeApp,deleteFile,deleteFolder,
+				//   click,scroll,clickAndDrag,hover,keys,setClipboard,getClipboard
+				windowsDriver.ExecuteScript("windows: launchApp", [_app.GetAppId()]);
 			}
 			else
 			{
@@ -122,11 +125,12 @@ CommandResponse CloseApp(IDictionary<string, object> parameters)
 					{ "bundleId", _app.GetAppId() },
 				});
 			}
-			else if (_app.GetTestDevice() == TestDevice.Windows)
+			else if (_app.Driver is WindowsDriver windowsDriver)
 			{
-#pragma warning disable CS0618 // Type or member is obsolete
-				_app.Driver.CloseApp();
-#pragma warning restore CS0618 // Type or member is obsolete
+				// This is still here for now, but it looks like it will get removed just like
+				// LaunchApp was in 5.0.0, in which case we may need to use:
+				// windowsDriver.ExecuteScript("windows: closeApp", [_app.GetAppId()]);
+				windowsDriver.CloseApp();
 			}
 			else
 				_app.Driver.TerminateApp(_app.GetAppId());
diff --git a/src/Plugin.Maui.UITestHelpers.Appium/Plugin.Maui.UITestHelpers.Appium.csproj b/src/Plugin.Maui.UITestHelpers.Appium/Plugin.Maui.UITestHelpers.Appium.csproj
@@ -27,8 +27,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Appium.WebDriver" Version="5.0.0-rc.7" />
-    <PackageReference Include="System.Drawing.Common" Version="8.0.3" />
+    <PackageReference Include="Appium.WebDriver" Version="5.0.0" />
+    <PackageReference Include="System.Drawing.Common" Version="8.0.6" />
   </ItemGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using OpenQA.Selenium.Appium.Android;`
	`2`	`+using OpenQA.Selenium.Appium.Windows;`
`2`	`3`	`using Plugin.Maui.UITestHelpers.Core;`
`3`	`4`
`4`	`5`	`namespace Plugin.Maui.UITestHelpers.Appium`
`@@ -60,11 +61,13 @@ CommandResponse LaunchApp(IDictionary<string, object> parameters)`
`60`	`61`	`{ "bundleId", _app.GetAppId() },`
`61`	`62`	`});`
`62`	`63`	`}`
`63`		`- else if (_app.GetTestDevice() == TestDevice.Windows)`
	`64`	`+ else if (_app.Driver is WindowsDriver windowsDriver)`
`64`	`65`	`{`
`65`		`-#pragma warning disable CS0618 // Type or member is obsolete`
`66`		`- _app.Driver.LaunchApp();`
`67`		`-#pragma warning restore CS0618 // Type or member is obsolete`
	`66`	`+ // Appium driver removed the LaunchApp method in 5.0.0, so we need to use the executeScript method instead`
	`67`	`+ // Currently the appium-windows-driver reports the following commands as compatible:`
	`68`	`+ // startRecordingScreen,stopRecordingScreen,launchApp,closeApp,deleteFile,deleteFolder,`
	`69`	`+ // click,scroll,clickAndDrag,hover,keys,setClipboard,getClipboard`
	`70`	`+ windowsDriver.ExecuteScript("windows: launchApp", [_app.GetAppId()]);`
`68`	`71`	`}`
`69`	`72`	`else`
`70`	`73`	`{`
`@@ -122,11 +125,12 @@ CommandResponse CloseApp(IDictionary<string, object> parameters)`
`122`	`125`	`{ "bundleId", _app.GetAppId() },`
`123`	`126`	`});`
`124`	`127`	`}`
`125`		`- else if (_app.GetTestDevice() == TestDevice.Windows)`
	`128`	`+ else if (_app.Driver is WindowsDriver windowsDriver)`
`126`	`129`	`{`
`127`		`-#pragma warning disable CS0618 // Type or member is obsolete`
`128`		`- _app.Driver.CloseApp();`
`129`		`-#pragma warning restore CS0618 // Type or member is obsolete`
	`130`	`+ // This is still here for now, but it looks like it will get removed just like`
	`131`	`+ // LaunchApp was in 5.0.0, in which case we may need to use:`
	`132`	`+ // windowsDriver.ExecuteScript("windows: closeApp", [_app.GetAppId()]);`
	`133`	`+ windowsDriver.CloseApp();`
`130`	`134`	`}`
`131`	`135`	`else`
`132`	`136`	`_app.Driver.TerminateApp(_app.GetAppId());`