[Selenium 4] [Appium 8] [Appium Server 2] Migration to Appium 8.0.0-beta2 (#27)

* [Selenium 4] [Appium 8] [Appium Server 2] Migration to Appium 8.0.0-beta2
- make AppiumDriver non-generic
- replace deprecated MobileBy references to AppiumBy and By
- get rid of MobileElement
- fix ClientFactory at ApplicationFactory

* Reworked TouchActions and ElementTouchActions

* Add method getCenter() to Element with logging

* Add ability to specify ChromeOptions and other options in settings.json

* Update pipeline, migrate to appium@next

* Disable element caching and w3c for android web session in unit tests

* Update LICENSE and README.md, add migration notes

* Rename log4j.properties to log4j2.properties

Author: mialeska

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 Aquality Automation
+   Copyright 2022 Aquality Automation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -22,7 +22,7 @@ We use interfaces where is possible, so you can implement your own version of ta
 <dependency>
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-appium-mobile</artifactId>
-    <version>${LATEST_VERSION}</version>
+    <version>3.0.0-beta</version>
 </dependency>
 ```
 
@@ -31,15 +31,32 @@ We use interfaces where is possible, so you can implement your own version of ta
  - Open settings.json and find `applicationPath` option under the `driverSettings` section of desired platform. Replace the value with full or relative path to your app, e.g. `./src/test/resources/apps/ApiDemos-debug.apk`.
 
 3. Ensure that [Appium server](https://appium.io) is set up at your machine where the code would be executed, and the address/port match to set in your `settings.json` in `remoteConnectionUrl` parameter.
-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) )
+If the parameter `isRemote` in your settings.json is set to `false`, this means that AppiumDriverLocalService would be used to set up 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.8, we started using Appium server v.2 in our [azure-pipelines](azure-pipelines.yml). 
+> It has some breaking changes, described [here](https://github.com/appium/java-client/blob/master/docs/v7-to-v8-migration-guide.md).
+> 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](./src/main/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](./src/test/resources/settings.androidwebsession.json).
+
 
 4. (optional) Launch an application directly by calling `AqualityServices.getApplication();`. 
 
 > Note: 
 If you don't start an Application directly, it would be started with the first call of any Aquality service or class requiring interacting with the Application.
 
-5. That's it! Now you are able work with Application via AqualityServices or via element services.
-Please take a look at our example tests [here](./src/test/java/samples/)
+5. That's it! Now you are able to work with Application via AqualityServices or via element services.
+Please take a look at our example tests [here](./src/test/java/samples/.).
 
 6. To interact with Application's forms and elements, we recommend following the Page/Screen Objects pattern. This approach is fully integrated into our package.
 To start with that, you will need to create a separate class for each window/form of your application, and inherit this class from the [Screen](./src/main/java/aquality/appium/mobile/screens/Screen.java). 
@@ -141,7 +158,7 @@ import aquality.appium.mobile.application.PlatformName;
 import aquality.appium.mobile.screens.screenfactory.ScreenType;
 import org.openqa.selenium.By;
 
-import static io.appium.java_client.MobileBy.AccessibilityId;
+import static io.appium.java_client.AppiumBy.AccessibilityId;
 import static org.openqa.selenium.By.xpath;
 
 @ScreenType(platform = PlatformName.ANDROID)
@@ -171,7 +188,13 @@ public class AndroidLoginScreen extends LoginScreen {
 4. Resolve screen in test:
 
 ```java
-LoginScreen loginScreen = AqualityServices.getScreenFactory().getScreen(LoginScreen.class);
+public class DemoTest {
+    @Test
+    public void testScreenFactory() {
+        LoginScreen loginScreen = AqualityServices.getScreenFactory().getScreen(LoginScreen.class);
+        Assert.assertNotNull(loginScreen, "Screen must be resolved from factory");
+    }
+}
 ```
 
 You can find an example in [aquality-appium-mobile-java-template](https://github.com/aquality-automation/aquality-appium-mobile-java-template) repository.
@@ -180,7 +203,7 @@ You can find an example in [aquality-appium-mobile-java-template](https://github
 
 Our library allows you to run tests on different devices and store their settings (like udid, name, etc.) in JSON files.
 
-You have to add [devices.json](./src/test/resources/devices.json) file to resources where you can define a set of devices which you use to run tests.
+You have to add [devices.json](./src/test/resources/devices.json) file to resources where you can define a set of devices which you use for the test run.
 
 It is possible to set default device for each platform in [settings.json](./src/test/resources/settings.json) by defining `deviceKey` property which is a key of device settings from `devices.json` file.
 

azure-pipelines.yml

@@ -53,9 +53,6 @@ jobs:
   variables:
     ANDROID_EMU_NAME: test
     ANDROID_SDK_ID: system-images;android-28;google_apis_playstore;x86
-    XCODE_VERSION: 10.2
-    IOS_PLATFORM_VERSION: 12.2
-    IOS_DEVICE_NAME: iPhone X
 
   steps:
     - task: CmdLine@2
@@ -83,16 +80,21 @@ jobs:
           echo "Emulator started"
 
           echo "Installing Appium"
-          npm install -g appium@v1.17.0
+          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
           appium --version
           echo "Appium installed"
 
+          echo "Installing UIA2 driver"
+          appium driver install uiautomator2
+          appium driver list
+          echo "UIA2 driver installed"
+
           echo "Installing and Running Appium doctor"
           npm install -g request@2.34.0
-          npm install -g appium-doctor@1.15.1
+          npm install @appium/doctor -g
           ln -fs /usr/local/lib/node_modules/appium-doctor/appium-doctor.js /usr/local/bin/appium-doctor
           chmod +x /usr/local/bin/appium-doctor
           export PATH=$PATH:/usr/local/bin/appium-doctor
@@ -106,7 +108,7 @@ jobs:
       displayName: 'Start Appium server'
       inputs:
         script: |
-          appium --allow-insecure chromedriver_autodownload &
+          appium --allow-insecure chromedriver_autodownload --base-path /wd/hub &
           echo "Appium server started"
       condition: eq(variables['isRemote'], 'true')
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-appium-mobile</artifactId>
-    <version>2.2.0</version>
+    <version>3.0.0-beta</version>
 
     <packaging>jar</packaging>
     <name>Aquality Appium Mobile</name>
@@ -48,20 +48,16 @@
             <name>Pavel Anihimovsky</name>
         </developer>
         <developer>
-            <id>Nikikuzi</id>
-            <name>Nikita Kuznetsov</name>
+            <id>n-verbitsky</id>
+            <name>Nikita Viarbitski</name>
         </developer>
         <developer>
             <id>mialeska</id>
             <name>Alaksiej Mialeška</name>
         </developer>
         <developer>
-            <id>sunigos</id>
-            <name>Igor Sontsa</name>
-        </developer>
-        <developer>
-            <id>knysh</id>
-            <name>Sergey Knysh</name>
+            <id>shketok</id>
+            <name>Artem Lebakov</name>
         </developer>
     </developers>
 
@@ -176,26 +172,26 @@
         <dependency>
             <groupId>com.github.aquality-automation</groupId>
             <artifactId>aquality-selenium-core</artifactId>
-            <version>1.0.1</version>
+            <version>2.0.2</version>
         </dependency>
 
         <dependency>
             <groupId>io.appium</groupId>
             <artifactId>java-client</artifactId>
-            <version>7.3.0</version>
+            <version>8.0.0-beta2</version>
         </dependency>
 
         <dependency>
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>
-            <version>6.14.3</version>
+            <version>7.5</version>
             <scope>test</scope>
         </dependency>
 
         <dependency>
             <groupId>org.reflections</groupId>
             <artifactId>reflections</artifactId>
-            <version>0.9.12</version>
+            <version>0.10.2</version>
         </dependency>
     </dependencies>
 </project>

src/main/java/aquality/appium/mobile/actions/TouchActions.java

@@ -3,14 +3,31 @@
 import aquality.appium.mobile.application.AqualityServices;
 import aquality.appium.mobile.configuration.ITouchActionsConfiguration;
 import aquality.selenium.core.utilities.IElementActionRetrier;
-import io.appium.java_client.TouchAction;
-import io.appium.java_client.touch.offset.PointOption;
 import org.openqa.selenium.Point;
-import java.util.function.UnaryOperator;
-import static io.appium.java_client.touch.WaitOptions.waitOptions;
+import org.openqa.selenium.interactions.PointerInput;
+import org.openqa.selenium.interactions.Sequence;
+
+import java.time.Duration;
+import java.util.Collections;
 
 public class TouchActions implements ITouchActions {
 
+    private Duration getSwipeDuration() {
+        return AqualityServices.get(ITouchActionsConfiguration.class).getSwipeDuration();
+    }
+
+    private PointerInput getFinger() {
+        return new PointerInput(PointerInput.Kind.TOUCH, "finger");
+    }
+
+    private Sequence getPressSequence(PointerInput finger, Point startPoint) {
+        Sequence swipeDown = new Sequence(finger, 0);
+        return swipeDown
+                .addAction(finger.createPointerMove(
+                        Duration.ZERO, PointerInput.Origin.viewport(), startPoint.getX(), startPoint.getY()))
+                .addAction(finger.createPointerDown(PointerInput.MouseButton.LEFT.asArg()));
+    }
+
     @Override
     public void swipe(Point startPoint, Point endPoint) {
         AqualityServices.getLocalizedLogger().info(
@@ -19,10 +36,8 @@ public void swipe(Point startPoint, Point endPoint) {
                 startPoint.getY(),
                 endPoint.getX(),
                 endPoint.getY());
-        performTouchAction(touchAction -> touchAction
-                        .press(PointOption.point(startPoint))
-                        .waitAction(waitOptions(AqualityServices.get(ITouchActionsConfiguration.class).getSwipeDuration())),
-                endPoint);
+        PointerInput finger = getFinger();
+        performTouchAction(finger, getPressSequence(finger, startPoint), endPoint);
     }
 
     @Override
@@ -33,12 +48,19 @@ public void swipeWithLongPress(Point startPoint, Point endPoint) {
                 startPoint.getY(),
                 endPoint.getX(),
                 endPoint.getY());
-        performTouchAction(touchAction -> touchAction.longPress(PointOption.point(startPoint)), endPoint);
+        PointerInput finger = getFinger();
+        Sequence sequence = getPressSequence(finger, startPoint)
+                .addAction(finger.createPointerMove(
+                        getSwipeDuration(), PointerInput.Origin.viewport(), startPoint.getX(), startPoint.getY()));
+        performTouchAction(finger, sequence, endPoint);
     }
 
-    protected void performTouchAction(UnaryOperator<TouchAction<?>> function, Point endPoint) {
-        TouchAction<?> touchAction = new TouchAction<>(AqualityServices.getApplication().getDriver());
+    protected void performTouchAction(PointerInput finger, Sequence actionsSequence, Point endPoint) {
+        actionsSequence
+                .addAction(finger.createPointerMove(getSwipeDuration(),
+                        PointerInput.Origin.viewport(), endPoint.getX(), endPoint.getY()))
+                .addAction(finger.createPointerUp(PointerInput.MouseButton.LEFT.asArg()));
         AqualityServices.get(IElementActionRetrier.class).doWithRetry(() ->
-                function.apply(touchAction).moveTo(PointOption.point(endPoint)).release().perform());
+                AqualityServices.getApplication().getDriver().perform(Collections.singletonList(actionsSequence)));
     }
 }

src/main/java/aquality/appium/mobile/application/Application.java

@@ -8,7 +8,6 @@
 import org.openqa.selenium.remote.service.DriverService;
 
 import java.time.Duration;
-import java.util.concurrent.TimeUnit;
 
 public class Application implements IApplication {
 
@@ -32,7 +31,7 @@ public Application(AppiumDriver appiumDriver, DriverService driverService) {
     }
 
     private void setImplicitlyWaitToDriver(Duration duration) {
-        getDriver().manage().timeouts().implicitlyWait(duration.getSeconds(), TimeUnit.SECONDS);
+        getDriver().manage().timeouts().implicitlyWait(duration);
         this.timeoutImpl = duration;
     }
 

src/main/java/aquality/appium/mobile/application/ApplicationFactory.java

@@ -5,13 +5,11 @@
 import aquality.selenium.core.utilities.ElementActionRetrier;
 import io.appium.java_client.AppiumDriver;
 import io.appium.java_client.android.AndroidDriver;
-import io.appium.java_client.android.AndroidElement;
 import io.appium.java_client.ios.IOSDriver;
-import io.appium.java_client.ios.IOSElement;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.SessionNotCreatedException;
+import org.openqa.selenium.remote.http.ClientConfig;
 import org.openqa.selenium.remote.http.HttpClient;
-import org.openqa.selenium.remote.http.HttpClient.Builder;
 import org.openqa.selenium.remote.http.HttpClient.Factory;
 
 import java.net.URL;
@@ -43,18 +41,18 @@ protected AppiumDriver createSession(PlatformName platformName, URL serviceUrl,
         AppiumDriver driver;
         switch (platformName) {
             case ANDROID:
-                driver = new AndroidDriver<AndroidElement>(serviceUrl, httpClientFactory, capabilities);
+                driver = new AndroidDriver(serviceUrl, httpClientFactory, capabilities);
                 break;
             case IOS:
-                driver = new IOSDriver<IOSElement>(serviceUrl, httpClientFactory, capabilities);
+                driver = new IOSDriver(serviceUrl, httpClientFactory, capabilities);
                 break;
             default:
                 throw getLoggedWrongPlatformNameException(platformName.name());
         }
         return driver;
     }
 
-    protected class CustomActionRetrier extends ElementActionRetrier {
+    protected static class CustomActionRetrier extends ElementActionRetrier {
         private final List<Class<? extends Throwable>> handledExceptions;
 
         CustomActionRetrier(List<Class<? extends Throwable>> handledExceptions) {
@@ -68,19 +66,20 @@ public List<Class<? extends Throwable>> getHandledExceptions() {
         }
     }
 
-    protected class ClientFactory implements Factory {
+    protected static class ClientFactory implements Factory {
 
         private final Factory defaultClientFactory = Factory.createDefault();
         private final Duration timeoutCommand = AqualityServices.get(ITimeoutConfiguration.class).getCommand();
 
         @Override
-        public Builder builder() {
-            return defaultClientFactory.builder().readTimeout(timeoutCommand);
+        public HttpClient createClient(URL url) {
+            return defaultClientFactory.createClient(ClientConfig.defaultConfig().baseUrl(url).readTimeout(timeoutCommand));
         }
 
         @Override
-        public HttpClient createClient(URL url) {
-            return this.builder().createClient(url);
+        public HttpClient createClient(ClientConfig clientConfig) {
+            clientConfig.readTimeout(timeoutCommand);
+            return defaultClientFactory.createClient(clientConfig);
         }
 
         @Override

src/main/java/aquality/appium/mobile/application/AqualityServices.java

@@ -49,7 +49,7 @@ public static boolean isApplicationStarted() {
 
     /**
      * Resolves required service from DI container.
-     * Note that the service should be binded in {@link MobileModule}.
+     * Note that the service should be bound in {@link MobileModule}.
      *
      * @param type class of required service.
      * @param <T>  type of required service.
@@ -111,7 +111,7 @@ public static void setApplication(Application application) {
     /**
      * Reinitializes the dependency injector with custom {@link MobileModule}.
      *
-     * @param module {@link MobileModule} object with custom or overriden services.
+     * @param module {@link MobileModule} object with custom or overridden services.
      */
     public static void initInjector(MobileModule module) {
         if (INSTANCE_CONTAINER.get() != null) {
@@ -193,7 +193,7 @@ public static IConfiguration getConfiguration() {
     }
 
     /**
-     * Gets the the utility used to perform touch actions.
+     * Gets the utility used to perform touch actions.
      *
      * @return instance of touch actions.
      */

src/main/java/aquality/appium/mobile/configuration/DriverSettings.java

@@ -31,7 +31,12 @@ public DriverSettings(ISettingsFile settingsFile, PlatformName platformName) {
     public Capabilities getCapabilities() {
         Map<String, Object> capabilitiesFromSettings = getCapabilitiesFromSettings();
         DesiredCapabilities capabilities = new DesiredCapabilities();
-        capabilitiesFromSettings.forEach(capabilities::setCapability);
+        capabilitiesFromSettings.forEach((key, value) -> {
+            if (key.toLowerCase().endsWith("options")) {
+                value = settingsFile.getMap(getDriverSettingsPath("capabilities", key));
+            }
+            capabilities.setCapability(key, value);
+        });
         if (hasApplicationPath()) {
             capabilities.setCapability(APP_CAPABILITY_KEY, getAbsolutePath(getApplicationPath()));
         }