Integrate your test suite with BrowserStack
BrowserStack’s Serenity SDK supports a plug-and-play integration. Run your entire test suite in parallel with a few steps!
Prerequisites
- An existing automated test suite.
- 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 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.
Install BrowserStack Plugin
On the Eclipse toolbar, click Help > Eclipse Marketplace.
In the Eclipse Marketplace, search for BrowserStack > click Install > Finish.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, Framework, and other BrowserStack Parameters, and then click Integrate.
Framework: serenity
BrowserStack User Name: YOUR_USERNAME
BrowserStack Access Key: YOUR_ACCESS_KEY
Set up serenity.conf file
Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.
- Use the Framework URL from Automation Console > click your Grid > Framework URLs.
- Avoid hardcoding generic URLs like
hub.browserstack.comin the config file. The Framework URL contains a unique Grid identifier for correct routing.
Update your BrowserStack config file
Update your 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 on which to test
Set the browsers/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.
| Platform | Browser |
|---|---|
| Linux | Firefox |
| Linux | Chrome |
| Linux | Edge |
Enable BrowserStack Local
Test localhost/internal servers in your network
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
Use additional debugging features
BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.
Use Automate Turboscale
Set grid name as the name of the Turboscale grid. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255
Update browserstack.yml file
Copy the given code snippet and replace contents of browserstack.yml file in the root folder of your test suite.
Run your test suite
You can continue running your tests as you have been previously.
Install BrowserStack Plugin
Click IntelliJ IDEA > Preferences > Plugins.
Search for BrowserStack and click Install.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, add Framework and other BrowserStack Parameters then click OK.
Framework: serenity
BrowserStack User Name: YOUR_USERNAME
BrowserStack Access Key: YOUR_ACCESS_KEY
Set up serenity.conf file
Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.
- Use the Framework URL from Automation Console > click your Grid > Framework URLs.
- Avoid hardcoding generic URLs like
hub.browserstack.comin the config file. The Framework URL contains a unique Grid identifier for correct routing.
Update your BrowserStack config file
Update your 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 on which to test
Set the browsers/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.
| Platform | Browser |
|---|---|
| Linux | Firefox |
| Linux | Chrome |
| Linux | Edge |
Enable BrowserStack Local
Test localhost/internal servers in your network
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
Use additional debugging features
BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.
Use Automate Turboscale
Set grid name as the name of the Turboscale grid. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255
Update browserstack.yml file
Copy the given code snippet and replace contents of browserstack.yml file in the root folder of your test suite.
Run your test suite
You can continue running your tests as you have been previously.
Add serenity-browserstack dependency in pom.xml
Add serenity-browserstack as Maven dependency in your pom.xml file and save the file.
This dependency adds the Serenity BrowserStack plugin to your project.
Set up serenity.conf file
Since project uses the Serenity BrowserStack plugin, set the remote URL and add your BrowserStack credentials in the serenity.conf file of your project.
- Use the Framework URL from Automation Console > click your Grid > Framework URLs.
- Avoid hardcoding generic URLs like
hub.browserstack.comin the config file. The Framework URL contains a unique Grid identifier for correct routing.
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 contains all the required capabilities to run tests on BrowserStack.
Set platforms on which to test
Set the browsers/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.
| Platform | Browser |
|---|---|
| Linux | Firefox |
| Linux | Chrome |
| Linux | Edge |
Enable BrowserStack Local
Test localhost/internal servers in your network
BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL
BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.
Use additional debugging features
BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.
Use Automate Turboscale
Set grid name as the name of the Turboscale grid. Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255
Update browserstack.yml file with selected capabilities
Copy the following code snippet and replace contents of the browserstack.yml file in the root folder of your test suite.
Run your test suite
You can continue running your tests as you have been previously.
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
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!