No Result Found

Integrate your test suite with BrowserStack

Prerequisites

  • An existing automated test suite.
  • Pytest V5+, Python3 and Pip3 is installed on your machine.

Integration steps

Complete the following steps to integrate your Pytest test suite using BrowserStack SDK.

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it simple to run your test suite from your local or CI environment.

Copy
Copy icon Copy
Copy icon Copy
Copy icon Copy

Enable BrowserStack Local

Test localhost/internal servers in your network

True
False
Test localhost/staging websites that are not publicly accessible

BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL

Learn more

If your staging environment is behind a proxy or firewall, additional arguments, such as proxy username, proxy password, etc, must be set. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

Install BrowserStack Pytest SDK

Execute the following commands to install BrowserStack pytest SDK for plug-and-play integration of your test suite with BrowserStack.

Copy 
python3 -m pip install browserstack-sdk
browserstack-sdk setup --framework "pytest" --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"

python3 -m pip install browserstack-sdk
browserstack-sdk setup --framework "pytest" --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"

Unable to install BrowserStack SDK?

If you cannot install BrowserStack SDK due to sudo privilege issues, create a virtual environment and execute the adjacent installation commands again.

Linux:
python3 -m venv env
source env/bin/activate

Windows
python3 -m venv env
env\Scripts\activate

Create your BrowserStack config file

Once you have installed the SDK, create a browserstack.yml config file at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Set platforms on which to test

Set the browsers/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.

Platform Browser
Linux Firefox
Linux Chrome
Linux Edge

Do you want to dynamically configure platforms?

To dynamically configure platforms across different tests, you can comment out the platforms capability while still passing platform-specific capabilities.

BrowserStack Reporting

You can leverage BrowserStack’s extensive reporting features using the following capabilities:

Build Name

Set a name to your build (usually the same as the build ID that’s on your CI/CD platform).
Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ', _. All other characters are ignored.
Character limit: 255
Build Identifier

Select a dynamic build identifier that appends to the build name and generates a unique name on the BrowserStack dashboard
buildIdentifier Description Generated build name on BrowserStack dashboard
${BUILD_NUMBER} (Default) If build is triggered locally, an incremental counter is appended.

If build is triggered with CI tools, CI generated build number is appended.		 bstack-demo 1


bstack-demo CI 1395
${DATE_TIME} The timestamp of run time is appended to the build. bstack-demo 29-Nov-20:44

Advanced use cases for Build Names

Custom formatting of Build Name

Prefix buildIdentifier with desired characters, for example # or :

buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'

Re-run tests in a build

You can re-run selected tests from a build using any of the following options:

Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:

MacOS/Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” browserstack-sdk

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; browserstack-sdk

Windows cmd:

set BROWSERSTACK_BUILD_NAME=“bstack-demo 123” && browserstack-sdk


Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:

buildName: bstack-demo 123
buildIdentifier: null


Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:

buildName: bstack-demo
buildIdentifier: 123


Project Name

Set a project name for your project

Use additional debugging features

BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.

Test Observability

Enables Test Observability, an advanced test reporting and debugging tool that helps you analyze test failures much faster. If enabled, Test Observability collects test data using the SDK. This capability is enabled (set to true) by default.

True
False
Visual logs

Enables screenshots for every selenium command ran

True
False
Video logs

Enables accurate video recording of execution

True
False
Network logs

Enables network capture for the session in HAR format. Reduces session performance slightly

True
False
Console logs

Set the remote Browser’s console log levels. Currently supported only on Chrome browsers (Desktop and Android)

Use Automate Turboscale

Turboscale

Enables Turboscale

True
False
Grid Name

Set grid name as the name of the Turboscale grid. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255

Create browserstack.yml file

Copy the following code snippet and create browserstack.yml file in the root folder of your test suite.

browserstack.yml
Copy icon Copy

Run your test suite

Prepend browserstack-sdk before your existing run commands to execute your tests on BrowserStack using the Pytest SDK.

Before
pytest <path-to-test-files>

After
browserstack-sdk pytest <path-to-test-files>


We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

  • ON THIS PAGE

    Is this page helping you?

    Yes
    No

    We're sorry to hear that. Please share your feedback so we can do better

    Contact our Support team for immediate help while we work on improving our docs.

    We're continuously improving our docs. We'd love to know what you liked





    Thank you for your valuable feedback!

    Talk to an Expert
    Download Copy Check Circle