add: use javascript executor to mark the session instead of API call

remove multiple api calls, use driver to execute js to mark status for better annotation on browserstack dashboard

Author: Ankit098

src/pytest_selenium/drivers/browserstack.py

@@ -50,11 +50,22 @@ def job_access(self):
 
 @pytest.mark.optionalhook
 def pytest_selenium_runtest_makereport(item, report, summary, extra):
+    if report.when in ["setup", "teardown"]:
+        return
     provider = BrowserStack()
     if not provider.uses_driver(item.config.getoption("driver")):
         return
 
     passed = report.passed or (report.failed and hasattr(report, "wasxfail"))
+    # set test failure reason if available
+    fail_reason = ""
+    if not passed:
+        try:
+            fail_reason = report.longrepr.reprcrash.message
+        except Exception as e:
+            summary.append(
+                "WARNING: Failed to determine {0} job URL: {1}".format(provider.name, e)
+            )
     session_id = item._driver.session_id
     api_url = provider.API.format(session=session_id)
 
@@ -75,22 +86,39 @@ def pytest_selenium_runtest_makereport(item, report, summary, extra):
         )
 
     try:
-        # Update the job result
+        # Update the session status
         job_status = job_info["automation_session"]["status"]
-        status = "running" if passed else "error"
-        if report.when == "teardown" and passed:
-            status = "completed"
-        if job_status not in ("error", status):
-            # Only update the result if it's not already marked as failed
-            requests.put(
-                api_url,
-                headers={"Content-Type": "application/json"},
-                params={"status": status},
-                auth=provider.auth,
-                timeout=10,
-            )
+        if job_status not in ("failed", "passed"):
+            # Only update the status if it's not already marked (by user via script)
+            if passed:
+                item._driver.execute_script(
+                    'browserstack_executor: { \
+                        "action": "setSessionStatus", \
+                        "arguments": { "status":"passed" } \
+                    }'
+                )
+            else:
+                if fail_reason:
+                    item._driver.execute_script(
+                        'browserstack_executor: {{ \
+                            "action": "setSessionStatus", \
+                            "arguments": {{ \
+                                "status":"failed", \
+                                "reason": "{}" \
+                            }} \
+                        }}'.format(
+                            fail_reason
+                        )
+                    )
+                else:
+                    item._driver.execute_script(
+                        'browserstack_executor: { \
+                            "action": "setSessionStatus", \
+                            "arguments": { "status":"failed" } \
+                        }'
+                    )
     except Exception as e:
-        summary.append("WARNING: Failed to update job status: {0}".format(e))
+        summary.append("WARNING: Failed to update session status: {0}".format(e))
 
 
 def driver_kwargs(request, test, capabilities, **kwargs):