App AutomateGet startedRun a sample build

Appium with Serenity

Test your native and hybrid apps on a real device cloud. This guide helps you run your first Serenity test build on a real Android or iOS device on BrowserStack.

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

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

    git clone  https://github.com/browserstack/serenity-appium-app-browserstack.git
cd serenity-appium-app-browserstack

Option 3: Via Maven Archetype

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

      
            macOS or Linux
          
            Windows PowerShell
          
            Windows Cmd
          
```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.

Copy

    webdriver {
  driver = remote
  remote.url = "https://hub.browserstack.com/wd/hub"
  remote.driver = "appium"
}
browserstack.user="YOUR_USERNAME"
browserstack.key="YOUR_ACCESS_KEY"

  

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 Android or iOS devices from a list of 150+ available combinations:

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

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    
```
browserstack.yml

      
      
    

        
            Copy icon
            
          
        Copy
      
    userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
framework: serenity
platforms:
  - platformName: android
    realMobile: 11
    deviceName: Samsung Galaxy S22 Ultra
    platformVersion: 12.0
  - platformName: android
    realMobile: 10
    deviceName: Google Pixel 7 Pro
    platformVersion: 13.0
  - platformName: android
    realMobile: Big Sur
    deviceName: OnePlus 9
    platformVersion: 11.0
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample

  

Run sample tests on BrowserStack!

Install dependencies and run a sample test build on BrowserStack:

cd android
mvn clean
mvn verify -P sample-test

cd ios
mvn clean
mvn verify -P sample-test

After you run your test, visit the App Automate dashboard to view your test results.

Next steps

After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack.

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!

Appium with Serenity

Prerequisites

Run a sample build

Get Sample Project

Option 1: Download Project

Option 2: Via Git

Option 3: Via Maven Archetype

Update your serenity.conf file

Configure your browserstack.yml config file

Set access credentials

Select Android or iOS devices from a list of 150+ available combinations:

Update the browserstack.yml config file

Run sample tests on BrowserStack!

Get Sample Project

Download Project

Import the downloaded project

Update your serenity.conf file

Configure your browserstack.yml config file

Set access credentials

Select Android or iOS devices from a list of 150+ available combinations:

Update the browserstack.yml config file

Run sample tests on BrowserStack

Get Sample Project

Download Project

Import the downloaded project

Update your serenity.conf file

Configure your browserstack.yml config file

Set access credentials

Select Android or iOS devices from a list of 150+ available combinations:

Update the browserstack.yml config file

Run sample tests on BrowserStack

Next steps

We're sorry to hear that. Please share your feedback so we can do better

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

We're continuously improving our docs. We'd love to know what you liked