Selenium with Java
Your guide to running tests using Java on BrowserStack’s Selenium Grid of 3000+ real devices and desktop browsers.
Prerequisites
-
You need to have BrowserStack Username and Access key, which you can find in your account profile. If you have not created an account yet, you can sign up for a Free Trial.
-
TestNG v6.8+, Java v8+ (if using Gradle, Java v9+ is required), Selenium v2.5+ (W3C/JSON Wire).
-
If you are using CLI for running tests, ensure that Maven or Gradle are installed on your machine, its environment variables are set, and its bin is added to system path,
$PATH.
Run a sample build
Run a sample Java test build, which is based on the TestNG runner, using your preferred method on BrowserStack:
Get Sample Project
Get our sample project using one of the following options:
Option 1: Download Project
Option 3: Via Maven Archetype
Setup using Maven archetype to create a new sample project with your BrowserStack credentials pre-configured.
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey parameters in the browserstack.yml file, available in the root directory, to authenticate your tests on BrowserStack.
Select desktop browsers or real devices from a list of 3000+ available combinations:
Update the browserstack.yml config file
Copy and replace the platforms object in the browserstack.yml file.
Run sample tests on BrowserStack!
Install dependencies and run a sample test build on BrowserStack:
Clone the sample repository using Maven Archetype
Open Eclipse IDE and create a new project.
Select Maven Project and click Next:
Click Next to configure archetype.
Type com.browserstack in the filter to search for BrowserStack archetypes, select testng-archetype-setup, and then click Next:
Set a GroupId and ArtifactId for the project. Then, add the following BrowserStack Credentials to the properties and click Finish:
Ensure that you press Enter after adding your BrowserStack Credentials.
The project with relevant browserstack.yml config file and runner-specific files is generated. Your project appears in the IDE as follows:
Ensure that BrowserStack credentials are correctly updated in the browserstack.yml file before running the tests.
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey properties in the browserstack.yml file, available in the root directory, to authenticate your tests on BrowserStack.
Select desktop browsers or real devices from a list of 3000+ available combinations:
Update the browserstack.yml config file
Copy and replace the platforms object in the browserstack.yml file.
Run sample tests on BrowserStack
Right-click your pom.xml file and click Run As → Maven test:
Facing issues with TestNG Plugin?
If you encounter the following error, use these steps to resolve the issue:
- Get .m2 repository path for
browserstack-java-sdkjar.
- Pass the .m2 repository path in
arglineofmaven-surefire-pluginin yourpom.xmlfile.
- Retry running tests using TestNG Plugin.
Get Sample Project
Download Project
After downloading the sample project, unzip it in the desired location.
Import the downloaded project
Click File → Import. Expand General, select Projects from Folder or Archive, and click Next. Then, navigate to the earlier unzipped downloaded project .
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey properties in the browserstack.yml file, available in the root directory, to authenticate your tests on BrowserStack.
Select desktop browsers or real devices from a list of 3000+ available combinations:
Update the browserstack.yml config file
Copy and replace the platforms object in the browserstack.yml file.
Run sample tests on BrowserStack
Right-click your pom.xml file and click Run As → Maven test:
Facing issues with TestNG Plugin?
If you encounter the following error, use these steps to resolve the issue:
- Get .m2 repository path for
browserstack-java-sdkjar.
- Pass the .m2 repository path in
arglineofmaven-surefire-pluginin yourpom.xmlfile.
- Retry running tests using TestNG Plugin.
Clone the sample repository using Maven Archetype
Open IntelliJ IDEA and create a new project.
Under Generators, click the Maven Archetype tab and set a name for the Project. In Archetype, click Add:
Set the GroupId, ArtifactId, and Version of the Archetype using the following snippet. Click Add to save the configuration:
Add the following BrowserStack Credentials to the properties and click Create:
Ensure that you press Enter after adding your BrowserStack Credentials.
The project with relevant browserstack.yml config file and runner-specific files is generated. Your project appears in the IDE as follows:
Ensure that BrowserStack credentials are correctly updated in the browserstack.yml file before running the tests.
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey properties in the browserstack.yml file,available in the root directory, to authenticate your tests on BrowserStack.
Select desktop browsers or real devices from a list of 3000+ available combinations:
Update the browserstack.yml config file
Copy and replace the platforms object in the browserstack.yml file.
Run sample tests on BrowserStack
Run the tests using the following steps:
Click the Maven tool window on the right-hand side. If you can’t see the tool window, click View > Tool Windows > Maven to enable it:
Under Profiles, select the profiles for running tests:
Expand the Lifecycle drop-down, and then double-click test to run the tests:
Get Sample Project
Download Project
After downloading the sample project, unzip it in the desired location.
Import the downloaded project
Click File → Open. Navigate to the earlier unzipped downloaded project .
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey properties in the browserstack.yml file,available in the root directory, to authenticate your tests on BrowserStack.
Select desktop browsers or real devices from a list of 3000+ available combinations:
Update the browserstack.yml config file
Copy and replace the platforms object in the browserstack.yml file.
Run sample tests on BrowserStack
Run the tests using the following steps:
Click the Maven tool window on the right-hand side. If you can’t see the tool window, click View > Tool Windows > Maven to enable it:
Under Profiles, select the profiles for running tests:
Expand the Lifecycle drop-down, and then double-click test to run the tests:
Next steps
After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack.
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
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!
