Skip to main content

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!

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 Java. The SDK auto-handles your integration steps.


Prerequisites

  • An existing automated test suite. Looking for a starter project? Get started with our Java sample build.
  • Java v8+, Selenium v2.5+ (JSON Wire / W3C).
  • 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

Saving your BrowserStack credentials as environment variables makes it simple 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

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

Copy & run the below command on your terminal/command prompt to add browserstack-java-sdk dependency and browserstack.yml file in your project.

Copy icon Copy snippet
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 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 class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

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

Modify exec command

Specify the .m2 repository path to browserstack-java-sdk.jar and update fully qualified name of your class file in the below command:

Copy icon Copy snippet
Copy icon Copy snippet
Additional References

How to find .m2 repository path?


Search for the browserstack-java-sdk jar in Maven Dependencies, right-click the .jar file, and then click Copy:
Eclipse IDE Configuration

Example Paths:

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

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


Search for the browserstack-java-sdk jar in External Libraries. 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.0.7/browserstack-java-sdk-1.0.7.jar

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

Run tests

Run the modified mvn exec command in your Terminal/Command Prompt to execute the tests.

Note and save the updated exec command for running tests in the future.

Set BrowserStack credentials

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

Copy icon Copy snippet
Copy icon Copy snippet

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.

Add browserstack-java-sdk as a maven dependency in your pom.xml file. Refresh the project.

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 class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

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

Create browserstack.yml file

Copy the following code snippet and create 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 Maven Dependencies, right-click the .jar file, and then click Copy:
Eclipse IDE Configuration

Example Paths:

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

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

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

In your test file, click on run icon & select run configurations:

Eclipse IDE Configuration

Click on Arguments pane & add the .m2 repository path in the VM arguments. Click Apply & then click Close:

Eclipse IDE Configuration

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

Set BrowserStack credentials

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

Copy icon Copy snippet
Copy icon Copy snippet

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.

Add browserstack-java-sdk as a maven dependency in your pom.xml file. Refresh the project.

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 class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

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

Create browserstack.yml file

Copy the following code snippet and create 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 External Libraries. 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.0.7/browserstack-java-sdk-1.0.7.jar

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

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

In your test file, click on run icon & select Modify Run Configurations:

Intellij IDEA Configuration

Click on Modify options:

Intellij IDEA Configuration

Click on Add VM options in the dropdown:

Intellij IDEA Configuration

Add the .m2 repository path. Click OK :

Intellij IDEA Configuration

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

browserstack.yml

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

Change desktop resolution

browserstack.yml

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

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

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