feat(java): ✨ added support to run on lambdatest cloud (#205)

WasiqB · web-flow · commit dfa023b71ae6 · 2022-10-04T23:18:23.000+05:30
diff --git a/.github/workflows/test-core.yml b/.github/workflows/test-core.yml
@@ -55,6 +55,7 @@ jobs:
       LT_USER: ${{ secrets.LT_USER }}
       LT_KEY: ${{ secrets.LT_KEY }}
       BS_APP_ANDROID: ${{ secrets.BS_APP_ANDROID }}
+      LT_APP_ANDROID: ${{ secrets.LT_APP_ANDROID }}
     steps:
       - name: Check out Git repository
         uses: actions/checkout@v3
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -3,4 +3,4 @@
 
 yarn lint-staged
 yarn build:site
-mvn org.jacoco:jacoco-maven-plugin:prepare-agent install -f core-java/pom.xml -Pcoverage-per-test -Dsuite-xml=test-suites/testng-local-husky.xml
+mvn clean install -f core-java/pom.xml -DskipTests
diff --git a/core-java/src/main/java/com/github/wasiqb/boyka/manager/DriverManager.java b/core-java/src/main/java/com/github/wasiqb/boyka/manager/DriverManager.java
@@ -17,7 +17,6 @@
 package com.github.wasiqb.boyka.manager;
 
 import static com.github.wasiqb.boyka.enums.AutomationType.UI_AUTOMATOR;
-import static com.github.wasiqb.boyka.enums.CloudProviders.BROWSER_STACK;
 import static com.github.wasiqb.boyka.enums.CloudProviders.NONE;
 import static com.github.wasiqb.boyka.enums.DeviceType.CLOUD;
 import static com.github.wasiqb.boyka.enums.DeviceType.VIRTUAL;
@@ -46,14 +45,17 @@
 import static io.github.bonigarcia.wdm.WebDriverManager.edgedriver;
 import static io.github.bonigarcia.wdm.WebDriverManager.firefoxdriver;
 import static io.github.bonigarcia.wdm.WebDriverManager.safaridriver;
+import static java.lang.System.getProperty;
 import static java.text.MessageFormat.format;
 import static java.time.Duration.ofSeconds;
 import static java.util.Objects.requireNonNullElse;
+import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 import static org.apache.logging.log4j.LogManager.getLogger;
 
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.file.Path;
+import java.util.HashMap;
 
 import com.github.wasiqb.boyka.config.FrameworkSetting;
 import com.github.wasiqb.boyka.config.ui.TimeoutSetting;
@@ -178,11 +180,13 @@ private URL getRemoteUrl (final WebSetting webSetting) {
 
     private void setAndroidApplicationOptions (final UiAutomator2Options options,
         final ApplicationSetting application) {
-        if (!application.isExternal ()) {
-            options.setApp (Path.of (System.getProperty ("user.dir"), "/src/test/resources", application.getPath ())
-                .toString ());
-        } else {
-            options.setApp (interpolate (application.getPath ()));
+        if (isNotEmpty (application.getPath ())) {
+            if (!application.isExternal ()) {
+                options.setApp (Path.of (getProperty ("user.dir"), "/src/test/resources", application.getPath ())
+                    .toString ());
+            } else {
+                options.setApp (interpolate (application.getPath ()));
+            }
         }
         options.setAppWaitActivity (application.getWaitActivity ());
         options.setAppWaitDuration (ofSeconds (application.getWaitTimeout ()));
@@ -284,12 +288,6 @@ private void setupAppiumServer () {
             .startServer ();
     }
 
-    private void setupBSAndroidDriver (final UiAutomator2Options options, final DeviceSetting deviceSetting) {
-        if (deviceSetting.getCapabilities () != null) {
-            options.setCapability ("bstack:options", deviceSetting.getCapabilities ());
-        }
-    }
-
     private WebDriver setupChromeDriver (final WebSetting webSetting) {
         LOGGER.traceEntry ();
         chromedriver ().setup ();
@@ -302,6 +300,35 @@ private WebDriver setupChromeDriver (final WebSetting webSetting) {
         return LOGGER.traceExit (new ChromeDriver (options));
     }
 
+    private void setupCloudAndroidDriver (final UiAutomator2Options options, final ServerSetting serverSetting,
+        final DeviceSetting deviceSetting) {
+        switch (serverSetting.getCloud ()) {
+            case BROWSER_STACK:
+                setupCloudAndroidDriverOptions (options, deviceSetting, "bstack");
+                break;
+            case LAMBDA_TEST:
+            default:
+                setupCloudAndroidDriverOptions (options, deviceSetting, "lt");
+                break;
+        }
+    }
+
+    private void setupCloudAndroidDriverOptions (final UiAutomator2Options options, final DeviceSetting deviceSetting,
+        final String optionPrefix) {
+        final var capabilities = deviceSetting.getCapabilities ();
+        if (capabilities != null) {
+            final var optionCapabilities = new HashMap<String, Object> ();
+            capabilities.forEach ((k, v) -> {
+                if (v instanceof String) {
+                    optionCapabilities.put (k, interpolate (v.toString ()));
+                } else {
+                    optionCapabilities.put (k, v);
+                }
+            });
+            options.setCapability (format ("{0}:options", optionPrefix), optionCapabilities);
+        }
+    }
+
     private void setupDriver () {
         LOGGER.traceEntry ();
         if (this.platformType == API) {
@@ -353,8 +380,8 @@ private WebDriver setupSafariDriver () {
     private void setupUiAutomatorDriver (final ServerSetting serverSetting, final DeviceSetting deviceSetting) {
         final UiAutomator2Options options = new UiAutomator2Options ();
         setCommonUiAutomatorOptions (options, deviceSetting);
-        if (deviceSetting.getType () == CLOUD && serverSetting.getCloud () == BROWSER_STACK) {
-            setupBSAndroidDriver (options, deviceSetting);
+        if (deviceSetting.getType () == CLOUD) {
+            setupCloudAndroidDriver (options, serverSetting, deviceSetting);
         } else {
             setLocalUiAutomatorOptions (options, deviceSetting);
         }
diff --git a/core-java/src/main/java/com/github/wasiqb/boyka/manager/ServiceManager.java b/core-java/src/main/java/com/github/wasiqb/boyka/manager/ServiceManager.java
@@ -17,7 +17,6 @@
 package com.github.wasiqb.boyka.manager;
 
 import static com.github.wasiqb.boyka.enums.CloudProviders.NONE;
-import static com.github.wasiqb.boyka.enums.Message.ERROR_DELETING_LOGS;
 import static com.github.wasiqb.boyka.enums.Message.ERROR_SERVER_NOT_RUNNING;
 import static com.github.wasiqb.boyka.enums.Message.ERROR_STARTING_SERVER;
 import static com.github.wasiqb.boyka.enums.Message.ERROR_STOPPING_SERVER;
@@ -36,8 +35,6 @@
 import static java.lang.Thread.currentThread;
 import static java.text.MessageFormat.format;
 import static java.time.Duration.ofSeconds;
-import static org.apache.commons.io.FileUtils.cleanDirectory;
-import static org.apache.commons.io.FileUtils.isEmptyDirectory;
 import static org.apache.commons.lang3.StringUtils.isNoneEmpty;
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 import static org.apache.logging.log4j.LogManager.getLogger;
@@ -240,26 +237,18 @@ private void setLogArguments () {
     }
 
     private void setLogFile () {
-        final String logFolderPath = this.setting.getLogs ()
+        final var logFolderPath = this.setting.getLogs ()
             .getPath ();
         if (logFolderPath != null) {
-            final File logFolder = new File (logFolderPath);
-            try {
-                if (!isEmptyDirectory (logFolder)) {
-                    cleanDirectory (logFolder);
-                }
-            } catch (final IOException e) {
-                handleAndThrow (ERROR_DELETING_LOGS, e);
-            }
             final var filePath = new File (format ("{0}/server-{1}.log", logFolderPath, currentThread ().getId ()));
             this.builder.withLogFile (filePath);
         }
     }
 
     private void setNodeExe () {
         if (this.setting.getNodePath () != null) {
-            final File nde = new File (this.setting.getNodePath ());
-            this.builder.usingDriverExecutable (nde);
+            final var node = new File (this.setting.getNodePath ());
+            this.builder.usingDriverExecutable (node);
         }
     }
 
diff --git a/core-java/src/main/java/com/github/wasiqb/boyka/sessions/DriverSession.java b/core-java/src/main/java/com/github/wasiqb/boyka/sessions/DriverSession.java
@@ -22,8 +22,7 @@
 import com.github.wasiqb.boyka.config.FrameworkSetting;
 import com.github.wasiqb.boyka.enums.PlatformType;
 import com.github.wasiqb.boyka.manager.ServiceManager;
-import lombok.Getter;
-import lombok.Setter;
+import lombok.Data;
 import org.apache.logging.log4j.Logger;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.support.ui.WebDriverWait;
@@ -36,10 +35,10 @@
  * @author Wasiq Bhamla
  * @since 19-Feb-2022
  */
-@Setter
-@Getter
+@Data
 public class DriverSession<D extends WebDriver> {
     private static final Logger LOGGER = getLogger ();
+
     private       D                driver;
     private       PlatformType     platformType;
     private       ServiceManager   serviceManager;
diff --git a/core-java/src/test/resources/boyka-config.json b/core-java/src/test/resources/boyka-config.json
@@ -197,6 +197,41 @@
             "appiumLogs": true
           }
         }
+      },
+      "test_lt_android": {
+        "server": {
+          "cloud": "LAMBDA_TEST",
+          "protocol": "HTTPS",
+          "host": "mobile-hub.lambdatest.com",
+          "user_name": "${env:LT_USER}",
+          "password": "${env:LT_KEY}",
+          "base_path": "/wd/hub"
+        },
+        "device": {
+          "automation": "UI_AUTOMATOR",
+          "type": "CLOUD",
+          "application": {
+            "wait_activity": "com.swaglabsmobileapp.MainActivity",
+            "install_timeout": 180
+          },
+          "capabilities": {
+            "platformName": "Android",
+            "deviceName": "Pixel 5",
+            "platformVersion": "11",
+            "app": "${env:LT_APP_ANDROID}",
+            "project": "LambdaTest Android Project",
+            "build": "Test LambdaTest Build",
+            "name": "Test LambdaTest Session",
+            "devicelog": true,
+            "network": true,
+            "visual": true,
+            "video": true,
+            "autoGrantPermissions": true,
+            "autoAcceptAlerts": true,
+            "isRealMobile": true,
+            "w3c": true
+          }
+        }
       }
     }
   },
diff --git a/core-java/test-suites/testng-mobile-lt.xml b/core-java/test-suites/testng-mobile-lt.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+~ MIT License
+~
+~ Copyright (c) 2022 Wasiq Bhamla
+~
+~ Permission is hereby granted, free of charge, to any person obtaining a copy
+~ of this software and associated documentation files (the "Software"), to deal
+~ in the Software without restriction, including without limitation the rights
+~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+~ copies of the Software, and to permit persons to whom the Software is
+~ furnished to do so, subject to the following conditions:
+~
+~ The above copyright notice and this permission notice shall be included in all
+~ copies or substantial portions of the Software.
+-->
+
+<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
+<suite name="Boyka Mobile Cloud Suite" verbose="2" parallel="classes">
+    <test name="Test Boyka Mobile on LambdaTest Android Device">
+        <parameter name="appType" value="ANDROID"/>
+        <parameter name="driverKey" value="test_lt_android"/>
+        <packages>
+            <package name="com.github.wasiqb.boyka.testng.mobile"/>
+        </packages>
+    </test>
+</suite>
diff --git a/core-java/test-suites/testng-mobile.xml b/core-java/test-suites/testng-mobile.xml
@@ -20,5 +20,6 @@
     <suite-files>
         <suite-file path="testng-mobile-local.xml"/>
         <suite-file path="testng-mobile-bs.xml"/>
+        <suite-file path="testng-mobile-lt.xml"/>
     </suite-files>
 </suite>
diff --git a/package.json b/package.json
@@ -32,29 +32,29 @@
   "devDependencies": {
     "@commitlint/cli": "^17.1.2",
     "@commitlint/config-conventional": "^17.1.0",
-    "@types/node": "^18.7.18",
-    "@typescript-eslint/eslint-plugin": "^5.38.0",
-    "@typescript-eslint/parser": "^5.38.0",
+    "@types/node": "^18.8.0",
+    "@typescript-eslint/eslint-plugin": "^5.38.1",
+    "@typescript-eslint/parser": "^5.38.1",
     "commitlint": "^17.1.2",
-    "eslint": "^8.23.1",
+    "eslint": "^8.24.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.31.8",
     "husky": "^8.0.1",
-    "lerna": "^5.5.1",
+    "lerna": "^5.6.1",
     "lerna-changelog": "^2.2.0",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.3"
+    "typescript": "^4.8.4"
   },
   "scripts": {
-    "prepare": "husky install",
+    "postinstall": "husky install",
     "build:site": "yarn workspace website build",
     "start:site": "yarn workspace website start",
     "deploy:site": "yarn workspace website deploy",
diff --git a/website/docs/contributing/project-details/commit-steps.md b/website/docs/contributing/project-details/commit-steps.md
@@ -153,7 +153,7 @@ Following checks will happen when you commit:
 - ESLint to check if the website code complies with the [ESLint](https://eslint.org/) rules. It will only run if there is change to `.js`, `.jsx`, `.ts` or `.tsx` files.
 - Prettier to check if the website code complies with the [Prettier](https://prettier.io/) rules. It will only run if there is change to `.js`, `.jsx`, `.ts` or `.tsx` files.
 - Build the documentation website to check if the website builds successfully.
-- Build and run tests from the Java project to check if the check style, code compilation is successful and overall code coverage is above `70%`.
+- Build and run check styles from the Java project to check if the check style and code compilation is successful.
 
 ## Push your commit
 
@@ -173,4 +173,8 @@ When you click on the `Push` button, you will see a pop-up asking you to confirm
 
 ## Create draft PR
 
-As soon as you push your commit, you must create a draft PR on GitHub. Because our workflows will only get triggered on PR's that are raised against `main` branch.
+As soon as you push your commit, you must create a draft PR on GitHub. Because our workflows will only get triggered on PR's that are raised against `develop` branch.
+
+## Ping on Discord
+
+Once PR is raised, ping in the `#contributor-discussion` channel on our [Discord server](https://discord.gg/dUg8K9DAsR) to let all the contributors know and you can schedule a demo with the contributors to showcase your changes.
diff --git a/website/docs/contributing/project-details/ready-your-pr.md b/website/docs/contributing/project-details/ready-your-pr.md
@@ -33,7 +33,7 @@ Make sure to address the reviewers feedbacks.
 
 ## Demo PR
 
-Once you have updated reviewers feedback in your PR. You need to demonstrate your feature development to the Maintainers and Repo owners by showing your worknig code along with the tests.
+Once you have updated reviewers feedback in your PR. You need to demonstrate your feature development to the Maintainers and Repo owners by showing your working code along with the tests.
 
 This Demo would be taking place on [Discord][join-discord]:
 
@@ -45,7 +45,7 @@ This Demo would be taking place on [Discord][join-discord]:
 If everything is fine, wait for `boyka-core` team to merge your PR. Most of the time, we will merge your PR as soon as we approve it. It's very rare that we won't merge your PR immediately after approving it.
 
 :::danger
-Don't merge approved PR yourself. Instead, tag the `boyka-core` team to the PR comments.
+Don't merge approved PR yourself. Instead, tag the `boyka-core` team to the PR comments if it's not merged by the reviewer.
 :::
 
 [join-discord]: https://discord.gg/dUg8K9DAsR
diff --git a/yarn.lock b/yarn.lock
