# sumit5426/selenium-hybrid-finkraft architecture

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

- Interactive diagram: https://gitdiagram.com/sumit5426/selenium-hybrid-finkraft
- Repository: https://github.com/sumit5426/selenium-hybrid-finkraft

## Overview

##### Project Type and Purpose
- This is an **open-source, hybrid Selenium Test Automation Framework** built in Java 17.
- Purpose: To run UI tests against a web application using TestNG, with data-driven and modular approaches, cloud execution (LambdaTest), parallel runs, detailed logging (Log4j), and rich HTML reports (ExtentReports), all orchestrated by Maven and CI/CD via GitHub Actions.

##### File Structure
- **Top-Level Files**
- pom.xml (Maven build & dependency management)
- testng.xml (TestNG suite configuration)
- .github/workflows/maven.yml (CI via GitHub Actions)
- config/ (DEV, QA, UAT .properties + config.json)
- TestData/ (Excel, JSON, CSV test data)
- reports.html, test-output/ (generated reports)
- **Source Tree (src/test/java)**
- Constants (Browser, Env, Size)
- pages (Page Object Model classes)
- uipojo (POJO classes for Config, Environment, TestData, User)
- uidataprovider (TestNG @DataProvider implementations)
- uilistener (TestNG Listeners: retry analyzer, report listener)
- uiutility (helpers: BrowserUtility, ExcelReader, JsonUtility, PropertiesUtil, LambdaTestUtility, LoggerUtility, ExtentReportUtility)
- uitest (Test classes and TestBase)
- **Resources**
- src/test/resources/log4j2.xml (logging config)

##### README for Additional Insights
- **Design Patterns**: Page Object Model, Singleton, POJO for test data
- **Data Handling**: Excel, CSV, JSON, Properties; Faker for dynamic data
- **Execution Params**: isHeadless, isLambdaTest, environmentName, browser
- **Cloud**: LambdaTest integration
- **Reporting**: ExtentReports + Log4j
- **CI/CD**: GitHub Actions scheduled nightly, reports published on gh-pages

a. Main Components
1. **CI/CD Layer**
- GitHub Actions Workflow (maven.yml)
- Triggers: push, schedule (11:30 PM IST)
2. **Build & Orchestration**
- Maven Surefire Plugin & TestNG (testng.xml)
3. **Test Execution Layer**
- TestNG Engine
- Test Classes (uitest/*.java)
- TestBase (initializes WebDriver & environment)
4. **Page Object Layer**
- pages/*.java (HomePage, LoginPage, FlightInvoicePage)
5. **Data Layer**
- Test Data Files (Excel, JSON, CSV, Properties)
- Data Providers (uidataprovider/*.java)
- POJOs (uipojo/*.java)
6. **Utility Layer**
- BrowserUtility (local & remote sessions)
- LambdaTestUtility (cloud)
- ExcelReaderUtility, JsonUtility, PropertiesUtil
- Faker integration (dynamic data)
- LoggerUtility (Log4j)
- ExtentReportUtility
7. **Reporting & Logging**
- ExtentReports HTML (reports.html, test-output/)
- Log4j logs (./logs/)
8. **External System Under Test (SUT)**
- Target web application (URL configured via config files)
b. Relationships & Interactions
- GitHub Actions → Maven → TestNG → TestBase
- TestBase → BrowserUtility / LambdaTestUtility → WebDriver Session
- Test Classes → Page Objects → WebDriver → SUT
- Test Classes → Data Providers → POJOs → Data Files
- Utilities (Excel/JSON/Properties) support Data Providers
- Listeners (TestListener, RetryAnalyzer) hook into TestNG events → LoggerUtility + ExtentReportUtility
- Reports & logs are archived and published via GitHub Pages
c. Architectural Patterns & Principles
- **Layered Architecture**: Clear separation between test logic, page representation, data handling, and utilities
- **Modularity**: Each functionality in its own package (pages, utilities, listeners)
- **Data-Driven**: Test data abstracted from test code using POJOs & DataProviders
- **Design Patterns**: POM for UI, Singleton for driver & report instances, POJO for test data
- **CI/CD**: Automated test trigger and report publication
d. Key Technologies
- Java 17, Maven, TestNG
- Selenium WebDriver (local & LambdaTest)
- Apache POI, OpenCSV, Gson (data parsing)
- Faker (dynamic test data)
- Log4j2, ExtentReports
- GitHub Actions, gh-pages

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "CI/CD Layer"
        CI["GitHub Actions Workflow"]:::ci
    end

    subgraph "Build & Orchestration"
        Maven["Maven (pom.xml)"]:::build
        TestNG["TestNG (testng.xml)"]:::build
    end

    subgraph "Test Execution Layer"
        TestBase["TestBase"]:::exec
        LoginTest["LoginTest"]:::exec
        FlightTest["FlightInvoiceTest"]:::exec
    end

    subgraph "Page Object Layer"
        HomePage["HomePage"]:::page
        LoginPage["LoginPage"]:::page
        FlightPage["FlightInvoicePage"]:::page
    end

    subgraph "Data Layer"
        subgraph "Test Data Files"
            Excel["LoginData.xlsx"]:::data
            JSON1["loginData.json"]:::data
            JSON2["loginData1.json"]:::data
            CSV["logindata.csv"]:::data
            DEV["DEV.properties"]:::data
            QA["QA.properties"]:::data
            UAT["UAT.properties"]:::data
            ConfigJson["config.json"]:::data
        end
        DP["LoginDataProvider"]:::data
        subgraph "POJOs"
            POJOConfig["Config"]:::data
            Env["Environment"]:::data
            TD["TestData"]:::data
            User["User"]:::data
        end
    end

    subgraph "Utility Layer"
        BrowserUtil["BrowserUtility"]:::util
        LambdaUtil["LambdaTestUtility"]:::util
        ExcelUtil["ExcelReaderUtility"]:::util
        JsonUtil["JsonUtility"]:::util
        PropUtil["PropertiesUtil"]:::util
        LoggerUtil["LoggerUtility"]:::util
        ReportUtil["ExtentReportUtility"]:::util
    end

    subgraph "Listeners"
        Retry["MyRetryAnalyzer"]:::listener
        TestListener["TestListener"]:::listener
    end

    subgraph "Reporting & Logging"
        HTML["reports.html / test-output"]:::report
        LogConfig["log4j2.xml"]:::report
    end

    subgraph "External Systems"
        Lambda["LambdaTest Cloud"]:::external
        SUT["System Under Test"]:::external
    end

    CI -->|"triggers build"| Maven
    Maven -->|"runs tests"| TestNG

    TestNG -->|"init tests"| TestBase
    TestNG --> LoginTest
    TestNG --> FlightTest
    TestBase --> LoginTest
    TestBase --> FlightTest

    LoginTest -->|"uses"| LoginPage
    FlightTest -->|"uses"| FlightPage
    LoginPage --> SUT
    HomePage --> SUT
    FlightPage --> SUT

    LoginTest -->|"data from"| DP
    DP -->|"reads"| Excel
    DP --> JSON1
    DP --> JSON2
    DP --> CSV
    DP -->|"maps to"| POJOConfig
    DP -->|"maps to"| User
    POJOConfig --> DEV
    POJOConfig --> QA
    POJOConfig --> UAT
    POJOConfig --> ConfigJson

    TestBase --> BrowserUtil
    TestBase --> LambdaUtil
    DP --> ExcelUtil
    DP --> JsonUtil
    POJOConfig --> PropUtil

    TestNG --> Retry
    TestNG --> TestListener
    Retry --> LoggerUtil
    TestListener --> ReportUtil
    TestListener --> LoggerUtil

    ReportUtil --> HTML
    LoggerUtil --> LogConfig

    BrowserUtil --> SUT
    LambdaUtil --> Lambda

    classDef ci fill:#D0E8FF,stroke:#005B9F,color:#005B9F;
    classDef build fill:#BFD8B8,stroke:#2F6F44,color:#2F6F44;
    classDef exec fill:#DFFFD0,stroke:#4F8F2A,color:#4F8F2A;
    classDef page fill:#E0F7FF,stroke:#007B9F,color:#007B9F;
    classDef data fill:#FFF5BA,stroke:#A68D00,color:#A68D00;
    classDef util fill:#FFE7C7,stroke:#C56A1C,color:#C56A1C;
    classDef listener fill:#FFE7D3,stroke:#C25A07,color:#C25A07;
    classDef report fill:#FFF0F0,stroke:#D90000,color:#D90000;
    classDef external fill:#E0E0E0,stroke:#5A5A5A,color:#5A5A5A;

    click CI "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/.github/workflows/maven.yml"
    click Maven "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/pom.xml"
    click TestNG "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/testng.xml"
    click TestBase "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uitest/TestBase.java"
    click LoginTest "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uitest/LoginTest.java"
    click FlightTest "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uitest/FlightInvoiceTest.java"
    click HomePage "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/pages/HomePage.java"
    click LoginPage "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/pages/LoginPage.java"
    click FlightPage "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/pages/FlightInvoicePage.java"
    click Excel "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/TestData/LoginData.xlsx"
    click JSON1 "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/TestData/loginData.json"
    click JSON2 "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/TestData/loginData1.json"
    click CSV "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/TestData/logindata.csv"
    click DEV "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/config/DEV.properties"
    click QA "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/config/QA.properties"
    click UAT "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/config/UAT.properties"
    click ConfigJson "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/config/config.json"
    click DP "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uidataprovider/LoginDataProvider.java"
    click POJOConfig "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uipojo/Config.java"
    click Env "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uipojo/Environment.java"
    click TD "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uipojo/TestData.java"
    click User "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uipojo/User.java"
    click BrowserUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/BrowserUtility.java"
    click LambdaUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/LambdaTestUtlity.java"
    click ExcelUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/ExcelReaderUtility.java"
    click JsonUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/JsonUtility.java"
    click PropUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/PropertiesUtil.java"
    click LoggerUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/LoggerUtility.java"
    click ReportUtil "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uiutility/ExtentReportUtility.java"
    click Retry "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uilisteners/MyRetryAnalyzer.java"
    click TestListener "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/uilisteners/TestListener.java"
    click HomePage "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/Constants/Browser.java"
    click Env "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/Constants/Env.java"
    click TD "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/java/Constants/Size.java"
    click LogConfig "https://github.com/sumit5426/selenium-hybrid-finkraft/blob/main/src/test/resources/log4j2.xml"
```
