TestNG is a testing framework inspired from JUnit and NUnit but introducing some new functionalities that make it more powerful.
This BrowserStack Example repository demonstrates an Appium test framework written in TestNG with parallel testing capabilities. The Appium test scripts are written for the open source todo. This BrowserStack Demo Mobile App is an e-commerce mobile application which showcases multiple real-world user scenarios. The app is bundled with offers data, orders data and products data that contains everything you need to start using the app and run tests out-of-the-box.
The Appium tests are run on different platforms like on-prem and BrowserStack using various run configurations and test capabilities.
-
Clone the repository
-
Ensure you have the following dependencies installed on the machine
- Java >= 8
- Maven >= 3.1+
Maven:
mvn install -DskipTests
Gradle:
gradle clean build
This repository contains the following Selenium tests:
Module | Test name | Description |
---|---|---|
E2E | OrderTest | This test scenario verifies successful product purchase lifecycle end-to-end. It demonstrates the Page Object Model design pattern and is also the default test executed in all the single test run profiles. |
Login | LoginTest | This test verifies the login workflow with different types of valid login users. |
Login | LoginFailTest | This test verifies the login workflow error. |
Login | LoginDataDrivenTest | This test verifies the login for all error cases in a datadriven way |
Login | LoginDataDrivenReadFromCSVTest | This test verifies the login for all error cases in a datadriven way with CSV-file |
Login | LoginRequestedTest | This test verifies that the login page is shown when you access the favourites page with being logged in |
Offers | OfferTest | This test mocks the GPS location for Singapore and verifies that the product offers applicable for the Singapore location are shown. |
User | UserTest | The first test verifies that existing orders are shown for user: "existing_orders_user". The second test verifies if a user can add product to the favourites. |
For all the parallel run configuration profiles, you can configure the maximum parallel test threads by changing the settings below.
-
BrowserStack
Maven:
pom.xml
<testng.parallel>classes</testng.parallel> <testng.threadCount>5</testng.threadCount>
Gradle:
gradle.properties
testngParallel=classes testngThreadCount=5
This infrastructure points to running the tests on your own machine using simulator or connected devices.
- For this infrastructure configuration (i.e on-premise), ensure that the app is downloaded and placed in the
/src/test/resources/app
folder.
-
How to run the test?
To run the default test scenario (e.g. End to End Scenario) on your own machine, use the following command:
Maven:
mvn clean test -P on-prem
Gradle:
gradle clean on-prem
To run a specific test scenario, use the following command with the additional 'test' argument:
Maven:
mvn clean test -P on-prem -Dtest=LoginDataDrivenTest
Gradle:
gradle clean on-prem -Ptest-name=LoginDataDrivenTest
where, the argument
test
ortest-name
can be any testclass implemented this repository. -
Output
This run profile executes a specific test scenario on a single device instance on your own machine.
-
How to run the test?
To run the entire test suite on your own machine, use the following command:
Maven:
mvn clean test -P on-prem-suite
Gradle:
gradle clean on-prem-suite
-
Output
This run profile executes the entire test suite sequentially on a single device, on your own machine.
BrowserStack provides instant access to 2,000+ real mobile devices and browsers on a highly reliable cloud infrastructure that effortlessly scales as testing needs grow.
-
Create a new BrowserStack account or use an existing one.
-
Identify your BrowserStack username and access key from the BrowserStack App Automate Dashboard and export them as environment variables using the below commands.
- For *nix based and Mac machines:
export BROWSERSTACK_USERNAME=<browserstack-username> && export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
- For Windows:
set BROWSERSTACK_USERNAME=<browserstack-username> set BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
Alternatively, you can also hardcode username and access_key objects in the test_caps.json file.
Note:
- We have configured a list of test capabilities in the test_caps.json file. You can certainly update them based on your device test requirements.
- The exact test capability values can be easily identified using the Browserstack Capability Generator
You need to upload the APK
or IPA
to BrowserStack, before you can run the test on BrowserStack. BrowserStack will provide you with an app_url
which you need to use.
You can upload the APK
or IPA
using a file on your filesystem or using a public url.
cURL command:
curl -u "browserstack_username:browserstack_access_key" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/ipa/or/apk"
-F "custom_id=BrowserStackDemoApp"
More information on Upload apps from filesystem, Upload apps using public URL or Define custom ID for app.
In this section, we will run a single test on an Android device on Browserstack. To change test capabilities for this configuration, please refer to the single
object in caps.json
file.
-
How to run the test?
- To run the default test scenario (e.g. End to End Scenario) on a BrowserStack device, use the following command:
Maven:
mvn clean test -P bstack-single
Gradle:
gradle clean bstack-single
To run a specific test scenario, use the following command with the additional 'test-name' argument: Maven:
mvn clean test -P bstack-single -Dtest=LoginDataDrivenTest
Gradle:
gradle clean bstack-single -Ptest-name=LoginDataDrivenTest
where, the argument
test
ortest-name
can be any testclass implemented in this repository. -
Output
This run profile executes a single test on a single device on BrowserStack. Please refer to your BrowserStack App Automate Dashboard for test results.
In this section, we will run the tests in parallel on a single device on Browserstack. Refer to single
object in test_caps.json
file to change test capabilities for this configuration.
-
How to run the test?
To run the entire test suite in parallel on a single BrowserStack device, use the following command:
Maven:
mvn clean test -P bstack-parallel
Gradle:
gradle clean bstack-parallel
-
Output
This run profile executes the entire test suite in parallel on a single BrowserStack device. Please refer to your BrowserStack App Automate Dashboard for test results.
- Note: By default, this execution would run maximum 5 test threads in parallel on BrowserStack. Refer to the section "Configuring the maximum parallel test threads for this repository" for updating the parallel thread count based on your requirements.
In this section, we will run the tests in parallel on multiple devices on Browserstack. Refer to the parallel
object in caps.json
file to change test capabilities for this configuration.
-
How to run the test?
To run the entire test suite in parallel on multiple BrowserStack devices, use the following command:
Maven:
mvn clean test -P bstack-parallel-devices
Gradle:
gradle clean bstack-parallel-devices
[Mobile application using local or internal environment] Running your tests on BrowserStack using BrowserStackLocal
-
Clone the BrowserStack demo application repository.
git clone https://github.com/browserstack/browserstack-demo-app
-
Please follow the README.md on the BrowserStack demo application repository to install and start the dev server on localhost.
-
We will change the response of the
signin
(for thelocked_user
) API endpoint. (File to change:pages/api/signin.js
line43
)- The API endpoint respond with a specific error,
Your account has been locked.
. - We will change that to something generic, like:
Something went wrong.
- The API endpoint respond with a specific error,
-
In this section, we will run a single test case that changes the API used in BrowserStack Demo app, in a wat that it interact with you local machine. Refer to the
single_local
object incaps.json
file to change test capabilities for this configuration. -
Note: You may need to provide additional BrowserStackLocal arguments to successfully connect your localhost environment with BrowserStack infrastructure. (e.g if you are behind firewalls, proxy or VPN).
-
Further details for successfully creating a BrowserStackLocal connection can be found here:
[Mobile application using local or internal environment] Run a specific test on BrowserStack using BrowserStackLocal
-
How to run the test?
- To run the default test scenario (e.g. End to End Scenario) on a single BrowserStack device using BrowserStackLocal, use the following command:
Maven:
mvn clean test -P bstack-local
Gradle:
gradle clean bstack-local
-
Output
This run profile executes a single test on a mobile application using local or internal environment on a single device on BrowserStack. Please refer to your BrowserStack App Automate Dashboard for test results.
[Mobile application using local or internal environment] Run the entire test suite in parallel on multiple BrowserStack devices using BrowserStackLocal
In this section, we will run the test cases on a mobile application using a local or internal environment in parallel on multiple devices on Browserstack. Refer to the parallel_local
object in caps.json
file to change test capabilities for this configuration.
-
How to run the test?
To run the entire test suite in parallel on multiple BrowserStack devices using BrowserStackLocal, use the following command:
Maven:
mvn clean test -P bstack-local-parallel-devices
Gradle:
gradle clean bstack-local-parallel-devices
-
Output
This run profile executes the entire test suite on a mobile application Mobile application using local or internal environment on multiple devices on BrowserStack. Please refer to your BrowserStack App Automate Dashboard for test results.
-
Note: By default, this execution would run maximum 5 test threads in parallel on BrowserStack. Refer to the section "Configuring the maximum parallel test threads for this repository" for updating the parallel thread count based on your requirements.
-
Generate Report using the following command:
Maven:
mvn allure:report
Gradle:
gradle allureReport
-
Serve the Allure report on a server:
Maven:
mvn allure:serve
Gradle:
gradle allureServe
- View your test results on the BrowserStack App Automate Dashboard
- Documentation for writing Automate test scripts in Java
- Customizing your tests capabilities on BrowserStack using our test capability generator
- List of Browsers & mobile devices for automation testing on BrowserStack
- Using Automate REST API to access information about your tests via the command-line interface
- Understand how many parallel sessions you need by using our Parallel Test Calculator
- For testing public web applications behind IP restriction, Inbound IP Whitelisting can be enabled with the BrowserStack Enterprise offering