Merge pull request #26 from kamal-kaur04/migrate-cucumber-sample-to-sel4

migrate master branch to use Sel 4 compliant samples

Author: karanshah-browserstack

.gitignore

@@ -18,3 +18,11 @@ target/
 
 local.log
 reports
+.settings
+.gradle
+test-output
+logs
+build
+gradle
+.project
+.classpath

pom.xml

@@ -16,25 +16,13 @@
         <maven.compiler.target>1.8</maven.compiler.target>
         <cucumber.version>6.9.1</cucumber.version>
         <testng.version>7.4.0</testng.version>
-        <selenium-java.version>3.141.59</selenium-java.version>
+        <selenium-java.version>4.4.0</selenium-java.version>
         <browserstack-local-java.version>1.0.6</browserstack-local-java.version>
         <json-simple.version>1.1.1</json-simple.version>
         <slf4j.version>1.7.30</slf4j.version>
     </properties>
 
     <dependencies>
-
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>${slf4j.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-simple</artifactId>
-            <version>${slf4j.version}</version>
-        </dependency>
-
         <dependency>
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>

src/test/java/com/browserstack/pageobjects/HomePage.java

@@ -5,6 +5,8 @@
 import org.openqa.selenium.support.ui.ExpectedConditions;
 import org.openqa.selenium.support.ui.WebDriverWait;
 
+import java.time.Duration;
+
 public class HomePage {
     private WebDriver webDriver;
 
@@ -33,7 +35,7 @@ public void clickAddToCartButton() {
     }
 
     public void waitForCartToOpen() {
-        new WebDriverWait(webDriver,30).until(ExpectedConditions.visibilityOfAllElementsLocatedBy(cartPane));
+        new WebDriverWait(webDriver, Duration.ofSeconds(30)).until(ExpectedConditions.visibilityOfAllElementsLocatedBy(cartPane));
     }
 
     public String getProductCartText() {

src/test/java/com/browserstack/util/Utility.java

@@ -18,17 +18,7 @@ public static JSONObject getCombinedCapability(Map<String, String> envCapabiliti
         JSONObject capabilities = new JSONObject();
         JSONObject commonCapabilities = (JSONObject) config.get("capabilities");
         Iterator it = envCapabilities.entrySet().iterator();
-        while (it.hasNext()) {
-            Map.Entry pair = (Map.Entry) it.next();
-            capabilities.put(pair.getKey().toString(), pair.getValue().toString());
-        }
-        it = commonCapabilities.entrySet().iterator();
-        while (it.hasNext()) {
-            Map.Entry pair = (Map.Entry) it.next();
-            if (capabilities.get(pair.getKey().toString()) == null) {
-                capabilities.put(pair.getKey().toString(), pair.getValue().toString());
-            }
-        }
+
         String username = System.getenv("BROWSERSTACK_USERNAME");
         if(username == null) {
             username = (String) config.get("user");
@@ -38,8 +28,28 @@ public static JSONObject getCombinedCapability(Map<String, String> envCapabiliti
         if(accessKey == null) {
             accessKey = (String) config.get("key");
         }
-        capabilities.put("browserstack.user", username);
-        capabilities.put("browserstack.key", accessKey);
+
+        JSONObject bstackOptions = commonCapabilities.get("bstack:options") != null ? (JSONObject) commonCapabilities.get("bstack:options") : new JSONObject();
+        bstackOptions.putIfAbsent("userName", username);
+        bstackOptions.putIfAbsent("accessKey", accessKey);
+        capabilities.put("bstack:options", bstackOptions);
+
+        while (it.hasNext()) {
+            Map.Entry pair = (Map.Entry) it.next();
+            capabilities.put(pair.getKey().toString(), pair.getValue());
+        }
+
+        it = commonCapabilities.entrySet().iterator();
+        while (it.hasNext()) {
+            Map.Entry pair = (Map.Entry) it.next();
+            if (capabilities.get(pair.getKey().toString()) == null) {
+                capabilities.put(pair.getKey().toString(), pair.getValue());
+            } else if (pair.getKey().toString().equalsIgnoreCase("bstack:options")) {
+                HashMap<String, String> bstackOptionsMap = (HashMap) pair.getValue();
+                bstackOptionsMap.putAll((HashMap) capabilities.get("bstack:options"));
+                capabilities.put(pair.getKey().toString(), bstackOptionsMap);
+            }
+        }
         return capabilities;
     }
 
@@ -49,17 +59,18 @@ public static void setSessionStatus(WebDriver webDriver, String status, String r
     }
 
     public static boolean isLocal(ManagedWebDriver managedWebDriver) {
-        JSONObject platform = managedWebDriver.getPlatform();
-        return platform.get("browserstack.local") != null && platform.get("browserstack.local").toString().equalsIgnoreCase("true");
+        JSONObject platform = (JSONObject) managedWebDriver.getPlatform().get("bstack:options");
+        return platform.get("local") != null && platform.get("local").toString().equalsIgnoreCase("true");
     }
 
     public static void startLocal(Local local, ManagedWebDriver managedWebDriver) {
         JSONParser parser = new JSONParser();
         Map<String, String> options = new HashMap<>();
-        options.put("key", managedWebDriver.getPlatform().get("browserstack.key").toString());
+        JSONObject testConfig = (JSONObject) managedWebDriver.getPlatform().get("bstack:options");
+        options.put("key", testConfig.get("accessKey").toString());
         String capabilitiesConfigFile = System.getProperty("caps", "src/test/resources/conf/local.conf.json");
         try {
-            JSONObject testConfig = (JSONObject) parser.parse(new FileReader(capabilitiesConfigFile));
+            testConfig = (JSONObject) parser.parse(new FileReader(capabilitiesConfigFile));
             if(testConfig.containsKey("localOptions")) {
                 JSONObject localOptions = (JSONObject) testConfig.get("localOptions");
                 options.forEach(localOptions::putIfAbsent);

src/test/java/com/browserstack/webdriver/WebDriverFactory.java

@@ -5,6 +5,7 @@
 import org.json.simple.JSONObject;
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
+import org.openqa.selenium.MutableCapabilities;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import org.openqa.selenium.remote.RemoteWebDriver;
@@ -61,8 +62,7 @@ public List<JSONObject> getPlatforms() {
     public WebDriver createWebDriverForPlatform(JSONObject platform, String testName) {
         try {
             String URL = String.format("https://%s/wd/hub", testConfig.get("server"));
-            DesiredCapabilities caps = new DesiredCapabilities(platform);
-            caps.setCapability("name", testName);
+            MutableCapabilities caps = new MutableCapabilities(platform);
             return new RemoteWebDriver(new URL(URL), caps);
         } catch (MalformedURLException var4) {
             throw new Error("Unable to create WebDriver", var4);

src/test/resources/conf/local.conf.json

@@ -4,16 +4,25 @@
   "key": "BROWSERSTACK_ACCESS_KEY",
 
   "capabilities": {
-    "build": "cucumber-java-browserstack",
-    "browserstack.debug": true,
-    "browserstack.local": true
+    "bstack:options": {
+      "buildName": "browserstack-build-1",
+      "sessionName": "BStack Local Test",
+      "debug": true,
+      "local": true,
+      "source": "cucumber:sample-master-v1.0"
+    }
   },
 
-  "environments": [{
-    "browser": "chrome"
-  }],
-
   "localOptions": {
     "forceLocal": true
-  }
+  },
+
+  "environments": [
+    {
+      "bstack:options": {
+        "os": "OS X"
+      },
+      "browserName": "chrome"
+    }
+  ]
 }

src/test/resources/conf/parallel.conf.json

@@ -4,19 +4,27 @@
   "key": "BROWSERSTACK_ACCESS_KEY",
 
   "capabilities": {
-    "build": "cucumber-java-browserstack",
-    "browserstack.debug": true
+    "bstack:options": {
+      "buildName": "browserstack-build-1",
+      "sessionName": "BStack Parallel Test",
+      "browserVersion": "latest",
+      "debug": true,
+      "source": "cucumber:sample-master-v1.0"
+    }
   },
 
   "environments": [
     {
-      "browser": "chrome"
+      "browserName": "chrome"
     },
     {
-      "browser": "firefox"
+      "browserName": "firefox"
     },
     {
-      "browser": "safari"
+      "bstack:options": {
+        "os": "OS X"
+      },
+      "browserName": "safari"
     }
   ]
 }

src/test/resources/conf/single.conf.json

@@ -4,11 +4,18 @@
   "key": "BROWSERSTACK_ACCESS_KEY",
 
   "capabilities": {
-    "build": "cucumber-java-browserstack",
-    "browserstack.debug": true
+    "bstack:options": {
+      "buildName": "browserstack-build-1",
+      "sessionName": "BStack Single Test",
+      "browserVersion": "latest",
+      "debug": true,
+      "source": "cucumber:sample-master-v1.0"
+    }
   },
 
-  "environments": [{
-    "browser": "chrome"
-  }]
+  "environments": [
+    {
+      "browserName": "chrome"
+    }
+  ]
 }