# oktaliem/mobtestsamp architecture

> Architecture diagram of the GitHub repository oktaliem/mobtestsamp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oktaliem/mobtestsamp
- Repository: https://github.com/oktaliem/mobtestsamp

## Overview

##### Project Type and Purpose
- This is a Maven-based automated mobile testing sample project. It exercises a cross-platform Appium setup using two test frameworks (SerenityBDD and TestNG + Allure). Its sole purpose is to drive Android (APK) and iOS (IPA) apps through Appium, collect screenshots, videos, and produce HTML reports.

##### Main Architectural Components
a. Build & Dependency Manager
- Maven (pom.xml) – defines dependencies (Appium, Serenity, TestNG, Allure, etc.) and test goals.
b. Test Runner Layer
- SerenityBDD Runner (`LoginTestWithSerenityRunner.java`)
- TestNG Suites (under `testsuite/TestNG/*.java`)
c. Test Suite Definitions
- Packages under `src/test/java/com/oktaliem/testsuite` group tests per framework and per feature (Login, MakePayment, ExpenseReport, MortgageRequest, ScanCheck).
d. Page Object Model Layer
- `src/test/java/com/oktaliem/pages/*.java` – each class maps to one screen or flow in the mobile app (LoginPage, MenuPage, MakePaymentPage, etc.).
- `BasePage.java` – common Appium driver setup and helper methods.
- `AdvanceActions.java` – encapsulates custom Appium gestures.
e. Test Data & Utilities
- `constants/TestData.java` – holds static test inputs (user credentials, amounts, etc.).
- `utils/GetDeviceInfo.java` – dynamic detection of connected device capabilities (platformVersion, deviceName, UDID).
f. App Under Test
- `src/test/resources/eribank.apk` and `EriBank.ipa` – the actual mobile binaries used by Appium.
g. Appium Server & Mobile Devices
- External service (Appium server) – receives driver commands, relays them to real or virtual Android/iOS devices.
- Devices/Simulators – run the app and return UI element states.
h. Reporting
- Serenity reports or TestNG + Allure – aggregate test results, embed screenshots, attach video recordings of test sessions.

##### Relationships and Data Flows
- Maven invokes the Test Runner.
- The Runner reads device capabilities via `GetDeviceInfo`.
- Runner launches Appium driver (through `BasePage`) pointing at local/remote Appium server.
- Appium server drives the APK/IPA on the device.
- Page Objects issue commands (taps, swipes, fills) via the driver.
- Test methods orchestrate Page Object calls, validate UI state against `TestData`.
- During execution, listeners capture screenshots/video and forward them to the reporting engine.
- On completion, the reporter (Serenity or Allure) compiles an HTML dashboard with pass/fail, logs, media attachments.

##### Architectural Patterns & Design Principles
- Page Object Model (POM) – separates UI locators and actions from test logic.
- Layered Test Design – Test Runner → Test Suites → Page Objects → Utils/Constants.
- Cross-platform Abstraction – same Java code drives Android and iOS with minimal changes.
- Single Source of Truth for Test Data – avoids hard-coding in tests.
- Dependency Injection (Serenity) or Factory Methods (TestNG) for driver instantiation.

##### Detail Without Overthinking
- Every interaction: test → page object → driver → server → device → report.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build & Trigger
    subgraph "Build & Trigger"
        Maven["Maven"]:::build
    end

    %% Test Runner Layer
    subgraph "Test Runner Layer"
        SerenityRunner["SerenityBDD Runner"]:::runner
        TestNGRunner["TestNG Runner"]:::runner
    end

    %% TestNG Suites
    subgraph "TestNG Suites"
        Preparation["Preparation"]:::test
        AndroidChrome["Android Chrome Browser Tests"]:::test
        AndroidSafari["Android Safari Browser Tests"]:::test
        AndroidSamsung["Android Samsung Browser Tests"]:::test
        EriBankBrowser["EriBank Browser Test"]:::test
        ExpenseReportTest["Expense Report Test"]:::test
        MakePaymentTest["Make Payment Test"]:::test
        MortgageRequestTest["Mortgage Request Test"]:::test
        ScanCheckSuite["Scan & Check Suite"]:::test
    end

    %% POM Layer
    subgraph "Page Object Model Layer"
        BasePage["BasePage"]:::code
        AdvanceActions["AdvanceActions"]:::code
        LoginPage["LoginPage"]:::code
        MenuPage["MenuPage"]:::code
        MakePaymentPage["MakePaymentPage"]:::code
        ExpenseReportPage["ExpenseReportPage"]:::code
        MortgageRequestPage["MortgageRequestPage"]:::code
        ScanCheckPage["ScanCheckPage"]:::code
        EriBankBrowserPage["EriBankBrowserPage"]:::code
    end

    %% Test Data & Utilities
    subgraph "Test Data & Utilities"
        TestData["TestData"]:::code
        GetDeviceInfo["GetDeviceInfo"]:::code
        UserModel["User Model"]:::code
    end

    %% App Under Test
    subgraph "App Under Test"
        APK["eribank.apk"]:::external
        IPA["EriBank.ipa"]:::external
        AppBundle["ExperiBank.app"]:::external
    end

    %% Appium & Devices
    AppiumServer["Appium Server"]:::external
    Devices["Devices/Simulators"]:::external

    %% Reporting
    subgraph "Reporting Engines"
        SerenityReports["Serenity Reports"]:::reporting
        AllureReports["Allure Reports"]:::reporting
    end

    %% Connections
    Maven -->|invokes| SerenityRunner
    Maven -->|invokes| TestNGRunner

    TestNGRunner -->|runs| Preparation
    TestNGRunner -->|runs| AndroidChrome
    TestNGRunner -->|runs| AndroidSafari
    TestNGRunner -->|runs| AndroidSamsung
    TestNGRunner -->|runs| EriBankBrowser
    TestNGRunner -->|runs| ExpenseReportTest
    TestNGRunner -->|runs| MakePaymentTest
    TestNGRunner -->|runs| MortgageRequestTest
    TestNGRunner -->|runs| ScanCheckSuite

    SerenityRunner -->|runs tests| LoginPage
    Preparation -->|uses| BasePage
    AndroidChrome -->|uses| BasePage
    AndroidSafari -->|uses| BasePage
    AndroidSamsung -->|uses| BasePage
    EriBankBrowser -->|uses| EriBankBrowserPage
    ExpenseReportTest -->|uses| ExpenseReportPage
    MakePaymentTest -->|uses| MakePaymentPage
    MortgageRequestTest -->|uses| MortgageRequestPage
    ScanCheckSuite -->|uses| ScanCheckPage
    LoginPage -->|uses| BasePage

    %% Utilities and Data
    SerenityRunner -->|reads capabilities| GetDeviceInfo
    TestNGRunner -->|reads capabilities| GetDeviceInfo
    SerenityRunner -->|orchestrates| LoginPage
    TestNGRunner -->|orchestrates| BasePage
    allTests -->|validate| TestData
    GetDeviceInfo -->|provides| BasePage
    UserModel -->|provides| TestData

    %% Driver and Appium
    BasePage -->|launches driver| AppiumServer
    AdvanceActions -->|extends| BasePage
    AppiumServer -->|HTTP/WebDriver| Devices
    LoginPage -->|actions| AdvanceActions

    %% App Under Test
    AppiumServer -->|installs| APK
    AppiumServer -->|installs| IPA
    AppiumServer -->|installs| AppBundle

    %% Reporting
    SerenityRunner -->|generates| SerenityReports
    TestNGRunner -->|generates| AllureReports

    %% Click Events
    click Maven "https://github.com/oktaliem/mobtestsamp/blob/master/pom.xml"
    click SerenityRunner "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/SerenityBDD/LoginTestWithSerenityRunner.java"
    click Preparation "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/Preparation.java"
    click AndroidChrome "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGAndroidChromeBrowser.java"
    click AndroidSafari "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGAndroidSafariBrowser.java"
    click AndroidSamsung "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGAndroidSamsungBrowser.java"
    click EriBankBrowser "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGEriBankBrowserTest.java"
    click ExpenseReportTest "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGExpenseReportTest.java"
    click MakePaymentTest "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGMakePaymentTest.java"
    click MortgageRequestTest "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGMortgageRequestTest.java"
    click ScanCheckSuite "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/testsuite/TestNG/TestNGScanCheckSuit.java"
    click BasePage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/BasePage.java"
    click AdvanceActions "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/AdvanceActions.java"
    click LoginPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/LoginPage.java"
    click MenuPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/MenuPage.java"
    click MakePaymentPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/MakePaymentPage.java"
    click ExpenseReportPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/ExpenseReportPage.java"
    click MortgageRequestPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/MortgageRequestPage.java"
    click ScanCheckPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/ScanCheckPage.java"
    click EriBankBrowserPage "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/pages/EriBankBrowserPage.java"
    click TestData "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/constants/TestData.java"
    click GetDeviceInfo "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/utils/GetDeviceInfo.java"
    click UserModel "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/java/com/oktaliem/User.java"
    click APK "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/resources/eribank.apk"
    click IPA "https://github.com/oktaliem/mobtestsamp/blob/master/src/test/resources/EriBank.ipa"
    click AppBundle "https://github.com/oktaliem/mobtestsamp/tree/master/src/test/resources/ExperiBank.app/"

    %% Styles
    classDef build fill:#d3d3d3,stroke:#999,stroke-width:1px
    classDef runner fill:#add8e6,stroke:#666,stroke-width:1px
    classDef test fill:#90ee90,stroke:#666,stroke-width:1px
    classDef code fill:#e0ffe0,stroke:#666,stroke-width:1px
    classDef external fill:#ffa500,stroke:#994b00,stroke-width:1px
    classDef reporting fill:#dda0dd,stroke:#800080,stroke-width:1px
```
