added local using bindings test for python and java

Author: kamal-kaur04

playwright-java/README.md

@@ -19,6 +19,12 @@
 
   ### Run sample test on privately hosted websites
 
+  **Using Language Bindings**
+    1. Run 
+    `mvn -Dexec.mainClass="com.browserstack.PlaywrightLocalUsingBindingsTest" -Dexec.classpathScope=test test-compile exec:java`
+
+  **Using Command-line Interface**
+
   1. You have to download the BrowserStack Local binary from the links below (depending on your environment):
       * [OS X (10.7 and above)](https://www.browserstack.com/browserstack-local/BrowserStackLocal-darwin-x64.zip)
       * [Linux 32-bit](https://www.browserstack.com/browserstack-local/BrowserStackLocal-linux-ia32.zip)

playwright-java/pom.xml

@@ -19,5 +19,11 @@
             <version>1.19.0</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.browserstack</groupId>
+            <artifactId>browserstack-local-java</artifactId>
+            <version>1.0.6</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

playwright-java/src/test/java/com/browserstack/PlaywrightLocalUsingBindingsTest.java

@@ -0,0 +1,73 @@
+package com.browserstack;
+
+import com.google.gson.JsonObject;
+import com.microsoft.playwright.*;
+import java.net.URLEncoder;
+import java.util.HashMap;
+
+import com.browserstack.local.Local;
+
+public class PlaywrightLocalUsingBindingsTest {
+    public static void main(String[] args) {
+        try (Playwright playwright = Playwright.create()) {
+            JsonObject capabilitiesObject = new JsonObject();
+            capabilitiesObject.addProperty("browser", "chrome");    // allowed browsers are `chrome`, `edge`, `playwright-chromium`, `playwright-firefox` and `playwright-webkit`
+            capabilitiesObject.addProperty("browser_version", "latest");
+            capabilitiesObject.addProperty("os", "osx");
+            capabilitiesObject.addProperty("os_version", "catalina");
+            capabilitiesObject.addProperty("name", "Playwright first local test");
+            capabilitiesObject.addProperty("build", "playwright-java-3");
+            capabilitiesObject.addProperty("browserstack.username", "BROWSERSTACK_USERNAME");
+            capabilitiesObject.addProperty("browserstack.accessKey", "BROWSERSTACK_ACCESS_KEY");
+            capabilitiesObject.addProperty("browserstack.local", "true");
+
+            //Creates an instance of Local
+            Local bsLocal = new Local();
+
+            // You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY".
+            HashMap<String, String> bsLocalArgs = new HashMap<String, String>();
+            bsLocalArgs.put("key", "BROWSERSTACK_ACCESS_KEY");
+
+            // Starts the Local instance with the required arguments
+            bsLocal.start(bsLocalArgs);
+
+            // Check if BrowserStack local instance is running
+            System.out.println(bsLocal.isRunning());
+
+            BrowserType chromium = playwright.chromium();
+            String caps = URLEncoder.encode(capabilitiesObject.toString(), "utf-8");
+            String ws_endpoint = "wss://cdp.browserstack.com/playwright?caps=" + caps;
+            Browser browser = chromium.connect(ws_endpoint);
+            Page page = browser.newPage();
+            try {
+                page.navigate("https://www.google.co.in/");
+                Locator locator = page.locator("[aria-label='Search']");
+                locator.click();
+                page.fill("[aria-label='Search']", "BrowserStack");
+                page.locator("[aria-label='Google Search'] >> nth=0").click();
+                String title = page.title();
+    
+                if (title.equals("BrowserStack - Google Search")) {
+                    // following line of code is responsible for marking the status of the test on BrowserStack as 'passed'. You can use this code in your after hook after each test
+                    markTestStatus("passed", "Title matched", page);
+                } else {
+                    markTestStatus("failed", "Title did not match", page);
+                }              
+            } catch (Exception err) {
+                markTestStatus("failed", err.getMessage(), page);
+            }
+            browser.close();
+
+            //Stop the Local instance
+            bsLocal.stop();
+        } catch (Exception err) {
+            System.out.println(err);
+        }
+    }
+
+    public static void markTestStatus(String status, String reason, Page page) {
+        Object result;
+        result = page.evaluate("_ => {}", "browserstack_executor: { \"action\": \"setSessionStatus\", \"arguments\": { \"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
+        System.out.println(result);
+    }
+}

playwright-python/README.md

@@ -21,6 +21,14 @@
 - To run parallel tests, run `python parallel-playwright-test.py`
 
   ### Run sample test on privately hosted websites
+  **Using Language Bindings**
+    1. Follow the steps below:
+       ```
+       pip install browserstack-local
+       python local-using-bindings-playwright-test.py
+       ```
+
+    **Using Command-line Interface**
 
   1. You have to download the BrowserStack Local binary from the links below (depending on your environment):
       * [OS X (10.7 and above)](https://www.browserstack.com/browserstack-local/BrowserStackLocal-darwin-x64.zip)

playwright-python/local-playwright-test.py

@@ -36,7 +36,7 @@ def run_local_session():
       mark_test_status("failed", "Title did not match", page)
 
   except Exception as err:
-    mark_test_status("failed", err, page)
+    mark_test_status("failed", str(err), page)
 
   browser.close()
 

playwright-python/local-using-bindings-playwright-test.py

@@ -0,0 +1,62 @@
+import json
+import urllib
+import subprocess
+from playwright.sync_api import sync_playwright
+from browserstack.local import Local
+
+desired_cap = {
+  'browser': 'chrome',  # allowed browsers are `chrome`, `edge`, `playwright-chromium`, `playwright-firefox` and `playwright-webkit`
+  'browser_version': 'latest', # this capability is valid only for branded `chrome` and `edge` browsers and you can specify any browser version like `latest`, `latest-beta`, `latest-1` and so on.
+  'os': 'osx',
+  'os_version': 'catalina',
+  'name': 'Branded Google Chrome on Catalina',
+  'build': 'playwright-build-3',
+  'browserstack.local': 'true',
+  'browserstack.username': 'BROWSERSTACK_USERNAME',
+  'browserstack.accessKey': 'BROWSERSTACK_ACCESS_KEY'
+}
+
+def run_local_session(playwright):
+    # Creates an instance of Local
+    bs_local = Local()
+
+    # You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY".
+    bs_local_args = { "key": "BROWSERSTACK_ACCESS_KEY" }
+
+    # Starts the Local instance with the required arguments
+    bs_local.start(**bs_local_args)
+
+    # Check if BrowserStack local instance is running
+    print(bs_local.isRunning())
+
+    clientPlaywrightVersion = str(subprocess.getoutput('playwright --version')).strip().split(" ")[1]
+    desired_cap['client.playwrightVersion'] = clientPlaywrightVersion
+    
+    cdpUrl = 'wss://cdp.browserstack.com/playwright?caps=' + urllib.parse.quote(json.dumps(desired_cap))
+    browser = playwright.chromium.connect(cdpUrl)
+    page = browser.new_page()
+    try:
+      page.goto("https://www.google.co.in/")
+      page.fill("[aria-label='Search']", 'Browserstack')
+      locator = page.locator("[aria-label='Google Search'] >> nth=0")
+      locator.click()
+      title = page.title()
+
+      if title == "Browserstack - Google Search":
+        # following line of code is responsible for marking the status of the test on BrowserStack as 'passed'. You can use this code in your after hook after each test
+        mark_test_status("passed", "Title matched", page)
+      else:
+        mark_test_status("failed", "Title did not match", page)
+    except Exception as err:
+        mark_test_status("failed", str(err), page)
+    
+    browser.close()
+    
+    # Stop the Local instance
+    bs_local.stop()
+
+def mark_test_status(status, reason, page):
+  page.evaluate("_ => {}", "browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\":\""+ status + "\", \"reason\": \"" + reason + "\"}}");
+
+with sync_playwright() as playwright:
+  run_local_session(playwright)

playwright-python/parallel-playwright-test.py

@@ -74,8 +74,8 @@ def run_parallel_session(desired_cap):
       else:
         mark_test_status("failed", "Title did not match", page)
 
-    except Exception as error:
-      mark_test_status("failed", error, page)
+    except Exception as err:
+      mark_test_status("failed", str(err), page)
 
     browser.close()
 

playwright-python/playwright-test.py

@@ -34,7 +34,7 @@ def run_session(playwright):
     else:
       mark_test_status("failed", "Title did not match", page)
   except Exception as err:
-      mark_test_status("failed", err, page)
+      mark_test_status("failed", str(err), page)
 
   browser.close()