Skip to main content
No Result Found

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.

Copy icon Copy
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
Copy icon Copy
$env:BROWSERSTACK_USERNAME="YOUR_USERNAME"
$env: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.

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=cucumber
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="cucumber"

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.

App

Set the path to your app. Or, if you have already uploaded your app, provide one of the other acceptable app property values here

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:

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

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.

Set number of parallel threads per platform

The parallelsPerPlatform property determines the number of parallel threads to be executed. BrowserStack’s SDK runner will select the best strategy based on the configured value.

Example 1: If you have configured 3 platforms and set parallelsPerPlatform as 2: a total of 6 (3 x 2) parallel threads will be used on BrowserStack.

Example 2: If you have configured 1 platform and set parallelsPerPlatform as 15: a total of 15 (1 x 15) parallel threads will be used on BrowserStack.

Do you want to perform cross-browser testing without test level parallelization?

Remove the parallelsPerPlatform capability from the configuration file.

Do you want to test parallelization without performing cross-browser testing?

Remove or comment out the platform capability while keeping the parallelsPerPlatform capability intact in the configuration file.

Do you want to skip cross-browser testing as well as parallelization?

Remove or comment out the platform and parallelsPerPlatform capabilities from the configuration file.

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


Project Name

Set a project name for your project.

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:

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
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: "cucumber-testng"
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.
browserstack.yml
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
browserstack.yml
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.
browserstack.yml
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.
browserstack.yml
networkProfile: 2g-gprs-good

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