Integrate Your Test Suite with BrowserStack

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

Select your integration method

Using the BrowserStack SDK is the recommended integration method for JUnit. 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
Connect to CDP Endpoint to run tests on BrowserStack	Via the browserstack.yml config file	Requires code changes to change the CDP Endpoint
Integrate with BrowserStack Local	Via the browserstack.yml config file	Requires code changes in test suite
Send test context to BrowserStack for reporting	Via the browserstack.yml config file	Requires additional code to be added in the test suite hooks
Use basic cross browser testing parallelization	Via the browserstack.yml config file	May require code changes depending on the test suite
Use advanced parallelization strategies	Via the browserstack.yml config file	Requires code changes to support different parallelization strategies

Prerequisites

• An existing automated test suite.
• Junit, Java v8+ is installed on your machine.
• Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to the system path, $PATH.

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

```bash # Set these values in your ~/.zprofile (zsh) or ~/.profile (bash) export BROWSERSTACK_USERNAME="YOUR_USERNAME" export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" ```

Copy

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
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

$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

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

Maven Archetype provides a template to quickly configure your project.
Run the following command your terminal/command prompt to add browserstack-java-sdk dependency and browserstack.yml file in your project.

Copy

```bash mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \ -DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.2 \ -DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.2 \ -DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY \ -DBROWSERSTACK_FRAMEWORK=junit5 ```

Copy

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.2 \
-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.2 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY \
-DBROWSERSTACK_FRAMEWORK=junit5

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

Copy

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

Update your BrowserStack config file

When you install the SDK, a browserstack.yml config file is created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Specify platforms to test on

Set the browsers/OS you want to test under the platforms object. Select over 100+ browsers-OS combinations from the list of supported browsers and OS

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.

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, video recording on every failed command, and a video of the entire test. Additionally, you can enable the following features:

Video

Enables video recording for every command ran

True

False

Console logs

Set the remote Browser’s console log levels.

Info

Disable

Verbose

Info

Warnings

Errors

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: junit platforms: - os: OS X osVersion: Ventura browserName: chrome browserVersion: latest - os: Windows osVersion: 10 browserName: playwright-firefox browserVersion: latest - os: OS X osVersion: Monterey browserName: playwright-webkit browserVersion: latest 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_DEBUG_CAPS_TYPE: YOUR_DEBUG_CAPS YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: junit
platforms:
  - os: OS X
    osVersion: Ventura
    browserName: chrome
    browserVersion: latest
  - os: Windows
    osVersion: 10
    browserName: playwright-firefox
    browserVersion: latest
  - os: OS X
    osVersion: Monterey
    browserName: playwright-webkit
    browserVersion: latest
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.
debug: true
consoleLogs: info

Run your test suite

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

```bash mvn test ```

Copy

mvn test

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.

Advanced features and use cases

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

browserstack.geoLocation: FR

Next steps

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

• Refer to the 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: Gitlab, Azure Pipelines, CircleCI, GitHub Actions, Jenkins