Skip to main content

Integrate Your Test Suite with BrowserStack

BrowserStack’s Serenity SDK supports a plug-and-play integration. Run your entire test suite in parallel with a few steps!

Select your integration method

  • Automatic (Browserstack SDK)
    Plug-n-play solution that takes care of all the integration steps for you
  • Manual integration
    Perform the integration steps yourself. Useful for custom frameworks and advanced use-cases

Using the BrowserStack SDK is the recommended integration method for Serenity. The SDK auto-handles your integration steps.

Learn the benefits of using BrowserStack SDK

Following are the benefits of using BrowserStack SDK against manual integration process:

Integration step With BrowserStack SDK With manual integration
Perform Webdriver changes to run tests on BrowserStack Yes Via the browserstack.yml config file Changes Requires code changes to change the RemoteWebdriver
Integrate with BrowserStack Local Yes Via the browserstack.yml config file Changes Requires code changes in test suite
Send test context to BrowserStack for reporting Changes Requires code changes in test suite Changes Requires additional code to be added in the test suite hooks
Use basic cross browser testing parallelization Yes Via the browserstack.yml config file Changes May require code changes depending on the test suite
Use advanced parallelization strategies ChangesRequires code changes to support different parallelisation strategies Changes Requires code changes to support different parallelization strategies

Prerequisites

  • An existing automated test suite.
  • Serenity v2+, Java v8+, Selenium v2.5+ (W3C/JSON Wire).
  • If you are using CLI for running tests, ensure that Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to the system path, $PATH.

Looking for a starter project? Get started with our Serenity sample project.

Integration Steps

Based on the method you use to build your project, complete the steps in the following tabs to integrate with BrowserStack.

Set BrowserStack credentials

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

Copy icon Copy snippet
Copy icon Copy snippet

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.

Copy icon Copy snippet
Copy icon Copy snippet

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.

pom.xml
Copy icon Copy snippet

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.

serenity.conf
Copy icon Copy snippet

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.

Parallel thread #1
Parallel thread #2
Parallel thread #3

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, need to be set. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

Organizing your test suite

Our projectName and buildName capabilities help with organizing your tests on BrowserStack’s Dashboard.

sessionName is the name of your test sessions and is automatically picked from your test spec name via the Serenity BrowserStack plugin.

Build Name
Project Name

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

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.

browserstack.yml
Copy icon Copy snippet

Run your test suite

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

Copy icon Copy snippet

Set BrowserStack credentials

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

Copy icon Copy snippet
Copy icon Copy snippet

Add BrowserStack SDK and Serenity dependencies

Add browserstack-java-sdk and serenity-browserstack as Maven dependencies in your pom.xml file and save the file.

These dependencies add BrowserStack SDK and Serenity BrowserStack plugin to your project.

pom.xml
Copy icon Copy snippet

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.

serenity.conf
Copy icon Copy snippet

Modify your build plugins

Add the following build plugin

Add maven-dependency-plugin as a plugin under your <build> element to resolve dependencies.

Add BrowserStack SDK as an argline property

Add the following java agent <argLine> in your <build> element. This step invokes our SDK when your build is triggered.

-javaagent:${com.browserstack:browserstack-java-sdk:jar}

pom.xml
Copy icon Copy snippet

Create your BrowserStack config file

After installing 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 to test on

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

Parallel thread #1
Parallel thread #2
Parallel thread #3

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, need to be set. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

Organizing your test suite

Our projectName, buildName, and sessionName capabilities help with organizing your tests on BrowserStack’s Dashboard.

sessionName is the name of your test sessions and is automatically picked from your test spec name via the Serenity BrowserStack plugin.

Build Name
Project Name

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

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.

browserstack.yml
Copy icon Copy snippet

Run your test suite

Go to pom.xml, right click on it and click Run AsMaven install:
Eclipse IDE Configuration

Facing issues when running test?

If the test doesn’t run in parallel on multiple browsers/devices, or the tests don’t run as per capabilities specified in the browserstack.yml file, complete the following steps to resolve it:

  1. Get .m2 repository path for browserstack-java-sdk jar .m2 repository path
  2. Right-click the test file and select Run as -> Run Configurations. .m2 repository path
  3. Click the Arguments tab, add the .m2 repository path in the VM arguments input field, and click Apply -> Run. Modify argline

Set BrowserStack credentials

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

Copy icon Copy snippet
Copy icon Copy snippet

Add BrowserStack SDK and Serenity dependencies

Add browserstack-java-sdk and serenity-browserstack as Maven dependencies in your pom.xml file and save the file.

These dependencies add BrowserStack SDK and Serenity BrowserStack plugin to your project.

pom.xml
Copy icon Copy snippet

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.

serenity.conf
Copy icon Copy snippet

Create your BrowserStack config file

After installing the SDK, create a browserstack.yml config file 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.

Parallel thread #1
Parallel thread #2
Parallel thread #3

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, need to be set. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

Organizing your test suite

Our projectName, buildName, and sessionName capabilities help with organizing your tests on BrowserStack’s Dashboard.

sessionName is the name of your test sessions and is automatically picked from your test spec name via the Serenity BrowserStack plugin.

Build Name
Project Name

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

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.

browserstack.yml
Copy icon Copy snippet

Run your test suite

Get browserstack-java-sdk .m2 repository path

Search for the browserstack-java-sdk jar in the External Libraries drop-down. Right-click the .jar file, select Copy Path/References, and then copy the absolute path:
Intellij IDEA Configuration

Example Paths:

Mac or Linux: /Users/User_Name/.m2/repository/com/browserstack/browserstack-java-sdk/1.1.0/browserstack-java-sdk-1.1.0.jar

Windows: C:\Users\User_Name\.m2\repository\com\browserstack\browserstack-java-sdk\1.1.0\browserstack-java-sdk-1.1.0.jar

Add browserstack-java-sdk .m2 repository path in VM arguments

In your test file, click the run icon and select Modify Run Configurations:

Intellij IDEA Configuration

In the Edit Run Condiguration window, click Modify options.

Intellij Modify Options

Ensure that the Add VM options option is selected.

Intellij Modify Options

Edit the VM options to specify -javaagent with browserstack-java-sdk JAR path and click Apply

Intellij Modify Options

After successful completion of the above steps, you can now run your test suite using BrowserStack.

Advanced features and use cases

Here’s a list of features and capabilities you may find useful.

Accept insecure certificates

The acceptInsecureCerts capability suppresses browser popups warning about self-signed certificates usually found in staging environments.

Capability Expected values
acceptInsecureCerts A boolean. Default is False.
True if you want to accept all SSL certificates.
browserstack.yml

Change desktop resolution

The resolution capability changes the default desktop screen resolution for your tests on BrowserStack.

Capability Description Expected values
resolution Set the resolution of your VM before beginning your test A string. Default resolution is 1024x768

Supported resolutions:
Windows (XP, 7): 800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080 and 2048x1536

Windows (8, 8.1, 10): 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080 and 2048x1536

OS X (Monterey,Big Sur,Catalina,Mojave,High Sierra): 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080, 2560x1440, 2560x1600 and 3840x2160

OS X (All other versions): 1024x768, 1280x960, 1280x1024, 1600x1200 and 1920x1080
browserstack.yml

Others

Below are few of the additional links to documentation pages that might help with your test scenarios:

Next steps

Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:

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

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