Selenium with Serenity
Your guide to running tests using Serenity 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.
-
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
Option 3: Via Maven Archetype
Setup using Maven archetype to create a new sample project with your BrowserStack credentials pre-configured.
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.
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:
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 .
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.
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 install:
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:
- Get .m2 repository path for
browserstack-java-sdkjar.
- Right-click the test file and select Run as > Run Configurations.
- Click the Arguments tab, add the .m2 repository path in the VM arguments input field, and click Apply > Run.
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 .
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.
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 verify 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!
