Merge sdk to main

.gitignore

@@ -7,3 +7,5 @@ pabot_results/
 .pabotsuitenames
 .DS_Store
 *.png
+browserstack.err
+env

README.md

@@ -2,46 +2,60 @@
 
 ![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780) 
 
-## Setup
-* Clone the repo
-* Install dependencies `pip install -r requirements.txt`  
-
-## Set BrowserStack Credentials 
-* Export the BrowserStack username and access key as environment variables
+## Prerequisite
+```
+python3 should be installed
+```
 
-#### For Linux/MacOS
+## Setup
+* Clone the repo 
   ```
-  export BROWSERSTACK_USERNAME=<browserstack-username>
-  export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  git clone -b sdk https://github.com/browserstack/robot-browserstack.git
   ```
-#### For Windows
+* It is recommended to use a virtual environment to install dependencies. To create a virtual environment:
   ```
-  setx BROWSERSTACK_USERNAME=<browserstack-username>
-  setx BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  python3 -m venv env
+  source env/bin/activate # on Mac
+  env\Scripts\activate # on Windows
   ```
+* Install dependencies 
+  ```
+  pip install -r requirements.txt
+  ```  
+
+## Set BrowserStack Credentials
+* Add your BrowserStack username and access key in the `browserstack.yml` config fle.
+* You can also export them as environment variables, `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY`:
+
+  #### For Linux/MacOS
+    ```
+    export BROWSERSTACK_USERNAME=<browserstack-username>
+    export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+    ```
+  #### For Windows
+    ```
+    set BROWSERSTACK_USERNAME=<browserstack-username>
+    set BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+
+    setx BROWSERSTACK_USERNAME=<browserstack-username>
+    setx BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+    ```
 
 ## Running tests
 
-* To run local test, run `robot tests/LocalTest.robot`
-* To run parallel tests we will be using the [Pabot](https://pabot.org/) library: 
-  1. To run test suites in parallel (Testcases within respective test suites will be sequential)
-     * Run - `pabot --processes <count_of_parallels> tests/parallel/*.robot`
-     * Alternate method: `pabot --processes <count_of_parallels> <name_of_suites_to_run>`
-         <br/>Eg: `pabot --processes 2 tests/parallel/Suite01.robot tests/parallel/Suite02.robot`
-  2. To run all test cases within a test suite in parallel
-     * Run - `pabot --testlevelsplit <test_suite_file_name>` 
-     <br/>Eg:  `pabot --testlevelsplit tests/parallel/Suite01.robot`
-  3. Run all testcases across all Test Suites in parallel
-     * Run - `pabot --testlevelsplit --processes <count_of_parallels> tests/parallel/*.robot`
-     <br/>**Note: If the process count exceeds the parallel threads available on BrowserStack, the sessions will automatically get queued.**
+* To run sample tests:
+  - To run the sample tests in parallel across the platforms defined in the `browserstack.yml` file, run:
+    ```
+    browserstack-sdk robot ./tests/test-*.robot
+    ```
+* To run tests on locally hosted websites:
+  - To run the local test in parallel across the platforms defined in the `browserstack.yml` file, run:
+    ```
+    browserstack-sdk robot ./tests/local-test.robot
+    ```
 
 Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
 
-## Notes
-* This repository only works for Selenium 3 as of now. Desired Capabilities do not get honoured for Selenium 4. The open issue on SeleniumLibrary can be found [here](https://github.com/robotframework/SeleniumLibrary/issues/1774).
-* You can view your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate)
-* To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/automate/capabilities)
-
 ## Additional Resources
 * [Documentation for writing Automate test scripts in Python](https://www.browserstack.com/automate/python)
 * [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities)

browserstack.yml

@@ -0,0 +1,74 @@
+# =============================
+# 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}
+
+# =======================================
+# 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)
+# browserStackLocalOptions:
+# Options to be passed to BrowserStack local in-case of advanced configurations
+  # 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
+
+source: robot-browserstack:sample-sdk:v1.0
+
+# ===================
+# 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)

requirements.txt

@@ -1,5 +1,6 @@
-robotframework
-robotframework-seleniumlibrary==5.1.3
+robotframework==6.1.1
+robotframework-seleniumlibrary==6.2.0
 robotframework-pabot
 browserstack-local
-selenium==3.141.0
+selenium
+browserstack-sdk

resources/KeywordsFile.robot

@@ -0,0 +1,30 @@
+*** Settings ***
+Library    SeleniumLibrary
+
+*** Variables ***
+${remote_url}=    http://localhost:4444/wd/hub
+
+*** Keywords ***
+Open Session
+    [Arguments]    ${capabilities}    ${test_url}
+    open browser    remote_url=${remote_url}    browser=chrome    desired_capabilities=${capabilities}   url=${test_url}
+
+Close Session
+    close browser
+
+Add Implicit Wait
+    set selenium implicit wait    5
+
+Get the page title
+    get title
+
+Verify Local Page
+    Title Should be     BrowserStack Local
+
+Add first product to cart
+    click element    xpath=//*[@id="1"]/div[4]
+
+Verify product is added to cart
+    ${product_name}    get text    xpath=//*[@id="1"]/p
+    ${product_incart}    get text    css=p.title 
+    element should contain    css=p.title    ${product_name}

resources/TestCases.robot

@@ -0,0 +1,10 @@
+*** Settings ***
+Library    SeleniumLibrary
+Resource    ./KeywordsFile.robot
+
+*** Keywords ***
+Add to Cart
+    Add Implicit Wait
+    Get the page title
+    Add first product to cart
+    Verify product is added to cart