Integrate Your Test Suite with BrowserStack

Install BrowserStack Plugin

Configure your test suite with BrowserStack SDK

BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.

Framework: serenity
BrowserStack User Name: YOUR_USERNAME
BrowserStack Access Key: YOUR_ACCESS_KEY

Set up serenity.conf file

Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.

Update your BrowserStack config file

Update your 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 to test on

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

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

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 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 name

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:

Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” mvn test -P sample-test

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; mvn test -P sample-test

Windows cmd:

set BROWSERSTACK_BUILD_NAME=“bstack-demo 123” && 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

By default, BrowserStack provides prettified session logs, screenshots on every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every selenium command ran

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

Disable

Verbose

Info

Warnings

Errors

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

Update browserstack.yml file

Copy the given 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: JUnit5 platforms: - os: Linux browserName: Firefox browserVersion: latest parallelsPerPlatform: 1 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_TEST_OBSERVABILITY_CAPS_TYPE: YOUR_TEST_OBSERVABILITY_CAPS YOUR_NETWORK_CAPS_TYPE: YOUR_NETWORK_CAPS YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS YOUR_TURBOSCALE_CAPS_TYPE: YOUR_TURBOSCALE_CAPS turboScaleOptions: gridName: sample-gridname ```

browserstack.yml

Copy

Install BrowserStack Plugin

Configure your test suite with BrowserStack SDK

BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.

Framework: serenity
BrowserStack User Name: YOUR_USERNAME
BrowserStack Access Key: YOUR_ACCESS_KEY

Set up serenity.conf file

Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.

Update your BrowserStack config file

Update your 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 to test on

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

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

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 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 name

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:

Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” mvn test -P sample-test

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; mvn test -P sample-test

Windows cmd:

set BROWSERSTACK_BUILD_NAME=“bstack-demo 123” && 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

By default, BrowserStack provides prettified session logs, screenshots on every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every selenium command ran

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

Disable

Verbose

Info

Warnings

Errors

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

Update browserstack.yml file

Copy the given 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: JUnit5 platforms: - os: Linux browserName: Firefox browserVersion: latest parallelsPerPlatform: 1 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_TEST_OBSERVABILITY_CAPS_TYPE: YOUR_TEST_OBSERVABILITY_CAPS YOUR_NETWORK_CAPS_TYPE: YOUR_NETWORK_CAPS YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS YOUR_TURBOSCALE_CAPS_TYPE: YOUR_TURBOSCALE_CAPS turboScaleOptions: gridName: sample-gridname ```

browserstack.yml

Copy

Set BrowserStack credentials

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

Install BrowserStack SDK using Maven Archetype

Run the following command on your terminal/command-line to add browserstack-java-sdk dependency and browserstack.yml file in your project.

Add serenity-browserstack dependency in pom.xml

Add serenity-browserstack as Maven dependency in your pom.xml file and save the file.

This dependency adds the Serenity BrowserStack plugin to your project.

Set up serenity.conf file

Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.

Update your BrowserStack config file

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

Set platforms to test on

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

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

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 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 name

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:

Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” mvn test -P sample-test

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; mvn test -P sample-test

Windows cmd:

set BROWSERSTACK_BUILD_NAME=“bstack-demo 123” && 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

By default, BrowserStack provides prettified session logs, screenshots on every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every selenium command ran

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

Disable

Verbose

Info

Warnings

Errors

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

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: Serenity platforms: - os: Linux browserName: Firefox browserVersion: latest parallelsPerPlatform: 1 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_TEST_OBSERVABILITY_CAPS_TYPE: YOUR_TEST_OBSERVABILITY_CAPS YOUR_NETWORK_CAPS_TYPE: YOUR_NETWORK_CAPS YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS YOUR_TURBOSCALE_CAPS_TYPE: YOUR_TURBOSCALE_CAPS turboScaleOptions: gridName: sample-gridname ```

browserstack.yml

Copy

Run your test suite

You can continue running your tests as you have been previously.