feature request(browserstack): support BrowserStack SDK integration method

[Kristinita]

1. Summary

It would be nice if SeleniumBase will support BrowserStack SDK with a new BrowserStack configuration file browserstack.yml.

2. Legacy method

Currently, SeleniumBase solely supports the old, “legacy” BrowserStack integration method.

If I run my tests, use a command like this:

pytest tests/test_kira_example.py --browser=remote --server=BROWSERSTACK_USERNAME:BROWSERSTACK_KEY@hub.browserstack.com --demo --reuse-session --port=80 --cap_file=kira_capabilities.py 

Tests run successfully on BrowserStack.

(One problem — when all tests are completed, the remote BrowserStack session continues. I need to set timeout duration in BrowserStack settings or write code like driver.quit() especially for BrowserStack. I didn’t find in SeleniumBase an option like --close-remote-session-after-all-tests.)

3. BrowserStack SDK

The BrowserStack SDK is a new BrowserStack solution that allows to run tests without having to write code for BrowserStack.

If we click on the link to BrowserStack capabilities in the SeleniumBase documentation, we see that BrowserStack offers by default the BrowserStack SDK, not Legacy integration method.

Currently, if I try to create a BrowserStack session with the browserstack.yml file, SeleniumBase shows an error:

- --cap_file=kira_capabilities.py
+ --cap_file=browserstack.yml

C:\Python312\Lib\site-packages\seleniumbase\core\browser_launcher.py:1722: in get_remote_driver
    desired_caps = capabilities_parser.get_desired_capabilities(cap_file)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

cap_file = 'browserstack.yml'

    def get_desired_capabilities(cap_file):
        if cap_file.endswith(".py"):
            capabilities = _parse_py_file(cap_file)
        elif cap_file.endswith(".json"):
            capabilities = _parse_json_file(cap_file)
        else:
>           raise Exception("\n\n`%s` is not a Python or JSON file!\n" % cap_file)
E           Exception:
E
E           `browserstack.yml` is not a Python or JSON file!

Thanks.

[mdmintz]

This was resolved in 4.22.4 - https://github.com/seleniumbase/SeleniumBase/releases/tag/v4.22.4
See #2403 for more details.
Happy New Year!

[Kristinita]

Status: Not fixed ❌

1. Summary

The method described in the SeleniumBase 4.22.4 documentation doesn’t work for me. Possibly, integration of SeleniumBase and the BrowserStack SDK may be required, similar to described in the BrowserStack Automate documentation for Selenium.

But if SeleniumBase is already successfully working with BrowserStack SDK, please add a correct MCVE to the documentation.

2. My MCVE

2.1. Files

2.1.1. tests/test_kira_example.py

from seleniumbase import BaseCase
BaseCase.main(__name__, __file__)


class KiraExampleTest(BaseCase):

    def test_kira_example_function(self):
        self.open("https://example.com/")
        self.assert_exact_text("Example Domain", "h1")

2.1.2. browserstack.yml

platforms:
  - browserName: Safari
    os: OS X
    osVersion: Sonoma
    browserVersion: 17.0
buildIdentifier: ${BUILD_NUMBER}
parallelsPerPlatform: 1
buildName: Kira example build
browserstackLocal: true
browserStackLocalOptions:
  forceLocal: true
debug: true
networkLogs: true
idleTimeout: 20

2.2. Commands

BrowserStackLocal --key BROWSERSTACK_KEY

In parallel in another tab:

pytest tests/test_kira_example.py --browser=remote --server=BROWSERSTACK_USERNAME:BROWSERSTACK_KEY@hub.browserstack.com  --port=80 --demo --cap_file=browserstack.yml

3. Behavior

3.1. Non-Expected — BrowserStack SDK

BrowserStack build with SDK capabilities:

1. The platform key value specifies a Safari in macOS Sonoma, but the test runs on Windows 10 Chrome 120.
2. Local Testing — off, despite that browserstackLocal: true.

3.2. Expected — BrowserStack Legacy

- --cap_file=browserstack.yml
+ --cap_file=kira_capabilities.py

BrowserStack build with Legacy capabilities:

4. Testing environment

1. Windows 11 [Version 10.0.22621.2861]
2. BrowserStackLocal v8.9
3. Python 3.12.0
4. Pytest 7.4.4
5. SeleniumBase 4.22.4

Thanks.

[mdmintz]

This was resolved in 4.22.5 - https://github.com/seleniumbase/SeleniumBase/releases/tag/v4.22.5

To activate, include "browserstack" or "bstack" in your YAML file to set "bstack:options".
(Not case-sensitive.)

This is how it was done: 50f8a03