App AutomateGet startedIntegrate your test suite

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!

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

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

      
            macOS or Linux
          
            Windows PowerShell
          
            Windows Cmd
          
          Copy
        
```bash
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```

            Copy icon
            
        Copy
      
    export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

```bash
$env:BROWSERSTACK_USERNAME="YOUR_USERNAME"
$env:BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```

            Copy icon
            
        Copy
      
    $env:BROWSERSTACK_USERNAME="YOUR_USERNAME"
$env:BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

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

            Copy icon
            
        Copy
      
    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.

      
            macOS or Linux
          
            Windows
          
          Copy
        
```bash
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
```

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

```bash
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"
```

            Copy icon
            
        Copy
      
    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.

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

            Copy icon
            
        Copy
      
    <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.

Copy

    webdriver {
  driver = remote
  remote.url = "https://hub.browserstack.com/wd/hub"
}
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 app to be tested

The app property determines the app to be tested. You can upload an Android app (.apk or .aab file) or an iOS app (.ipa file) from your local filesystem.

Supported method	Description
path(Recommended)	SDK uploads the app using the specified relative or absolute path. Eg: `app: ./SampleApp.apk`.

Check out how to create IPA files for iOS app testing on BrowserStack.

Other acceptable app property values

Supported method	Description
app_url	Uploaded app’s `app_url` is a valid value for `app` property. Eg: `app: bs://45e1c1473b17b7643aed1761f51cb5cdf3d3e334`
custom_id	If you’ve defined a `custom_id` while uploading your app, the same value can be used as `app` property value. Eg: `app: CalculatorApp`
shareable_id	If you wish to test an app uploaded by someone else from your organization, a `shareable_id` can be used as the `app` property value. Eg: `app: exampleuser/CalculatorApp`

Select Android or iOS devices from a list of 150+ available combinations:

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

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.

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:

The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.

Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.

Do you want to enable/disable auto-marking of test status and session?

The sessionName and sessionStatus are the names of your test sessions and status of your test sessions respectively. They are automatically picked from your test class/spec names and statuses. They do not need to be set manually when using the BrowserStack SDK. To override the sessionName and sessionStatus capabilities, use the following in your browserstack.yml file:

You can configure local testing to start without initializing the BrowserStack binary, or even with an existing binary using a local identifier

testContextOptions:
    skipSessionName: true
    skipSessionStatus: true

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:

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
app: YOUR_APP_ID
platforms:
  - YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
    YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
    YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
  - YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
    YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
    YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
  - YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
    YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
    YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
YOUR_LOCAL_CAPS_TYPE: YOUR_LOCAL_CAPS
YOUR_BUILD_NAME_TYPE: YOUR_BUILD_NAME
YOUR_PROJECT_NAME_TYPE: YOUR_PROJECT_NAME
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
YOUR_NETWORK_CAPS_TYPE: YOUR_NETWORK_CAPS
YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS

```
browserstack.yml

      
      
    

        
            Copy icon
            
          
        Copy
      
    userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
app: bs://sample.app
platforms:
  - platformName: android
    deviceName: Samsung Galaxy S22 Ultra
    platformVersion: 12.0
  - platformName: android
    deviceName: Google Pixel 7 Pro
    platformVersion: 13.0
  - platformName: android
    deviceName: OnePlus 9
    platformVersion: 11.0
browserstackLocal: true
buildName: bstack-demo
projectName: BrowserStack Sample
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
networkLogs: true
consoleLogs: info

  

Use our Capability Generator to select from a comprehensive set of options you can use to customize your tests.

Run your test suite

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

To find out the location of the BrowserStack SDK log files, refer to BrowserStack SDK Log Files. If you are looking for more information, see FAQ documentation.

After you run your test, visit the Automate dashboard to view your test results.

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.

```yaml
    acceptInsecureCerts: true
```
browserstack.yml

          Copy icon
            
        Copy
      
    acceptInsecureCerts: true

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 (Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave, and High Sierra): `1024x768`, `1280x960`, `1280x1024`, `1600x1200`, `1920x1080`, `2560x1440`, `2560x1600`, and `3840x2160` OS X (All other versions): `1024x768`, `1280x960`, `1280x1024`, `1600x1200`, and `1920x1080`

resolution: 1024x768

Simulate IP geolocation

The geoLocation capability lets you test your websites across different countries.

Note that this capability is supported on the Enterprise plan only. You can contact sales to get an Enterprise plan for your account.

Capability	Description	Expected values
`geoLocation`	Set the country code you want your test to detect	A string. An ISO 2 country code `FR` for France, `CN` for China Check out the complete list of 45+ countries we support.

geoLocation: FR

Simulate network conditions

The networkProfile capability lets you test your websites under different network conditions.

Capability	Description	Expected values
`networkProfile`	Set the network profile to start the test with	A string. `2g-gprs-good`, `4g-lte-advanced-lossy` Check out the complete list of all pre-defined network profiles.

```yaml
  networkProfile: 2g-gprs-good
```
browserstack.yml

          Copy icon
            
        Copy
      
    networkProfile: 2g-gprs-good

Others

Following are a few 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:

Generate a list of capabilities that you want to use in tests
Find information about your Projects, Builds and Sessions using our REST APIs
Set up your CI/CD: Jenkins, Bamboo, TeamCity, Azure, CircleCI, BitBucket, TravisCI, GitHub Actions

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!

Set app to be tested

Other acceptable app property values

Select Android or iOS devices from a list of 150+ available combinations:

Do you want to dynamically configure platforms?

Enable BrowserStack Local

BrowserStack Reporting

Do you want to enable/disable auto-marking of test status and session?

Use additional debugging features

Update browserstack.yml file with selected capabilities

Set app to be tested

Other acceptable app property values

Select Android or iOS devices from a list of 150+ available combinations:

Do you want to dynamically configure platforms?

Enable BrowserStack Local

BrowserStack Reporting

Do you want to enable/disable auto-marking of test status and session?

Use additional debugging features

Update browserstack.yml file

Set app to be tested

Other acceptable app property values

Set platforms to test on

Select Android or iOS devices from a list of 150+ available combinations:

Do you want to dynamically configure platforms?

Enable BrowserStack Local

BrowserStack Reporting

Do you want to enable/disable auto-marking of test status and session?

Use additional debugging features

Update browserstack.yml file