Overview

This project is a automation testing framework built with JUnit 5, Appium, and Spring Boot, designed to support mobile automation. The project uses a Maven multi-module layout, where tests and post-report are sibling modules under a common parent. Each module declares the parent in its pom.xml

Features

• Appium for mobile automation.
• JUnit 5 for test execution.
• Spring Boot for configuration.
• Reporting with Maven Surefire.
• Email notification with HTML test reports (optional).
• Jenkins and Docker for CI/CD.

Prerequisites

• Java 17
• Maven 3.5.x
• Appium 2.x
• JUnit 5
• Spring Boot 3.x
• Selenium 4.25.x
• Docker (optional for CI/CD)

Getting Started

Clone the repository:

git clone https://github.com/egecansen/sahibinden-case-study.git
cd sahibinden-case-study

Build the project:

mvn clean install

Run

mvn clean test

To generate reports after the execution

mvn surefire-report:report 

Reports can be found at target/site/surefire-report.html

Configuration

application.properties

appium.platformName=Android
appium.automationName=uiautomator2
appium.appWaitActivity=*
appium.adbExecTimeout=180000
appium.appWaitDuration=180000
appium.androidInstallTimeout=180000
appium.uiautomator2ServerLaunchTimeout=180000
appium.uiautomator2ServerInstallTimeout=180000
appium.apk=src/test/resources/apks/AccuWeather.apk

test.properties

appiumLogLevel=warn

apikey={your.accuweather.api.key}
location=newyork

use-default-device=true
default-udid=emulator-5554
default-device-name=DefaultDevice01
default-port=4723
default-address=127.0.0.1

use-remote-appium=false
default-remote-udid=host.docker.internal:5555

email.properties

send-report-email=false
keep-email-logs=false
email-host=smtp.gmail.com
sender-email={sender.email}
receiver-email={receiver.email}
email-application-password={application.password}

By the help of the recources on pom.xml, all .properties files in the source folder are automatically included in the build, so configuration files are always available when the application runs. Additionally, after tests are executed, the generated HTML test report is automatically included in the post-report target directory. This allows the module responsible for sending emails to access and attach the latest report without any manual copying or file moving on your part.

Reporting

Reports are generated via Maven Surefire (target/site/surefire-report.html). The HTML report can be emailed by providing credentials and setting the send-report-email property to true.

Test report emails are handled by a separate Maven project in the post-report folder. After tests complete, Jenkins runs the email sender from this folder using:

mvn clean install exec:java

Test Structure

UI automation follows the Page Object Model for clarity and maintainability.

• Each app screen has its own class under app.screens.
• The ObjectFactory provides easy access to all screens, initializing each with the current Appium driver.
• All element locators and screen actions defined in their respective page classes.

API tests use a custom library layered on Retrofit & OkHttp for seamless integration and request handling.

• Endpoints and all related suffixes/prefixes are centrally managed.
• Service interface define API contracts.
• Step classes handle API calls and store relevant results in the test context for easy comparison with UI results.
• Model classes are located in the models package.
• API keys and parameters are configured in test.properties

CI/CD

Project is designed for CI/CD integration using Jenkins and Docker. All dependencies are installed inside the Jenkins container automatically. To be able to run on pipeline, make sure use-remote-appium property is set to true.

1. Starting Jenkins & Appium with Docker

docker compose up -d

This will build and start both Jenkins and Appium in containers configured to work together. If your Docker install uses the old CLI, use docker-compose up -d instead.

• Jenkins UI: http://localhost:8088
• Appium server: localhost:4723

Device Connection

This project includes custom entrypoint scripts that automatically connect local Android emulator to Appium and Jenkins.

entrypoint.sh: Starts the ADB server and connects to your emulator before starting Jenkins. appiumentrypoint.sh: Does the same before starting Appium. The docker-compose.yaml sets up both containers with these scripts, and shares network access. How to use:

Make sure your Android emulator is running and listening for TCP connections.

2. Jenkins Setup

On first launch, Jenkins will ask for an admin password, find it in jenkins_home/secrets/initialAdminPassword. Simply copy & paste this command to your terminal:

docker exec -it jenkins cat /var/jenkins_home/secrets/initialAdminPassword

Follow the UI prompts to install plugins and set up an admin user.

3. Run Tests

Trigger builds via Jenkins UI or webhooks for automated CI/CD. Test results and reports will be generated and can be viewed or emailed according to your configuration.

Credentials and settings are injected at runtime via Jenkins.