# oktaliem/orangehrmtestngallure architecture

> Architecture diagram of the GitHub repository oktaliem/orangehrmtestngallure, 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/orangehrmtestngallure
- Repository: https://github.com/oktaliem/orangehrmtestngallure

## Overview

##### Project Type and Purpose
- This is an automated test framework (not a user-facing application).
- It uses TestNG for orchestration, a Page Object Model (POM) for browser interactions, Allure for reporting, and integrates with SonarQube & Jenkins for CI/CD.

##### Main Logical Components
A. Test Runner & CI/CD
– TestNG engine (mvn clean test invoking TestNG.xml)
– Jenkins pipeline (checkout → test → report → quality gate)
– Docker hosts for SonarQube and (optionally) OrangeHRM under test
B. Test Framework Core
– Feature layer (src/test/java/features)
– Page Objects (src/test/java/pages/…)
– Utility classes (Log, Listeners, CreateRandomName)
– WebDriver factory (MyDrivers)
– Test Data Models (TestDataModel*.java)
C. External Services & Tools
– Selenium WebDriver drivers (chromedriver, geckodriver, IEDriver, etc.)
– ImageMagick, AShot, Selenium-Shutterbug (visual regression)
– OrangeHRM SUT (local or Docker container)
– Allure reporting engine (allure-results → allure-report)
– SonarQube (code quality)

##### Relationships & Data Flows
1. The CI server (Jenkins) checks out code from Git.
2. Jenkins invokes Maven → TestNG.xml → TestNG test suite.
3. TestNG tests call into Feature classes, which use Page Objects.
4. Page Objects call MyDrivers to spin up a browser session against the OrangeHRM SUT.
5. On each test step, Log and TestListener capture screenshots/videos and emit events to Allure results.
6. Visual-regression utilities snapshot pages via ImageMagick/AShot.
7. TestNG + Allure plugin aggregate results → allure-results folder → Allure CLI generates HTML.
8. After tests finish, Jenkins invokes SonarQube analysis on the same codebase.

##### Architectural Patterns & Principles
- Page Object Model (POM) separates page-specific locators & actions.
- TestNG’s Listener pattern captures test lifecycle events.
- Utility classes isolate crosscutting concerns (logging, URL management, random data).
- Maven standard directory layout for clear separation of production (framework) vs. test code.
- Externalizing WebDriver binaries in src/main/resources/drivers for OS portability.

##### Final Checklist
[ ] Group related classes/directories under the appropriate layer
[ ] Note external dependencies (Selenium, Allure, SonarQube, Docker)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Git Repo
    GitRepo["Git Repository"]:::external
    click GitRepo "https://github.com/oktaliem/orangehrmtestngallure/tree/master//"

    %% Jenkins Pipeline
    subgraph "Jenkins Pipeline" 
        style JenkinsPipeline fill:#82E0AA,stroke:#333,stroke-width:1px
        JenkinsPipeline["Jenkins Pipeline"] 
        CheckoutStage["Checkout Stage"] 
        TestStage["Test Stage"] 
        ReportStage["Report Stage"] 
        QualityGateStage["Quality Gate Stage"] 
    end

    GitRepo -->|checkout| CheckoutStage
    CheckoutStage --> TestStage
    TestStage --> ReportStage
    ReportStage --> QualityGateStage

    click CheckoutStage "https://github.com/oktaliem/orangehrmtestngallure/tree/master//"
    click TestStage "https://github.com/oktaliem/orangehrmtestngallure/tree/master//"
    click ReportStage "https://github.com/oktaliem/orangehrmtestngallure/tree/master//"
    click QualityGateStage "https://github.com/oktaliem/orangehrmtestngallure/tree/master//"

    %% Maven and TestNG
    MavenConfig["pom.xml"]:::test
    click MavenConfig "https://github.com/oktaliem/orangehrmtestngallure/blob/master//pom.xml"
    TestNGEngine["TestNG Engine"]:::test
    click TestNGEngine "https://github.com/oktaliem/orangehrmtestngallure/blob/master//TestNG.xml"

    TestStage -->|mvn clean test| MavenConfig -->|invokes| TestNGEngine

    %% Test Framework Core Layers
    subgraph "Test Framework Core" 
        FeatureLayer["Feature Layer"]:::test
        PageObjectLayer["Page Object Layer"]:::test
        WebDriverFactory["WebDriver Factory (MyDrivers)"]:::test
    end

    click FeatureLayer "https://github.com/oktaliem/orangehrmtestngallure/tree/master//src/test/java/features"
    click PageObjectLayer "https://github.com/oktaliem/orangehrmtestngallure/tree/master//src/test/java/pages"
    click WebDriverFactory "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/webdriver/MyDrivers.java"

    TestNGEngine --> FeatureLayer --> PageObjectLayer --> WebDriverFactory

    %% External SUT
    OrangeHRM["OrangeHRM SUT"]:::external
    WebDriverFactory -->|launch browser| OrangeHRM

    %% Utilities and Listeners
    subgraph "Utilities & Listeners" 
        LogUtil["Log & URL Utilities"]:::util
        TestListener["TestListener"]:::util
        RandomData["CreateRandomName"]:::util
    end

    click LogUtil "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/utilities/Log.java"
    click LogUtil "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/utilities/OrangeHRMURL.java"
    click TestListener "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/test/java/utils/Listeners/TestListener.java"
    click RandomData "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/test/java/utils/CreateRandomName.java"

    FeatureLayer -->|events| LogUtil
    PageObjectLayer -->|lifecycle hooks| TestListener
    PageObjectLayer -->|random data| RandomData

    %% Test Data Models
    subgraph "Test Data Models" 
        AdminModel["TestDataModelAdmin"]:::data
        LoginModel["TestDataModelLogin"]:::data
        PIMModel["TestDataModelPIM"]:::data
    end

    click AdminModel "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/model/TestDataModelAdmin.java"
    click LoginModel "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/model/TestDataModelLogin.java"
    click PIMModel "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/java/com/ohrm/model/TestDataModelPIM.java"

    FeatureLayer --> AdminModel
    FeatureLayer --> LoginModel
    FeatureLayer --> PIMModel

    %% Allure Reporting
    AllureResults["allure-results"]:::cylinder
    AllureCLI["Allure CLI/Server"]:::external
    HTMLReport["HTML Report"]:::external

    LogUtil --> AllureResults
    TestListener --> AllureResults
    AllureResults --> AllureCLI --> HTMLReport

    click AllureResults "https://github.com/oktaliem/orangehrmtestngallure/tree/master/target/allure-results"
    click HTMLReport "https://github.com/oktaliem/orangehrmtestngallure/blob/master//allure-report.zip"

    %% SonarQube Analysis
    SonarScanner["SonarQube Scanner"]:::external
    SonarServer["SonarQube Server"]:::cylinder

    QualityGateStage -->|code analysis| SonarScanner --> SonarServer

    %% Drivers & Visual-Regression
    subgraph "Drivers & Visual-Regression Utilities" 
        Drivers["WebDriver Binaries"]:::util
        ImageMagick["ImageMagick Binaries"]:::util
    end

    click Drivers "https://github.com/oktaliem/orangehrmtestngallure/tree/master//src/main/resources/drivers/"
    click ImageMagick "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/resources/ImageMagick-7.0.8-48-Q16-x64-dll.exe"
    click ImageMagick "https://github.com/oktaliem/orangehrmtestngallure/blob/master//src/main/resources/ImageMagick-x86_64-apple-darwin17.7.0.tar.gz"

    Drivers --> WebDriverFactory
    ImageMagick --> WebDriverFactory

    %% Styles
    classDef test fill:#AED6F1,stroke:#333,stroke-width:1px
    classDef external fill:#82E0AA,stroke:#333,stroke-width:1px
    classDef util fill:#F9E79F,stroke:#333,stroke-width:1px
    classDef cylinder fill:#F5B7B1,stroke:#333,stroke-width:1px
```
