add: sdk branch

Author: Ankit098

.gitignore

@@ -3,4 +3,4 @@
 .project
 .settings/
 target/
-browserstack.err
+browserstack.err

README.md

@@ -13,7 +13,6 @@
   ```
 ## Running your tests
 * To run a sample tests, run `mvn test -P sample-test`
-* To run sample tests with local, run `mvn test -P sample-local-test`
 * Update `<parallel.count>` in `pom.xml` to set the number of parallel threads 
 
 Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)

browserstack.yml

@@ -0,0 +1,78 @@
+# =============================
+# Set BrowserStack Credentials
+# =============================
+# Add your BrowserStack userName and accessKey here or set BROWSERSTACK_USERNAME and
+# BROWSERSTACK_ACCESS_KEY as env variables
+userName: YOUR_USERNAME
+accessKey: YOUR_ACCESS_KEY
+
+# ======================
+# BrowserStack Reporting
+# ======================
+# The following capabilities are used to set up reporting on BrowserStack:
+# Set 'projectName' to the name of your project. Example, Marketing Website
+projectName: BrowserStack Samples 
+# Set `buildName` as the name of the job / testsuite being run
+buildName: browserstack build 
+# `buildIdentifier` is a unique id to differentiate every execution that gets appended to
+# buildName. Choose your buildIdentifier format from the available expressions:
+# ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+# ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+# Read more about buildIdentifiers here -> https://www.browserstack.com/docs/automate/selenium/organize-tests
+buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${expression}
+# Set `framework` of your test suite. Example, `testng`, `cucumber`, `cucumber-testng`
+# This property is needed to send test context to BrowserStack (test name, status)
+framework: junit5
+
+source: java-playwright-browserstack:sample-sdk:v1.0
+
+# =======================================
+# Platforms (Browsers / Devices to test)
+# =======================================
+# Platforms object contains all the browser / device combinations you want to test on.
+# Entire list available here -> (https://www.browserstack.com/list-of-browsers-and-platforms/automate)
+platforms:
+  - os: OS X
+    osVersion: Big Sur
+    browserName: Chrome
+    browserVersion: latest
+  - os: Windows
+    osVersion: 10
+    browserName: Edge
+    browserVersion: latest
+  - deviceName: Samsung Galaxy S22 Ultra
+    browserName: chrome # Try 'samsung' for Samsung browser
+    osVersion: 12.0
+
+# =======================
+# Parallels per Platform
+# =======================
+# The number of parallel threads to be used for each platform set.
+# BrowserStack's SDK runner will select the best strategy based on the configured value
+#
+# Example 1 - If you have configured 3 platforms and set `parallelsPerPlatform` as 2, a total of 6 (2 * 3) parallel threads will be used on BrowserStack
+#
+# Example 2 - If you have configured 1 platform and set `parallelsPerPlatform` as 5, a total of 5 (1 * 5) parallel threads will be used on BrowserStack
+parallelsPerPlatform: 1
+
+# ==========================================
+# BrowserStack Local
+# (For localhost, staging/private websites)
+# ==========================================
+# Set browserStackLocal to true if your website under test is not accessible publicly over the internet
+# Learn more about how BrowserStack Local works here -> https://www.browserstack.com/docs/automate/selenium/local-testing-introduction
+browserstackLocal: true # <boolean> (Default false)
+
+# Options to be passed to BrowserStack local in-case of advanced configurations
+# browserStackLocalOptions:
+  # localIdentifier: # <string> (Default: null) Needed if you need to run multiple instances of local.
+  # forceLocal: true  # <boolean> (Default: false) Set to true if you need to resolve all your traffic via BrowserStack Local tunnel.
+  # Entire list of arguments available here -> https://www.browserstack.com/docs/automate/selenium/manage-incoming-connections
+  
+# ===================
+# Debugging features
+# ===================
+debug: false # <boolean> # Set to true if you need screenshots for every selenium command ran
+networkLogs: false # <boolean> Set to true to enable HAR logs capturing
+consoleLogs: errors # <string> Remote browser's console debug levels to be printed (Default: errors)
+# Available options are `disable`, `errors`, `warnings`, `info`, `verbose` (Default: errors)

src/test/java/runners/BstackRunner.java

@@ -7,7 +7,6 @@
 import org.json.simple.JSONObject;
 import org.json.simple.parser.JSONParser;
 import org.junit.jupiter.api.extension.*;
-import utils.SetupLocalTesting;
 
 import java.io.FileReader;
 import java.io.UnsupportedEncodingException;
@@ -17,43 +16,9 @@
 
 public class BstackRunner implements TestTemplateInvocationContextProvider {
     public Browser browser;
-    public String username, accessKey, wss;
+    public String wss;
     private JSONObject mainConfig;
     private JSONArray platformConfig;
-    private Map<String, Object> commonCapsConfig;
-
-
-    public BstackRunner() {
-        this.username = setupCredsAndServer().get("username");
-        this.accessKey = setupCredsAndServer().get("accesskey");
-        this.wss = setupCredsAndServer().get("wss");
-    }
-
-    public HashMap<String, String> setupCredsAndServer() {
-        try {
-            if (System.getProperty("config") != null) {
-                JSONParser parser = new JSONParser();
-                mainConfig = (JSONObject) parser
-                        .parse(new FileReader("src/test/resources/conf/" + System.getProperty("config")));
-            }
-            wss = (String) mainConfig.get("wss");
-            username = System.getenv("BROWSERSTACK_USERNAME");
-            if (username == null) {
-                username = (String) mainConfig.get("userName");
-            }
-            accessKey = System.getenv("BROWSERSTACK_ACCESS_KEY");
-            if (accessKey == null) {
-                accessKey = (String) mainConfig.get("accessKey");
-            }
-        } catch (Exception e) {
-            System.out.println(e.getMessage());
-        }
-        HashMap<String, String> creds = new HashMap();
-        creds.put("username", username);
-        creds.put("accesskey", accessKey);
-        creds.put("wss", wss);
-        return creds;
-    }
 
     @Override
     public boolean supportsTestTemplate(ExtensionContext extensionContext) {
@@ -65,21 +30,14 @@ public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContex
         List<TestTemplateInvocationContext> desiredCapsInvocationContexts = new ArrayList<>();
 
         try {
+            JSONParser parser = new JSONParser();
+            mainConfig = (JSONObject) parser
+                        .parse(new FileReader("src/test/resources/conf/" + System.getProperty("config")));
             platformConfig = (JSONArray) mainConfig.get("environments");
-            commonCapsConfig = (Map<String, Object>) mainConfig.get("capabilities");
+            wss = (String) mainConfig.get("wss");
 
             for (int i = 0; i < platformConfig.size(); i++) {
                 JSONObject platform = (JSONObject) platformConfig.get(i);
-                platform.putAll(commonCapsConfig);
-                platform.put("browserstack.username", username);
-                platform.put("browserstack.accessKey", accessKey);
-                if(Objects.equals(System.getProperty("local"), "true")) {
-                    platform.put("browserstack.local", "true");
-                    HashMap<String, String> localOptions = new HashMap<>();
-                    localOptions.put("key", accessKey);
-                    //Add more local options here, e.g. forceLocal, localIdentifier, etc.
-                    SetupLocalTesting.createInstance(localOptions);
-                }
                 desiredCapsInvocationContexts.add(invocationContext(platform));
             }
         } catch (Exception e) {
@@ -104,10 +62,6 @@ public boolean supportsParameter(ParameterContext parameterContext,
                     @Override
                     public Object resolveParameter(ParameterContext parameterContext,
                                                    ExtensionContext extensionContext) {
-                        String testName = extensionContext.getTestMethod().get().getName();
-                        testName += " [" + capabilitiesObject.get("os") + " " + capabilitiesObject.get("os_version");
-                        testName += " - " + capabilitiesObject.get("browser") + " " + capabilitiesObject.get("browser_version") + "]";
-                        capabilitiesObject.put("name", testName);
                         Playwright playwright = Playwright.create();
                         BrowserType browserType = playwright.chromium();
                         String caps = null;

src/test/java/tests/SampleTest.java

@@ -3,6 +3,7 @@
 import com.microsoft.playwright.Browser;
 import com.microsoft.playwright.Page;
 import runners.PlaywrightTest;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class SampleTest {
 
@@ -14,15 +15,10 @@ void sampleTest(Browser browser) {
             String product_name = page.locator("//*[@id='1']/p").textContent();
             page.locator("//*[@id='1']/div[4]").click();
             page.locator(".float\\-cart__content");
-            String product_in_cart = page.locator("//*[@id='__next']/div/div/div[2]/div[2]/div[2]/div/div[3]/p[1]").textContent();
-            // Update Test Status
-            if (product_name.equals(product_in_cart)) {
-                page.evaluate("_ => {}", "browserstack_executor: { \"action\": \"setSessionStatus\", \"arguments\": { \"status\": \"" + "passed" + "\", \"reason\": \"" + "Product has been successfully added to the cart!" + "\"}}");
-            } else {
-                page.evaluate("_ => {}", "browserstack_executor: { \"action\": \"setSessionStatus\", \"arguments\": { \"status\": \"" + "failed" + "\", \"reason\": \"" + "There was some issue!" + "\"}}");
-            }
+            String product_in_cart = page.locator("//*[@id='__next']/div/div/div[2]/div[2]/div[2]/div/div[3]/p[1]")
+                    .textContent();
+            assertEquals(product_in_cart, product_name);
         } catch (Exception e) {
-            page.evaluate("_ => {}", "browserstack_executor: { \"action\": \"setSessionStatus\", \"arguments\": { \"status\": \"" + "failed" + "\", \"reason\": \"" + "There was some issue!" + "\"}}");
             System.out.println("Exception: " + e.getMessage());
         }
         browser.close();

src/test/java/utils/SetupLocalTesting.java

@@ -1,14 +1,5 @@
 {
-  "wss": "wss://cdp.browserstack.com/playwright",
-  "userName": "BROWSERSTACK_USERNAME",
-  "accessKey": "BROWSERSTACK_ACCESS_KEY",
-  "capabilities": {
-    "project": "BStack Project",
-    "build": "browserstack-build-1",
-    "buildTag": "Regression",
-    "browserstack.debug": "true",
-    "browserstack.console": "info"
-  },
+  "wss": "ws://127.0.0.1:64225/ec873d261d8cad986db668660c8ab412",
   "environments": [
     {
       "os": "Windows",
@@ -21,12 +12,6 @@
       "os_version": "Monterey",
       "browser": "playwright-webkit",
       "browser_version": "latest"
-    },
-    {
-      "os": "OS X",
-      "os_version": "Ventura",
-      "browser": "playwright-firefox",
-      "browser_version": "latest"
     }
   ]
 }