No Result Found

Integrate your test suite with BrowserStack

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

Prerequisites

  • An existing automated test suite.
  • Java v8+ (if using Gradle, Java v9+ is required), selenium v2.5+ (JSON Wire / W3C).
  • If you are using CLI to run tests, ensure that Maven or Gradle is installed on your machine, its environment variables are set, and its bin directory is added to the system path, $PATH.

SDK integration

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

Add BrowserStack SDK dependency

If you are using the Surefire plugin to run tests, the steps to integrate might change. Check out framework-specific integration steps for TestNG.

In your pom.xml file, add browserstack-java-sdk as a Maven dependency at the end of the dependencies list, within the <dependencies> element. Save the project.

pom.yml
Copy icon Copy 
<dependencies>
  ...
  ...
  ...
  <dependency>
    <groupId>com.browserstack</groupId>
    <artifactId>browserstack-java-sdk</artifactId>
    <version>LATEST</version>
  </dependency>
</dependencies>

Update your BrowserStack config file

After you have installed the SDK, a browserstack.yml configuration 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.

Set number of parallel threads per platform

The parallelsPerPlatform property determines the number of parallel threads to execute. BrowserStack’s SDK runner selects the best strategy based on the configured value.

Example 1: If you have configured 3 platforms and set parallelsPerPlatform to 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 to 15: a total of 15 (1 x 15) parallel threads will be used on BrowserStack.

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
buildIdentifier Description Generated build name on dashboard
${BUILD_NUMBER} (Default) If the 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 names

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:

Test Observability

Enables Test Observability with advanced test reporting, debugging, analytics, and insights for your test suites with the help of automatic test data collection using the SDK

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)

Use Automate Turboscale

Turboscale

Enables Turboscale

True
False

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.

browserstack.yml
Copy icon Copy 
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: testng
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

Run your test suite

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

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