Update package versions (Appium 5.0.0-beta03, Selenium 4.7.0), Rework TouchActions (#34)

mialeska · web-flow · commit 9613b1ac0ac5 · 2023-01-19T00:54:56.000+01:00
* Update package versions
* Rework TouchActions to remove obsolete class reference
* Update license year
* Update the pipeline (appium version) and websession config
* Stabilize dump test and add dumps to pipeline's artifacts
* Run emulator with args -gpu swiftshader_indirect -noaudio -no-boot-anim
diff --git a/Aquality.Appium.Mobile/Aquality.Appium.Mobile.sln b/Aquality.Appium.Mobile/Aquality.Appium.Mobile.sln
@@ -1,15 +1,15 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.29613.14
+# Visual Studio Version 17
+VisualStudioVersion = 17.2.32616.157
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{C20555E4-7B6C-47E0-AB89-ADA80F4B1106}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aquality.Appium.Mobile", "src\Aquality.Appium.Mobile\Aquality.Appium.Mobile.csproj", "{6FB08B9A-2D6E-4465-B939-97547B3E3ADE}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aquality.Appium.Mobile", "src\Aquality.Appium.Mobile\Aquality.Appium.Mobile.csproj", "{6FB08B9A-2D6E-4465-B939-97547B3E3ADE}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{B0327F3B-D308-4443-8268-39DF01EF087C}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aquality.Appium.Mobile.Tests", "tests\Aquality.Appium.Mobile.Tests\Aquality.Appium.Mobile.Tests.csproj", "{84F82BC0-6EFA-4373-BCCD-00583DC3321B}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aquality.Appium.Mobile.Tests", "tests\Aquality.Appium.Mobile.Tests\Aquality.Appium.Mobile.Tests.csproj", "{84F82BC0-6EFA-4373-BCCD-00583DC3321B}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Actions/TouchActions.cs b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Actions/TouchActions.cs
@@ -1,15 +1,22 @@
 ﻿using Aquality.Appium.Mobile.Applications;
 using Aquality.Appium.Mobile.Configurations;
 using Aquality.Selenium.Core.Utilities;
-using OpenQA.Selenium.Appium.Interfaces;
-using OpenQA.Selenium.Appium.MultiTouch;
+using OpenQA.Selenium.Interactions;
 using System;
+using System.Collections.Generic;
 using System.Drawing;
 
 namespace Aquality.Appium.Mobile.Actions
 {
     public class TouchActions : ITouchActions
     {
+        private TimeSpan SwipeDuration => AqualityServices.Get<ITouchActionsSettings>().SwipeDuration;
+
+        private ActionSequence PressSequence(PointerInputDevice finger, Point startPoint) => new ActionSequence(finger, initialSize: 0)
+            .AddAction(finger.CreatePointerMove(CoordinateOrigin.Viewport, startPoint.X, startPoint.Y, TimeSpan.Zero))
+            .AddAction(finger.CreatePointerDown(MouseButton.Left));
+            
+
         public void Swipe(Point startPoint, Point endPoint)
         {
             AqualityServices.LocalizedLogger.Info(
@@ -18,11 +25,7 @@ public void Swipe(Point startPoint, Point endPoint)
                 startPoint.Y,
                 endPoint.X,
                 endPoint.Y);
-            PerformTouchAction(
-                touchAction => touchAction
-                    .Press(startPoint.X, startPoint.Y)
-                    .Wait(GetLongSwipeDuration()),
-                endPoint);
+            PerformTouchAction(finger => PressSequence(finger, startPoint), endPoint);
         }
 
         public void SwipeWithLongPress(Point startPoint, Point endPoint)
@@ -33,21 +36,19 @@ public void SwipeWithLongPress(Point startPoint, Point endPoint)
                startPoint.Y,
                endPoint.X,
                endPoint.Y);
-            PerformTouchAction(touchAction => touchAction.LongPress(startPoint.X, startPoint.Y), endPoint);
+            PerformTouchAction(finger => PressSequence(finger, startPoint).AddAction(finger.CreatePointerMove(CoordinateOrigin.Viewport, startPoint.X, startPoint.Y, SwipeDuration)), endPoint);
         }
 
-        protected void PerformTouchAction(Func<ITouchAction, ITouchAction> function, Point endPoint)
+        protected void PerformTouchAction(Func<PointerInputDevice, ActionSequence> getActionSequence, Point endPoint)
         {
             var actionRetrier = AqualityServices.Get<IElementActionRetrier>();
-            var touchAction = new TouchAction(AqualityServices.Application.Driver);
-            actionRetrier.DoWithRetry(() =>
-                function(touchAction).MoveTo(endPoint.X, endPoint.Y).Release().Perform());
-        }
+            var finger = new PointerInputDevice(PointerKind.Touch, "finger");
+            var actionSequence = getActionSequence(finger)
+                .AddAction(finger.CreatePointerMove(CoordinateOrigin.Viewport, endPoint.X, endPoint.Y, SwipeDuration))
+                .AddAction(finger.CreatePointerUp(MouseButton.Left));
 
-        private long GetLongSwipeDuration()
-        {
-            var swipeDuration = AqualityServices.Get<ITouchActionsSettings>().SwipeDuration;
-            return Convert.ToInt64(swipeDuration.TotalMilliseconds);
+            actionRetrier.DoWithRetry(() =>
+                AqualityServices.Application.Driver.PerformActions(new List<ActionSequence> { actionSequence }));
         }
     }
 }
diff --git a/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.csproj b/Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Aquality.Appium.Mobile.csproj
@@ -14,7 +14,7 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>appium mobile ios android automation</PackageTags>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
-    <Copyright>Copyright 2022 Aquality Automation</Copyright>
+    <Copyright>Copyright 2023 Aquality Automation</Copyright>
     <IsPackable>true</IsPackable>
   </PropertyGroup>
     
@@ -49,8 +49,8 @@
   </ItemGroup>
   
   <ItemGroup>
-    <PackageReference Include="Appium.WebDriver" Version="5.0.0-beta01" />
-    <PackageReference Include="Aquality.Selenium.Core" Version="2.0.2" />
+    <PackageReference Include="Appium.WebDriver" Version="5.0.0-beta03" />
+    <PackageReference Include="Aquality.Selenium.Core" Version="2.1.0" />
   </ItemGroup>
 
 </Project>
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Aquality.Appium.Mobile.Tests.csproj b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Aquality.Appium.Mobile.Tests.csproj
@@ -8,12 +8,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="nunit" Version="3.13.2" />
-    <PackageReference Include="NUnit3TestAdapter" Version="4.2.1">
+    <PackageReference Include="nunit" Version="3.13.3" />
+    <PackageReference Include="NUnit3TestAdapter" Version="4.3.1">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="runtime.osx.10.10-x64.CoreCompat.System.Drawing" Version="6.0.5.128" />
   </ItemGroup>
   
@@ -37,6 +37,19 @@
     <None Update="Resources\settings.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="Resources\VisualDumps\Invoke Search\ScreenElement.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="Resources\VisualDumps\Invoke Search\searchTextBox.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="Resources\VisualDumps\Invoke Search\startSearchButton.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
+	<ItemGroup>
+		<Folder Include="Resources\VisualDumps\Invoke Search\" />
+	</ItemGroup>
+
 
 </Project>
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/ScreenElement.png b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/ScreenElement.png
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/searchTextBox.png b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/searchTextBox.png
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/startSearchButton.png b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/VisualDumps/Invoke Search/startSearchButton.png
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.androidwebsession.json b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.androidwebsession.json
@@ -10,6 +10,9 @@
         "browserName": "Chrome",
         "platformName": "Android",
         "automationName": "UIAutomator2",
+        "chromeOptions": {
+          "w3c": false
+        },
         "uiautomator2ServerInstallTimeout": 30000,
         "eventTimings": true
       }
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.json b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Resources/settings.json
@@ -60,6 +60,6 @@
     "defaultThreshold": 0.012,
     "comparisonWidth": 16,
     "comparisonHeight": 16,
-    "pathToDumps": "../../../Resources/VisualDumps/"
+    "pathToDumps": "./Resources/VisualDumps/"
   }
 }
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/AndroidBasicInteractionsTest.cs b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/AndroidBasicInteractionsTest.cs
@@ -2,6 +2,7 @@
 using Aquality.Appium.Mobile.Elements.Interfaces;
 using Aquality.Appium.Mobile.Tests.Samples.Android.NativeApp.ApiDemos.Screens;
 using NUnit.Framework;
+using System.Linq;
 
 namespace Aquality.Appium.Mobile.Tests.Samples.Android.NativeApp
 {
@@ -30,12 +31,12 @@ public void SaveAndCompareScreenDump()
             var searchScreen = new InvokeSearchScreen();
             searchScreen.Open();
             Assume.That(searchScreen.State.IsDisplayed, $"{searchScreen.Name} should be opened from the menu");
-
-            searchScreen.Dump.Save();
-            Assert.That(searchScreen.Dump.Compare(), Is.EqualTo(0), "Current screen should have no visual difference comparing to just saved dump");
+            var customDumpName = $"my dump of {searchScreen.Name}";
+            searchScreen.Dump.Save(customDumpName);
+            Assert.That(searchScreen.Dump.Compare(customDumpName), Is.EqualTo(0), "Current screen should have no visual difference comparing to just saved dump");
             const string query = "Hello world!";
             searchScreen.TypeQuery(query);
-            Assert.That(searchScreen.Dump.Compare(), Is.GreaterThan(0), "Current screen should have visual difference comparing to dump saved before the search");
+            Assert.That(searchScreen.Dump.Compare(), Is.GreaterThan(0), "Current screen after the search should have visual difference comparing to dump saved");
         }
 
         [Test]
diff --git a/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/ApiDemos/Screens/AndroidScreen.cs b/Aquality.Appium.Mobile/tests/Aquality.Appium.Mobile.Tests/Samples/Android/NativeApp/ApiDemos/Screens/AndroidScreen.cs
@@ -22,6 +22,7 @@ protected static void StartActivity(string appPackage, string appActivity, bool
             AqualityServices.LocalizedLogger.Info("loc.application.android.activity.start", appPackage, appActivity);
             var androidDriver = (AndroidDriver) AqualityServices.Application.Driver;
             androidDriver.StartActivity(appPackage, appActivity, stopApp: stopApp);
+            AqualityServices.ConditionalWait.WaitFor(driver => ((AndroidDriver) driver).CurrentActivity == appActivity, message: $"Activity {appActivity} was not started");
         }
     }
 }
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Aquality Automation
+   Copyright 2023 Aquality Automation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/README.md b/README.md
@@ -27,12 +27,18 @@ We use interfaces where is possible, so you can implement your own version of ta
 If the parameter `isRemote` in your settings.json is set to `false`, this means that AppiumDriverLocalService would be used to setup Appium server using Node.js. This option requires specific version of node.js to be preinstalled on your machine (Please read more [here](http://appium.io/docs/en/contributing-to-appium/appium-from-source/#nodejs) )
 
 > Note:
-After migration to Appium v.5, we need to make some changes in the way we set up the server:
-> - As soon as we continue to use "remoteConnectionUrl": "http://127.0.0.1:4723/wd/hub" in our [settings.json](./src/main/resources/settings.json), we need to specify the `--base-path` when starting Appium server:
+After migration to Appium v.5, we started using Appium server v.2 in our [azure-pipelines](azure-pipelines.yml). 
+> It has some breaking changes, described [here](https://appium.github.io/appium/docs/en/2.0/guides/migrating-1-to-2/).
+> In particular:
+> 1. Please install required driver manually:
+> ```yaml
+> npm install -g appium@next
+> appium driver install uiautomator2
+> 2. As soon as we continue to use "remoteConnectionUrl": "http://127.0.0.1:4723/wd/hub" in our [settings.json](Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Resources/settings.json), we need to specify the `--base-path` when starting Appium server:
 > ```yaml
 > appium --allow-insecure chromedriver_autodownload --base-path /wd/hub &
 > ```
->
+> 3. We also recommend disabling element caching and w3c in chromeOptions when you run Android Chrome session. Take a look at example here: [settings.androidwebsession.json](Aquality.Appium.Mobile/src/Aquality.Appium.Mobile/Resources/settings.androidwebsession.json).
 
 4. (optional) Launch an application directly by calling `var application = AqualityServices.Application;`. 
 > Note: 
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -81,14 +81,14 @@ stages:
           $ANDROID_HOME/emulator/emulator -list-avds
 
           echo "Starting emulator"
-          nohup $ANDROID_HOME/emulator/emulator -avd "$(ANDROID_EMU_NAME)" -no-snapshot > /dev/null 2>&1 &
+          nohup $ANDROID_HOME/emulator/emulator -avd "$(ANDROID_EMU_NAME)" -gpu swiftshader_indirect -noaudio -no-boot-anim -no-snapshot > /dev/null 2>&1 &
           $ANDROID_HOME/platform-tools/adb wait-for-device
           while [[ $? -ne 0 ]]; do sleep 1; $ANDROID_HOME/platform-tools/adb shell pm list packages; done;
           $ANDROID_HOME/platform-tools/adb devices
           echo "Emulator started"
 
           echo "Installing Appium"
-          npm install -g appium
+          npm install -g appium@next
           ln -fs /usr/local/lib/node_modules/appium/build/lib/main.js /usr/local/bin/appium
           chmod +x /usr/local/bin/appium
           export PATH=$PATH:/usr/local/bin/appium
@@ -137,6 +137,7 @@ stages:
         SourceFolder: '$(Build.SourcesDirectory)'
         Contents: |
             **/*Tests*/Screenshots/*.png
+            **/*Tests*/**/Resources/VisualDumps/*.png
             **/*Tests*/Log/*.log
         TargetFolder: '$(Build.ArtifactStagingDirectory)'
       condition: succeededOrFailed()

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,6 @@`
`60`	`60`	`"defaultThreshold": 0.012,`
`61`	`61`	`"comparisonWidth": 16,`
`62`	`62`	`"comparisonHeight": 16,`
`63`		`- "pathToDumps": "../../../Resources/VisualDumps/"`
	`63`	`+ "pathToDumps": "./Resources/VisualDumps/"`
`64`	`64`	`}`
`65`	`65`	`}`