Merge pull request #27 from browserstack/merge_sdk_to_master

Merge sdk to master

Author: yashdsaraf

.gitignore

@@ -1,2 +1,3 @@
 local.log
+env
 **.pyc

.travis.yml

@@ -4,28 +4,62 @@
 
 ![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
 
+## Prerequisite
+```
+python3 should be installed
+```
+
 ## Setup
+* Clone the repo 
+  ```
+  git clone -b sdk https://github.com/browserstack/behave-browserstack.git
+  ```
+* It is recommended to use a virtual environment to install dependencies. To create a virtual environment:
+  ```
+  python3 -m venv env
+  source env/bin/activate # on Mac/Linux
+  env\Scripts\activate # on Windows
+  ```
+* Install dependencies 
+  ```
+  pip install -r requirements.txt
+  ```
 
-* Clone the repo
-* Install dependencies `pip install -r requirements.txt`
-* Update `*.json` files inside the `config/` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
+## 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 your tests
-* To run tests, run `paver run parallel`
-* To run local tests, run `paver run local`
+## Running tests
 
- Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
+* To run sample tests:
+  - To run the sample tests in parallel across the platforms defined in the `browserstack.yml` file, run:
+    ```
+    browserstack-sdk behave features/test.feature
+    ```
+* 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 behave features/local-test.feature
+    ```
 
 ## Notes
 * 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/python#setting-os-and-browser)
-* You can export the environment variables for the Username and Access Key of your BrowserStack account
-  
-  ```
-  export BROWSERSTACK_USERNAME=<browserstack-username> &&
-  export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
-  ```
-  
+* To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/docs/automate/selenium/sdk-config-generator)
+* Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
+
 ## 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)

README.md

@@ -0,0 +1,77 @@
+# =============================
+# 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: behave
+
+# =======================================
+# 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: behave-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)

browserstack.yml

@@ -1,53 +1,13 @@
 from selenium import webdriver
-from browserstack.local import Local
-import os, json
-
-CONFIG_FILE = os.environ['CONFIG_FILE'] if 'CONFIG_FILE' in os.environ else 'config/single.json'
-TASK_ID = int(os.environ['TASK_ID']) if 'TASK_ID' in os.environ else 0
-
-with open(CONFIG_FILE) as data_file:
-    CONFIG = json.load(data_file)
-
-bs_local = None
-
-BROWSERSTACK_USERNAME = os.environ['BROWSERSTACK_USERNAME'] if 'BROWSERSTACK_USERNAME' in os.environ else CONFIG['user']
-BROWSERSTACK_ACCESS_KEY = os.environ['BROWSERSTACK_ACCESS_KEY'] if 'BROWSERSTACK_ACCESS_KEY' in os.environ else CONFIG['key']
-
-def start_local():
-    """Code to start browserstack local before start of test."""
-    global bs_local
-    bs_local = Local()
-    bs_local_args = { "key": BROWSERSTACK_ACCESS_KEY, "forcelocal": "true" }
-    bs_local.start(**bs_local_args)
-
-def stop_local():
-    """Code to stop browserstack local after end of test."""
-    global bs_local
-    if bs_local is not None:
-        bs_local.stop()
-
 
 def before_feature(context, feature):
-    desired_capabilities = CONFIG['environments'][TASK_ID]
-    for key in CONFIG["capabilities"]:
-        if key not in desired_capabilities:
-            desired_capabilities[key] = CONFIG["capabilities"][key]
-        elif key == "bstack:options":
-            desired_capabilities[key].update(CONFIG["capabilities"][key])
-    desired_capabilities['bstack:options']['source'] = 'behave:sample-master:v1.2'
-
-    if "bstack:options" in desired_capabilities and "local" in desired_capabilities["bstack:options"] and desired_capabilities["bstack:options"]["local"]:
-        start_local()
-
+    desired_capabilities = {
+        'browserName': 'chrome'
+    }
     context.browser = webdriver.Remote(
         desired_capabilities=desired_capabilities,
-        command_executor="https://%s:%[email protected]/wd/hub" % (BROWSERSTACK_USERNAME, BROWSERSTACK_ACCESS_KEY)
+        command_executor="http://localhost:4444/wd/hub"
     )
 
 def after_feature(context, feature):
-    if context.failed is True:
-        context.browser.execute_script('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"failed", "reason": "At least 1 assertion failed"}}')
-    if context.failed is not True:
-        context.browser.execute_script('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"passed", "reason": "All assertions passed"}}')
     context.browser.quit()
-    stop_local()

config/local.json

@@ -1,4 +1,4 @@
-Feature: BrowserStack Local Testing
+Feature: BStack Local Testing
     Scenario: can check tunnel working
         When visit url "http://bs-local.com:45454/"
         Then title contains "BrowserStack Local"

config/parallel.json

@@ -22,7 +22,7 @@ def step(context, selector):
     item = context.browser.find_element(By.XPATH, selector)
     item_in_cart = item.text
     assert item_in_cart == context.item_to_add
-
+    
 @then('title contains "{title}"')
 def step(context, title):
     assert title in context.browser.title