Merge pull request #5 from Rushabhshroff/main

Main

Author: Ankit098

README.md

@@ -3,26 +3,25 @@
 PyTest Integration with BrowserStack.
 
 ![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
+## Prerequisite
+* Python3
 
 ## Setup
 
 * Clone the repo
 * Install dependencies `pip install -r requirements.txt`
-* To run your automated tests using BrowserStack, you must provide a valid username and access key. This can be done either by using a .browserstack configuration file in the working directory or your home directory, or by setting the BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY environment variables.
+* To run your automated tests using BrowserStack, you must provide a valid username and access key. This can be done either by using a .browserstack configuration file in the working directory or your home directory, by setting the BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY environment variables, or by adding user & key to config file.
 
-## Running your single tests
-* To run single tests, run `paver run single`
 
-## Running your local tests
-* To run a local test, (if you have not set the BROWSERSTACK_ACCESS_KEY environment variable) first go to conftest.py then edit access_key on line 10
+## Run tests on locally hosted websites
+* To run a local test, (if you have not set the BROWSERSTACK_ACCESS_KEY environment variable) first go to config/local.json then edit key on line 3
 * Run `paver run local`
 
-## Running your parallel tests
-* To run parallel tests, run `paver run parallel`
+## Run sample tests
+* To run parallel tests, run `paver run sample`
 
  Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
 
 ## 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)
-

config/local.json

@@ -1,22 +1,24 @@
 {
-  "capabilities": {
-      "bstack:options": {
-          "projectName": "Pytest Browserstack",
-          "buildName": "browserstack-build-1",
-          "sessionName": "local_test",
-          "local": true,
-          "debug" : "true",
-          "networkLogs": "true"
-      }
-  },
-  "environments": [
-      {
-          "bstack:options": {
-              "os": "Windows",
-              "osVersion": "11"
-          },
-          "browserName": "chrome",
-          "browserVersion": "latest"
-      }
-  ]
+    "user": "BROWSERSTACK_USERNAME",
+    "key": "BROWSERSTACK_ACCESS_KEY",
+    "capabilities": {
+        "bstack:options": {
+            "projectName": "Pytest Browserstack",
+            "buildName": "browserstack-build-1",
+            "sessionName": "Bstack Local Test",
+            "local": true,
+            "debug": "true",
+            "networkLogs": "true"
+        }
+    },
+    "environments": [
+        {
+            "bstack:options": {
+                "os": "Windows",
+                "osVersion": "11"
+            },
+            "browserName": "chrome",
+            "browserVersion": "latest"
+        }
+    ]
 }

config/parallel.json renamed to config/sample.json

@@ -1,11 +1,13 @@
 {
+    "user": "BROWSERSTACK_USERNAME",
+    "key": "BROWSERSTACK_ACCESS_KEY",
     "capabilities": {
         "bstack:options": {
             "projectName": "Pytest Browserstack",
             "buildName": "browserstack-build-1",
-            "sessionName": "parallel_test",
+            "sessionName": "BStack pytest sample",
             "local": false,
-            "debug" : "true",
+            "debug": "true",
             "networkLogs": "true"
         }
     },
@@ -20,16 +22,16 @@
         },
         {
             "bstack:options": {
-                "os" : "OS X",
-                "osVersion" : "Monterey"
+                "os": "OS X",
+                "osVersion": "Monterey"
             },
             "browserName": "firefox",
             "browserVersion": "latest"
         },
         {
             "bstack:options": {
-                "osVersion" : "10.0",
-                "deviceName" : "Samsung Galaxy S20"
+                "osVersion": "10.0",
+                "deviceName": "Samsung Galaxy S20"
             }
         }
     ]

config/single.json

@@ -10,7 +10,8 @@
 
 bs_local = None
 
-BROWSERSTACK_ACCESS_KEY = os.environ['BROWSERSTACK_ACCESS_KEY'] if 'BROWSERSTACK_ACCESS_KEY' in os.environ else 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."""
@@ -27,10 +28,12 @@ def stop_local():
 
 @pytest.fixture(scope='session')
 def session_capabilities():
-  desired_capabilities = merge(CONFIG['environments'][TASK_ID],CONFIG["capabilities"])
-  if "local" in desired_capabilities['bstack:options'] and desired_capabilities['bstack:options']['local']:
+  capabilities = merge(CONFIG['environments'][TASK_ID],CONFIG["capabilities"])
+  capabilities['bstack:options']['userName'] = BROWSERSTACK_USERNAME
+  capabilities['bstack:options']['accessKey'] = BROWSERSTACK_ACCESS_KEY
+  if "local" in capabilities['bstack:options'] and capabilities['bstack:options']['local']:
     start_local()
-  return desired_capabilities
+  return capabilities
 
 
 def pytest_sessionfinish(session, exitstatus):

conftest.py

@@ -35,10 +35,3 @@ def run(args):
         p = Process(target=run_py_test, args=(args[0], i))
         jobs.append(p)
         p.start()
-
-@task
-def test():
-    """Run all tests"""
-    sh("paver run single")
-    sh("paver run local")
-    sh("paver run parallel")

pavement.py

@@ -2,7 +2,7 @@ browserstack-local
 jsonmerge
 multiprocess
 paver
-selenium
+selenium==4.*
 psutil
 pytest
 pytest-variables