Skip to main content
Get Automate insights in Microsoft Teams with our new integration! Get Started!.

Selenium with Serenity

Your guide to running tests using Serenity on BrowserStack’s Selenium Grid of 3000+ real devices and desktop browsers.

Run tests on 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.

  • 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 system path, $PATH.

Run a sample build

Run a sample Serenity test build, which is based on the JUnit runner, using your preferred method on BrowserStack:

Get Sample Project

Get our sample project using one of the following options:

Option 1: Download Project

Download ZIP

Option 2: Via Git

Clone our sample Git repository using the commands.

Copy icon Copy snippet

Option 3: Via Maven Archetype

Setup using Maven archetype to create a new sample project with your BrowserStack credentials pre-configured.

Copy icon Copy snippet
Copy icon Copy snippet

Update your serenity.conf file

Since our sample project uses the Serenity BrowserStack plugin, set your BrowserStack credentials in the serenity.conf file, available in the src/test/resources directory.

Note: If you have downloaded project using Maven archetype, skip this step.

serenity.conf
Copy icon Copy snippet

Configure your browserstack.yml config file

The browerstack.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:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack!

Install dependencies and run a sample test build on BrowserStack:

Terminal
Copy icon Copy snippet

Get Sample Project

Download Project

Download ZIP

After downloading the sample project, unzip it in the desired location.

Import the downloaded project

Click FileImport. Expand General, select Projects from Folder or Archive, and click Next. Then, navigate to the earlier unzipped downloaded project. Eclipse IDE Configuration

Update your serenity.conf file

Since our sample project uses the Serenity BrowserStack plugin, set your BrowserStack credentials in the serenity.conf file, available in the src/test/resources directory.

serenity.conf
Copy icon Copy snippet

Configure your browserstack.yml config file

The browerstack.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:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file.

browserstack.yml
Copy icon Copy snippet

Run sample tests on BrowserStack

Right-click your pom.xml file and click Run AsMaven install:

Eclipse IDE Configuration

Facing issues when running test?

If the test doesn’t run in parallel on multiple browsers/devices, or the tests don’t run as per capabilities specified in the browserstack.yml file, complete the following steps to resolve it:

  1. Get .m2 repository path for browserstack-java-sdk jar. .m2 repository path
  2. Right-click the test file and select Run as -> Run Configurations. click run configurations
  3. Click the Arguments tab, add the .m2 repository path in the VM arguments input field, and click Apply -> Run. Modify argline

Get Sample Project

Download Project

Download ZIP

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 and click Open.

Update your serenity.conf file

Since our sample project uses the Serenity BrowserStack plugin, set your BrowserStack credentials in the serenity.conf file, available in the src/test/resources directory.

serenity.conf
Copy icon Copy snippet

Configure your browserstack.yml config file

The browerstack.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:

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

Update the browserstack.yml config file

Copy and replace the platforms object in the browserstack.yml file.

browserstack.yml
Copy icon Copy snippet

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:

Eclipse IDE Configuration

Under Profiles, select the profiles for running tests:

Eclipse IDE Configuration

Expand the Lifecycle drop-down, and then double-click verify to run the tests:

Eclipse IDE Configuration

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






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