https://github.com/clark-ewerton/mobile-test-automation-lab
🚀 Mobile Test Automation Lab | A scalable Appium + Java framework for Android/iOS testing. Features: ✔ Parallel testing | ✔ Allure Reports | ✔ CI/CD (GitHub Actions) ✔ Sauce Labs integration | ✔ DataProvider
https://github.com/clark-ewerton/mobile-test-automation-lab
allure-report android android-testing appium cicd github-actions github-page github-pages java maven mobile-testing saucelabs test-automation testing testng
Last synced: 6 days ago
JSON representation
🚀 Mobile Test Automation Lab | A scalable Appium + Java framework for Android/iOS testing. Features: ✔ Parallel testing | ✔ Allure Reports | ✔ CI/CD (GitHub Actions) ✔ Sauce Labs integration | ✔ DataProvider
- Host: GitHub
- URL: https://github.com/clark-ewerton/mobile-test-automation-lab
- Owner: clark-ewerton
- License: mit
- Created: 2025-04-20T20:39:28.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2025-04-27T22:47:38.000Z (9 days ago)
- Last Synced: 2025-04-30T15:37:13.925Z (6 days ago)
- Topics: allure-report, android, android-testing, appium, cicd, github-actions, github-page, github-pages, java, maven, mobile-testing, saucelabs, test-automation, testing, testng
- Language: Java
- Homepage:
- Size: 4.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project to demonstrate knowledge in Appium + Design Patterns + CI/CD (Github Actions and Pages) + Allure Reports + In parallel mode + SauceLabs
This project demonstrates mobile automation testing using Java, Appium, TestNG, and Allure Reports. It is configured to run locally on real Android devices and in the cloud on SauceLabs infrastructure.
The main goal of this project is to automate a suite of tests covering both positive and negative scenarios for the Google Calculator application.
[](https://github.com/clark-ewerton/mobile-test-automation-lab/actions/workflows/cicd.yml)
[](https://clark-ewerton.github.io/mobile-test-automation-lab/)
# ⭐ If you find this project useful, please consider giving it a star to help increase its visibility.
---
# 📋 Table of Contents
- [Project Overview](#project-overview)
- [Technologies Used](#technologies-used)
- [Design Patterns Used](#design-patterns-used)
- [Project Structure](#project-structure)
- [Test Execution Modes](#test-execution-modes)
- [How to Run Tests Locally](#how-to-run-tests-locally)
- [GitHub Actions CI/CD](#github-actions-cicd)
- [Allure reports](#allure-reports)
- [Contributing](#contributing)
- [License](#license)
## Project Overview
This project provides a complete and extensible structure to automate tests for Android applications. It includes local and remote (cloud) execution flows, automated report generation, and integration with GitHub Pages.
### What'll be run?
The idea was to create a suite of automated tests that covers some positive and negative scenarios of a `Google Calculator`. Scenarios covered:
#### Test Scenarios Covered
This project covers the following automated test scenarios on the Google Calculator:
| Type | Operation | Inputs | Expected Result |
|------------|---------------------|--------------------|-----------------------------------------------|
| Positive | Add | 2, 3 | 5 |
| Positive | Add | 2, 3, 4 | 9 |
| Positive | Subtract | 10, 3 | 7 |
| Positive | Multiply | 3, 4 | 12 |
| Positive | Divide | 10, 2 | 5 |
| Positive | Percentage | 100, 10 | 10 |
| Positive | Subtract | 3, 10 | -7 |
| Positive | Multiply | 0, 10 | 0 |
| Positive | Divide | 7, 2 | 3.5 |
| Positive | Add | -5, 3 | -2 |
| Positive | Multiply | 2, 3, 4 | 24 |
| Positive | Percentage | 0, 50 | 0 |
| Positive | Percentage | -200, 10 | -20 |
| Negative | Divide | 5, 0 | Can't divide by 0 |
| Negative | Divide | 0, 0 | Can't divide by 0 |
| Negative | Invalid Operation | 2, 2 | Invalid Operation |
| Negative | Add | (no inputs) | Invalid Entry |
| Negative | Subtract | 5 | Need at least two numbers to make operation |
| Negative | Add | A, 5 | Invalid Entry |
#### It uses DataDriver Testing with TestNG. @DataProvider
---
## Technologies Used
- Java 17
- Maven
- Appium
- TestNG
- Allure Reports
- GitHub Actions
- Sauce Labs
---
## Design Patterns Used
This project follows clean architecture principles and applies several design patterns to improve readability, maintainability, and scalability.
#### 1. Page Object Pattern
Encapsulates page structure and user interactions, promoting reusability and maintainability in UI tests.
- **Example**: [`CalculatorPage.java`](./src/main/java/com/clarkewerton/page_object/CalculatorPage.java)
#### 2. Factory Design Pattern
Responsible for abstracting the creation of driver instances depending on platform and configuration.
- **Example**: [`DriverFactory.java`](./src/main/java/com/clarkewerton/driver/DriverFactory.java)
#### 3. Strategy Design Pattern
To select between local and cloud execution.
- **Example**: [`BaseTest.java`](./src/main/java/com/clarkewerton/test/BaseTest.java)
#### 4. Configuration Files
#### 5. Parallel Execution
## Project Structure
```
mobile-test-automation-lab/
├── src/
│ │ └── main/java/com/clarkewerton
│ │ │ │ │ │ └── config/
│ │ │ │ │ │ │ │ ├── Configuration.java
│ │ │ │ │ │ │ │ ├── ConfigurationManager.java
│ │ │ │ │ │ └── driver/
│ │ │ │ │ │ │ │ ├── DriverFactory.java
│ │ │ │ │ │ │ │ ├── IDriver.java
│ │ │ │ │ │ │ │ ├── Platform.java
│ │ │ │ │ │ │ │ └── manager/
│ │ │ │ │ │ │ │ │ │ ├── AndroidDriverManager.java
│ │ │ │ │ │ │ │ │ │ ├── IOSDriverManager.java
│ │ │ │ │ │ └── exception/
│ │ │ │ │ │ │ │ ├── PlatformNotSupportedException.java
│ │ │ │ │ │ └── locators/
│ │ │ │ │ │ │ │ ├── AndroidLocators.java
│ │ │ │ │ │ │ │ ├── IOSLocators.java
│ │ │ │ │ │ └── page_object/
│ │ │ │ │ │ │ │ ├── CalculatorPage.java
│ │ │ │ │ │ └── test/
│ │ │ │ │ │ │ │ ├── BaseTest.java
│ │ │ └── resources/
│ │ │ │ │ ├── log4j2.properties
│ │ │ │ │ └── config/
│ │ │ │ │ │ │── android.properties
│ │ │ │ │ │ │── cloud.properties
│ │ │ │ │ │ │── general.properties
│ │ │ │ │ │ │── ios.properties
│ │ │ └── test/java/com/clarkewerton
│ │ │ │ │ │ └── android/ # Test classes for Android app
│ ││ ││ ││ ││ │ ├── CalculatorTest.java
│ │ │ └── resources/
│ │ │ │ │ ├── testng-cloud.xml
│ │ │ │ │ ├── testng-local.xml
├── .github/workflows/cicd.yml # GitHub workflows (CI, actions)
├── app/googleCalculator.apk # APKs or app-related files
├── scripts/ # support scripts to initialize appium and create a second emulator device on githubactions
├── target/allure-reports # Generated reports (e.g., Allure)
│ ├── .gitignore
├── pom.xml # Maven configuration
└── README.md
```
## Test Execution Modes
This project supports two modes of test execution:
| Mode | Environment | Parallel Execution | TestNG File |
|--------|-------------|--------------------|-----------------------|
| Local | Real devices connected via USB | Yes | testng-local.xml |
| Cloud | SauceLabs devices | No (Sequential) | testng-cloud.xml |
When triggered by GitHub Actions, both test suites are executed: local tests run in parallel on two devices on Ubuntu, while cloud tests run sequentially on SauceLabs infrastructure.
---
## How to Run Tests Locally
### Prerequisites
- Java 17 installed
- Maven installed
- Android SDK and emulator configured
- Appium installed and running
### Steps to run it via real or Emulated devices (Windows)
```bash
# Clone the repository
git clone https://github.com/clark-ewerton/mobile-test-automation-lab.git
cd mobile-test-automation-lab
# Install dependencies
mvn install -DskipTests
# Start Appium server
appium
# Start the emulator
Please connect your android device into computer (don't forget to enable USB debbuging).
Find your device id by running: adb devices
Copy it
Place it into testng-local.xml, find the line
. Replace emulator-5554 by your id.
If you want, please comment the second device block on testng-local file as it won't work tests locally in parallel. Unless you emulate a second device via Android Emulator.
# Upload APK to the device
Please install Google Calculator into your Android device.
# Run TestNG test suite
mvn test -Dsurefire.suiteXmlFiles=src/test/resources/testng-local.xml
# View Allure report
mvn allure:serve
```
### Steps to run it via SauceLabs
```bash
# Clone the repository
git clone https://github.com/clark-ewerton/mobile-test-automation-lab.git
cd mobile-test-automation-lab
# Install dependencies
mvn install -DskipTests
# SauceLabs setup
- Create an account in Saucelabs
- Grab both username and key from your account
- Replace it on [`cloud.properties`](./src/main/resources/conf/cloud.properties)
- Start any android device in Saucelabs
- Don't forget to install googleCalculator.apk
# Run TestNG test suite
mvn test -Dsurefire.suiteXmlFiles=src/test/resources/testng-cloud.xml
# View Allure report
mvn allure:serve
```
## GitHub Actions CI/CD
The workflow file `.github/workflows/cicd.yml` includes three jobs:
`run-android-tests-remote`: runs tests on a local emulator on GitHub-hosted runners using Ubuntu.
`run-android-tests-saucelabs`: runs tests in Sauce Labs.
`deploy-report`: generates an Allure report and publishes it to GitHub Pages.
Allure results are stored as artifacts and published after every execution, regardless of test results.
When triggered by a GitHub Actions workflow, tests will be run by the following way:
|Execution Type | Target | Parallelism | TestNG File|
|------------|---------------------|--------------------|-----------------------------------------------|
|Local | Connected Android devices | Parallel | testng-local.xml|
|Cloud | SauceLab Android devices | Sequential | testng-cloud.xml|
See below the flow that the pipeline is doing:
```mermaid
graph TD
A[Begin] --> B[Run mobile tests on 2 Emulated Android Devices - in parallel]
A --> C[Run mobile tests on Saucelabs - sequentially]
B --> D[Final Report Dashboard - GitHub Pages - Allure Reports]
C --> D[Final Report Dashboard - GitHub Pages - Allure Reports]
D --> E[End]
```
## Allure Reports
After every test execution, Allure reports are generated and published to:
🔗 https://clark-ewerton.github.io/mobile-test-automation-lab
- 🖼️ **Screenshots:** (only on failure)
## Contributing
Contributions are welcome!
Feel free to open issues, fork the repository, and submit pull requests.
If you find this project useful, please consider giving it a star to help increase its visibility.
## License
This project is licensed under the MIT License.
See the LICENSE file for more details.
## Inspiration
This project was inspired by this repo: https://github.com/eliasnogueira/appium-parallel-execution done by @eliasnogueira