# hamzaahmed288/framework architecture

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

- Interactive diagram: https://gitdiagram.com/hamzaahmed288/framework
- Repository: https://github.com/hamzaahmed288/framework

## Overview

##### Project Type and Purpose
- This is a Java‐based automated testing framework (not a customer‐facing app).
- It uses Maven for build management, TestNG for orchestration, Selenium WebDriver for browser automation, and the Page Object Model (POM) for organizing UI interactions.

##### File Structure
Top‐level directories:
- Config – holds Config.properties (environment settings, URLs, credentials).
- Drivers – WebDriver executables (e.g., chromedriver).
- HD-Screenshots – folder for screenshots captured on test failures or checkpoints.
- HD-Test Data – external Excel/.numbers spreadsheet with test data.
- XML Files – testng.xml (defines test suites, groups, parameters).
- src/test/java – code organized into three packages:
– pages: Page Object classes (LoginPage, BaseClass)
– testcases: Test classes (HD_LOGIN_Test)
– utility: helpers and providers (BrowserFactory, ConfigDataProvider, ExcelDataProvider, Helper)
- test-output – generated TestNG and JUnit reports (HTML, XML), logs, screenshots.

##### README
- Confirms it’s an “Automation Framework.” No additional architectural notes.

##### Main Components & Responsibilities
a. Test Runner / Orchestrator
– TestNG (configured via testng.xml) triggers Test Cases.
– Maven Surefire plugin executes tests.
b. Test Cases
– Implement test scenarios by invoking Page Objects and Utilities.
c. Page Objects (POM)
– Encapsulate UI element locators and actions (e.g., LoginPage).
d. Utilities
– BrowserFactory: initializes WebDriver instances using Drivers folder.
– ConfigDataProvider: reads Config.properties.
– ExcelDataProvider: reads HD-Test Data.
– Helper: screenshots, waits, common operations.
e. External Resources
– Config.properties, Excel files, testng.xml, WebDriver executables.
f. Reporting & Artifacts
– test-output: HTML/XML reports, screenshots.

##### Relationships & Data Flows
1. Maven invokes TestNG (testng.xml).
2. TestNG loads Config & Data Providers.
3. BrowserFactory reads the WebDriver binary (Drivers) → starts browser.
4. Test Cases call Page Objects → drive UI via WebDriver.
5. On assertions/failures, Helper captures screenshots (HD-Screenshots).
6. TestNG produces reports under test-output.

##### Architectural Patterns & Principles
- Page Object Model for UI abstraction (improves maintainability).
- Dependency Injection via utility providers (Config, Data, Browser).
- Externalize data/config (properties file, Excel, XML).
- Separation of concerns: test logic vs. page interactions vs. utilities.

## Diagram (Mermaid)

```mermaid
graph TD
  subgraph "Test Orchestration"
    Orchestrator["Maven/TestNG"]:::orchestration
    Pom["pom.xml"]:::orchestration
    TestNGXML["testng.xml"]:::external
  end

  subgraph "Test Logic"
    TestCase["HD_LOGIN_Test.java"]:::testlogic
  end

  subgraph "UI Layer"
    BaseClass["BaseClass.java"]:::ui
    LoginPage["LoginPage.java"]:::ui
  end

  subgraph "Utilities"
    BrowserFactory["BrowserFactory.java"]:::utils
    ConfigDataProvider["ConfigDataProvider.java"]:::utils
    ExcelDataProvider["ExcelDataProvider.java"]:::utils
    Helper["Helper.java"]:::utils
  end

  subgraph "External Resources"
    ConfigProps["Config.properties"]:::external
    TestData["Data.numbers"]:::external
    ChromeDriver["chromedriver"]:::external
    README["README.md"]:::external
  end

  subgraph "Artifacts & Reports"
    TestOutput["test-output"]:::artifact
    Screenshots["HD-Screenshots"]:::artifact
  end

  Orchestrator -->|"reads"| Pom
  Orchestrator -->|"reads"| TestNGXML
  Orchestrator -->|"executes"| TestCase
  Orchestrator -->|"writes"| TestOutput

  TestCase -->|"uses"| BaseClass
  TestCase -->|"uses"| LoginPage
  TestCase -->|"uses"| BrowserFactory
  TestCase -->|"uses"| ConfigDataProvider
  TestCase -->|"uses"| ExcelDataProvider
  TestCase -->|"uses"| Helper

  BaseClass -->|"uses"| BrowserFactory
  BaseClass -->|"reads"| ConfigDataProvider
  BaseClass -->|"reads"| ExcelDataProvider

  BrowserFactory -->|"starts"| ChromeDriver
  ConfigDataProvider -->|"reads"| ConfigProps
  ExcelDataProvider -->|"reads"| TestData
  Helper -->|"captures"| Screenshots

  click Pom "https://github.com/hamzaahmed288/framework/blob/main/pom.xml"
  click TestNGXML "https://github.com/hamzaahmed288/framework/blob/main/XML Files/testng.xml"
  click TestCase "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/testcases/HD_LOGIN_Test.java"
  click BaseClass "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/pages/BaseClass.java"
  click LoginPage "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/pages/LoginPage.java"
  click BrowserFactory "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/utility/BrowserFactory.java"
  click ConfigDataProvider "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/utility/ConfigDataProvider.java"
  click ExcelDataProvider "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/utility/ExcelDataProvider.java"
  click Helper "https://github.com/hamzaahmed288/framework/blob/main/src/test/java/com/heeradigital/utility/Helper.java"
  click ConfigProps "https://github.com/hamzaahmed288/framework/blob/main/Config/Config.properties"
  click TestData "https://github.com/hamzaahmed288/framework/blob/main/HD-Test Data/Data.numbers"
  click ChromeDriver "https://github.com/hamzaahmed288/framework/tree/main/Drivers/chromedriver"
  click Screenshots "https://github.com/hamzaahmed288/framework/tree/main/HD-Screenshots/"
  click TestOutput "https://github.com/hamzaahmed288/framework/tree/main/test-output/"
  click README "https://github.com/hamzaahmed288/framework/blob/main/README.md"

  classDef orchestration fill:#bee3f8,stroke:#3182ce
  classDef testlogic fill:#c6f6d5,stroke:#2f855a
  classDef ui fill:#fed7aa,stroke:#dd6b20
  classDef utils fill:#e9d8fd,stroke:#6b46c1
  classDef external fill:#e2e8f0,stroke:#4a5568
  classDef artifact fill:#fefcbf,stroke:#d69e2e
```
