Selenium with Serenity
Your guide to running tests using Serenity on BrowserStack’s Selenium Grid of 3000+ real devices and desktop browsers.
This section covers running your first build with BrowserStack’s sample repo. To run builds with your existing test suite(s), skip to integrate your test suite .
Prerequisites
BrowserStack Username and Access key. You can find this in your account profile . If you do not have an account yet, please sign up for a Free Trial .
Serenity v2+, Java v8+, Selenium v2.5+ (W3C/JSON Wire).
If you are using Eclipse or IntelliJ IDEA for running tests, install the corresponding JUnit plugin.
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:
If you are using Maven, follow the given steps to run the sample build:
Get Sample Project
Download Project
Download ZIP
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack
Install the BrowserStack Plugin - on the Eclipse toolbar, click Help > Eclipse Marketplace .
In the Eclipse Marketplace , search for BrowserStack , click Install > Finish .
Right-click anywhere on the file SampleTest.java > Run As > JUnit Test .
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 .
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack
Run the tests using the following steps:
Install the BrowserStack Plugin: click IntelliJ IDEA > Preferences > Plugins .
Search for BrowserStack and click Install .
Open the file SampleTest.java and click the Run button.
Get Sample Project
Get our sample project using one of the following options:
Option 2: Via Git
Clone our sample Git repository using the commands.
```bash
git clone https://github.com/browserstack/serenity-browserstack.git
cd serenity-browserstack
```
Copy icon
Copy
git clone https://github.com/browserstack/serenity-browserstack.git
cd serenity-browserstack
Option 3: Via Maven Archetype
Setup using Maven archetype to create a new sample project with your BrowserStack credentials pre-configured.
```bash
mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=browserstack-sdk-archetype-setup -DarchetypeVersion=1.1 \
-DgroupId=com.browserstack -DartifactId=serenity-browserstack -Dversion=1.0 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY -DBROWSERSTACK_PROJECT_REPO=serenity-browserstack
cd serenity-browserstack
```
Copy icon
Copy
mvn archetype:generate -B -DarchetypeGroupId= com.browserstack \
-DarchetypeArtifactId= browserstack-sdk-archetype-setup -DarchetypeVersion= 1.1 \
-DgroupId= com.browserstack -DartifactId= serenity-browserstack -Dversion= 1.0 \
-DBROWSERSTACK_USERNAME= YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY= YOUR_ACCESS_KEY -DBROWSERSTACK_PROJECT_REPO= serenity-browserstack
cd serenity-browserstack
```bash
mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion="1.1" -DgroupId="com.browserstack" -DartifactId="serenity-browserstack" -Dversion="1.0" -DBROWSERSTACK_USERNAME="YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO="serenity-browserstack"; cd serenity-browserstack
```
Copy icon
Copy
mvn archetype:generate -B -DarchetypeGroupId= "com.browserstack" -DarchetypeArtifactId= "browserstack-sdk-archetype-setup" -DarchetypeVersion= "1.1" -DgroupId= "com.browserstack" -DartifactId= "serenity-browserstack" -Dversion= "1.0" -DBROWSERSTACK_USERNAME= "YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY= "YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO= "serenity-browserstack" ; cd serenity-browserstack
```bash
mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion="1.1" -DgroupId="com.browserstack" -DartifactId="serenity-browserstack" -Dversion="1.0" -DBROWSERSTACK_USERNAME="YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO="serenity-browserstack" && cd serenity-browserstack
```
Copy icon
Copy
mvn archetype:generate -B -DarchetypeGroupId= "com.browserstack" -DarchetypeArtifactId= "browserstack-sdk-archetype-setup" -DarchetypeVersion= "1.1" -DgroupId= "com.browserstack" -DartifactId= "serenity-browserstack" -Dversion= "1.0" -DBROWSERSTACK_USERNAME= "YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY= "YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO= "serenity-browserstack" && cd serenity-browserstack
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack!
Install dependencies and run a sample test build on BrowserStack:
```bash
mvn verify -P sample-test
```
Copy icon
Copy
mvn verify -P sample-test
If you are using Gradle, follow the given steps to run the sample build:
Get Sample Project
Download Project
Download ZIP
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack
Click the Gradle tool window on the right-hand side. If you can’t see the tool window, click Window > Show View > Gradle Tasks to enable it
Ensure Show All Tasks is enabled by clicking on menu icon in Gradle Tasks .
Expand project, click on other drop-down, and double click on sampleTest to run your first test.
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 .
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack
Run the tests using the following steps:
Click the Gradle tool window on the right-hand side. If you can’t see the tool window, click View > Tool Windows > Gradle to enable it:
Under Tasks , select the task for running tests:
Expand the Other drop-down, and then double-click the task to run the tests:
Get Sample Project
Get our sample project using one of the following options:
Option 2: Via Git
Clone our sample Git repository using the commands.
```bash
git clone https://github.com/browserstack/serenity-browserstack.git
cd serenity-browserstack
```
Copy icon
Copy
git clone https://github.com/browserstack/serenity-browserstack.git
cd serenity-browserstack
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.
```conf
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
```
Copy icon
Copy
webdriver {
driver = remote
remote.url = "https://hub.browserstack.com/wd/hub"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"
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.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
```
Copy icon
Copy
userName : YOUR_USERNAME
accessKey : YOUR_ACCESS_KEY
framework : serenity
platforms :
- os : Windows
osVersion : 10
browserName : Chrome
browserVersion : 120.0
- os : OS X
osVersion : Monterey
browserName : Safari
browserVersion : 15.6
- deviceName : iPhone 13
osVersion : 15
browserName : Chromium
deviceOrientation : portrait
browserstackLocal : true
buildName : browserstack- build- 1
projectName : BrowserStack Sample
Run sample tests on BrowserStack!
Install dependencies and run a sample test build on BrowserStack:
```bash
gradle build
gradle clean sampleTest
```
Copy icon
Copy
gradle build
gradle clean sampleTest
Next steps
After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack .
Is this page helping you?
Thank you for your valuable feedback!
