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.

webdriver {
  driver = remote
  remote.url = "insert your grid's framework url here"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"

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

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.

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)

Info

Info

Verbose

Debug

Warn

Error

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: 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: YOUR_GRID_NAME_TYPE: YOUR_GRID_NAME ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
  - os: Linux
    browserName: Firefox
    browserVersion: latest
parallelsPerPlatform: 1
browserstackLocal: true
buildName: bstack-demo
buildIdentifier: ${BUILD_NUMBER}
projectName: BrowserStack Sample
testObservability: true
networkLogs: true
consoleLogs: info
turboScale: true
turboScaleOptions:
    gridName: sample-gridname

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.

webdriver {
  driver = remote
  remote.url = "insert your grid's framework url here"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"

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

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.

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)

Info

Info

Verbose

Debug

Warn

Error

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: 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: YOUR_GRID_NAME_TYPE: YOUR_GRID_NAME ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
  - os: Linux
    browserName: Firefox
    browserVersion: latest
parallelsPerPlatform: 1
browserstackLocal: true
buildName: bstack-demo
buildIdentifier: ${BUILD_NUMBER}
projectName: BrowserStack Sample
testObservability: true
networkLogs: true
consoleLogs: info
turboScale: true
turboScaleOptions:
    gridName: sample-gridname

Set BrowserStack credentials

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

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

Run the following command on your terminal/command-line 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.0 \
-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY \
-DBROWSERSTACK_FRAMEWORK=serenity

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

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.

<dependency>
  <groupId>net.serenity-bdd</groupId>
  <artifactId>serenity-browserstack</artifactId>
  <version>3.3.4</version>
</dependency>

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.

webdriver {
  driver = remote
  remote.url = "insert your grid's framework url here"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"

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

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.

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

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

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 the 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: YOUR_GRID_NAME_TYPE: YOUR_GRID_NAME ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
  - os: Linux
    browserName: Firefox
    browserVersion: latest
parallelsPerPlatform: 1
browserstackLocal: true
buildName: bstack-demo
buildIdentifier: ${BUILD_NUMBER}
projectName: BrowserStack Sample
testObservability: true
networkLogs: true
consoleLogs: info
turboScale: true
turboScaleOptions:
    gridName: sample-gridname

Run your test suite

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