Integrate your test suite with BrowserStack

Set BrowserStack credentials

Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment.

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

$env: BROWSERSTACK_USERNAME "YOUR_USERNAME"
$env: BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"

setx BROWSERSTACK_USERNAME "YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Install BrowserStack SDK using Maven Archetype

Maven Archetype provides a template to quickly configure your project.
Run the following command your terminal/command prompt to add browserstack-java-sdk dependency and browserstack.yml file in your project.

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.2 \
-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.2 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY \
-DBROWSERSTACK_FRAMEWORK=junit5

mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.2" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.2" -DBROWSERSTACK_USERNAME="YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_FRAMEWORK="junit5"

Update your BrowserStack config file

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

Specify platforms to test on

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

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

BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.

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

${BUILD_NUMBER}

${BUILD_NUMBER}

${DATE_TIME}

buildIdentifier	Description	Generated build name on dashboard
${BUILD_NUMBER} (Default)	If the 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:

BROWSERSTACK_BUILD_NAME=bstack-demo 1234 mvn test -P sample-test

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.

sessionName is the name of your test sessions and is automatically picked from your test class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

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 recordings 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)

Info

Info

Verbose

Debug

Warn

Error

Use Automate Turboscale

Turboscale

Enables Turboscale

True

False

Update browserstack.yml file with selected capabilities

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

```yml userName: YOUR_USERNAME accessKey: YOUR_ACCESS_KEY framework: junit platforms: - os: Linux browserName: playwright-firefox browserVersion: latest YOUR_LOCAL_CAPS_TYPE: YOUR_LOCAL_CAPS YOUR_BUILD_NAME_TYPE: YOUR_BUILD_NAME YOUR_BUILD_IDENTIFIER_KEY: YOUR_BUILD_IDENTIFIER_TYPE YOUR_PROJECT_NAME_TYPE: YOUR_PROJECT_NAME YOUR_DEBUG_CAPS_TYPE: YOUR_DEBUG_CAPS` YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS turboScale: YOUR_TURBOSCALE_CAPS ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: junit
platforms:
  - os: Linux
    browserName: playwright-firefox
    browserVersion: latest
browserstackLocal: true
buildName: bstack-demo
buildIdentifier: ${BUILD_NUMBER}
projectName: BrowserStack Sample
debug: true`
consoleLogs: info
turboScale: true

Run your test suite

Run the following command from your root directory to run your test suite with BrowserStack.

mvn test

Set OS-browser combination to run test

We recommend running your build using a single browser like Chrome or Firefox to begin with. This will isolate issues during the migration phase and help with faster debugging. Once you have migrated your test cases or have achieved stability with Chrome or Firefox, you can set up cross-browser testing.

//Add the following options to your test script
 "environments": [
    {
      "os": "Windows",
      "browser": "chrome",
      "browser_version": "latest"
    },
    {
      "os": "Linux",
      "browser": "playwright-webkit",
      "browser_version": "latest"
    },
    {
      "os": "Linux",
      "browser": "playwright-firefox",
      "browser_version": "latest"
    }
  ]

Organize tests

Use the following capabilities to name your tests and builds. This ensures effective debugging, test reporting, and build execution time analysis.

"capabilities": {
    "project": "BStack Project",
    "build": "browserstack-build-1",
    "buildTag": "Regression",
  },

Mark test as passed or failed

To mark whether your test has passed or failed on BrowserStack, use the JavaScript executor in your test script. You can mark a test as passed or failed based on your test assertions.

The arguments passed in the JavaScript method for setting the status and the corresponding reason of the test are status and reason.

• status accepts either passed or failed as the value
• reason accepts a string value

JavascriptExecutor jse = (JavascriptExecutor)driver;
// set test status as pass
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"passed\", \"reason\": \"Title matched!\"}}");
// set test status as fail
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"failed\", \"reason\": \"Title not matched\"}}");

Set up debugging capabilities

Use the following common debugging capabilities for your tests:

1. Set the the browserstack.debug capability to record video of the entire test execution.
2. Console Logs with log level ‘errors’ are enabled by default. Set the browserstack.console capability to enable different log levels, such as warnings, info, verbose, errors, and disable.

"capabilities": {
    "browserstack.debug": "true",
    "browserstack.console": "info"
  },