# jardevson/meuframeworkweb architecture

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

- Interactive diagram: https://gitdiagram.com/jardevson/meuframeworkweb
- Repository: https://github.com/jardevson/meuframeworkweb

## Overview

##### Project Type & Purpose
- This is an **automated UI testing framework** written in Java, using:
- Selenium WebDriver for browser automation
- Cucumber (Gherkin) for BDD scenarios
- JUnit 5 as the test runner
- Maven as the build tool
- It integrates with CI (GitHub Actions & Azure Pipelines) and generates HTML reports via Cluecumber.

##### File Structure
- Top‐level artifacts:
- `pom.xml` – Maven build & dependency management
- `.github/workflows/…` & `azure-pipelines.yml` – CI pipelines
- `src/test/java` packages (Page Object Model + SRP):
- core – WebDriver setup & lifecycle (`Browser.java`, `Driver.java`)
- maps – element locators (e.g. `HomeMap.java`, `RegisterMap.java`)
- pages – high‐level page actions (e.g. `HomePage.java`)
- steps – Cucumber step definitions & hooks (`Hooks.java`)
- runner – Cucumber/JUnit entry points (`RunnerTest.java`) and report generation (`GeraRelatorio.java`)
- utils – property‐file loader (`PropertiesUtils.java`)
- `src/test/resources`:
- `features/` – Gherkin scenarios (`*.feature`)
- `*.properties` – environment configs (dev, hom, uat)

##### Key Insights from README
- Emphasizes Page Object Model & Single Responsibility
- Running tests via Maven with `-Denv=` and `-Dcucumber.filter.tags=`
- Reports generated with `cluecumber-report:reporting`

##### Main Components & Their Relationships

A. **CI/CD Layer** (top)
- GitHub Actions workflows (`agendado.yml`, `regressivo.yml`)
- Azure Pipelines (`azure-pipelines.yml`)
–→ triggers Maven build & test execution

B. **Build & Dependency Management**
- Maven (`pom.xml`)
–→ resolves Selenium, Cucumber, JUnit, Cluecumber

C. **Test Execution Engine**
1. **Gherkin Feature Files** (`*.feature`)
–→ fed into the
2. **Cucumber Runner** (`RunnerTest.java`)
–→ invokes
3. **Step Definitions** (`steps/*Steps.java`)
– which call
4. **Page Objects** (`pages/*.java`)
– which wrap
5. **Element Maps** (`maps/*.java`)
– that use
6. **Core WebDriver Manager** (`core/Driver.java`)
– to instantiate & control
7. **Browser Driver** (ChromeDriver/GeckoDriver)
– controlling the
8. **Browser Instance**
– to drive the
9. **Application Under Test (AUT)**

D. **Configuration & Utilities**
- `PropertiesUtils` reads `dev.properties`, `hom.properties`, `uat.properties`
–→ provides URLs, credentials, timeouts to `core` & `pages`

E. **Reporting**
- Cluecumber plugin (`cluecumber-report:reporting`)
– generates HTML & JSON test reports
- Custom report generator (`GeraRelatorio.java`)

##### Patterns & Principles
- **Page Object Model**: separate `maps` (locators) from `pages` (actions)
- **Single Responsibility**: each package has one role (core, pages, maps, steps, runner)
- **BDD**: feature files drive implementation via step definitions
- **Modular CI**: distinct workflows for scheduled vs tagged runs

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CI/CD Layer
    subgraph "CI/CD Layer"
        direction TB
        AG["agendado.yml"]:::ci
        RG["regressivo.yml"]:::ci
        AP["azure-pipelines.yml"]:::ci
    end
    AG -->|triggers| MAVEN
    RG -->|triggers| MAVEN
    AP -->|triggers| MAVEN

    %% Build & Dependency Management
    MAVEN["Maven (pom.xml)"]:::build

    %% Test Execution Engine
    subgraph "Test Execution Engine"
        direction TB
        subgraph "Feature Files"
            DP["datepicker.feature"]:::resource
            DD["draganddrop.feature"]:::resource
            FR["frame.feature"]:::resource
            RF["register.feature"]:::resource
            RGf2["registration.feature"]:::resource
            SL["slider.feature"]:::resource
        end
        DP --> CR
        DD --> CR
        FR --> CR
        RF --> CR
        RGf2 --> CR
        SL --> CR

        subgraph "Cucumber Runner"
            R1["RunnerTest.java"]:::code
            R2["RunnerTestJUnitFive.java"]:::code
        end
        CR["Cucumber Runner"]:::code
        CR --> R1
        CR --> R2
        R1 --> SD
        R2 --> SD

        SD["Step Definitions"]:::code
        SD --> PO

        PO["Page Objects"]:::code
        PO --> EM

        EM["Element Maps"]:::code
        EM --> CD

        CD["Core WebDriver Manager"]:::code
        CD --> BD

        BD["Browser Driver"]:::external
        BD --> BI

        BI["Browser Instance"]:::external
        BI --> AUT

        AUT["Application Under Test (AUT)"]:::external
    end

    %% Configuration & Utilities
    subgraph "Configuration & Utilities"
        direction TB
        PU["PropertiesUtils.java"]:::code
        subgraph "Environment Configs"
            DEV["dev.properties"]:::resource
            HOM["hom.properties"]:::resource
            UAT["uat.properties"]:::resource
        end
        PU --> DEV
        PU --> HOM
        PU --> UAT
    end
    DEV -.->|provides config| CR
    HOM -.->|provides config| CR
    UAT -.->|provides config| CR
    DEV -.->|provides config| SD
    HOM -.->|provides config| SD
    UAT -.->|provides config| SD
    DEV -.->|provides config| PO
    HOM -.->|provides config| PO
    UAT -.->|provides config| PO
    DEV -.->|provides config| CD
    HOM -.->|provides config| CD
    UAT -.->|provides config| CD

    %% Reporting
    subgraph "Reporting"
        direction TB
        CLUE["Cluecumber Plugin"]:::report
        GR["GeraRelatorio.java"]:::code
        CLUE --> GR
        GR -->|reports to| AG
        GR -->|reports to| RG
        GR -->|reports to| AP
    end

    %% Click Events
    click AG "https://github.com/jardevson/meuframeworkweb/blob/main/.github/workflows/agendado.yml"
    click RG "https://github.com/jardevson/meuframeworkweb/blob/main/.github/workflows/regressivo.yml"
    click AP "https://github.com/jardevson/meuframeworkweb/blob/main/azure-pipelines.yml"
    click MAVEN "https://github.com/jardevson/meuframeworkweb/blob/main/pom.xml"
    click DP "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/datepicker.feature"
    click DD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/draganddrop.feature"
    click FR "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/frame.feature"
    click RF "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/register.feature"
    click RGf2 "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/registration.feature"
    click SL "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/features/slider.feature"
    click R1 "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/runner/RunnerTest.java"
    click R2 "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/runner/RunnerTestJUnitFive.java"
    click GR "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/runner/GeraRelatorio.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/DatepickerSteps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/DragDropSteps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/FrameSteps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/RegisterSteps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/Register2Steps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/SliderSteps.java"
    click SD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/steps/Hooks.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/HomePage.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/RegisterPage.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/Register2Page.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/DatepickerPage.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/DragDropPage.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/FramePage.java"
    click PO "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/pages/SliderPage.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/HomeMap.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/RegisterMap.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/Register2Map.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/DatepickerMap.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/DragDropMap.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/FrameMap.java"
    click EM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/maps/SliderMap.java"
    click CD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/core/Driver.java"
    click CD "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/core/Browser.java"
    click PU "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/java/utils/PropertiesUtils.java"
    click DEV "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/dev.properties"
    click HOM "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/hom.properties"
    click UAT "https://github.com/jardevson/meuframeworkweb/blob/main/src/test/resources/uat.properties"
    click CLUE "https://github.com/jardevson/meuframeworkweb/tree/main/cluecumber-report:reporting"

    %% Styles
    classDef ci fill:#fdd,stroke:#b33
    classDef build fill:#ddf,stroke:#337
    classDef resource fill:#dfd,stroke:#373
    classDef code fill:#ddf,stroke:#337
    classDef external fill:#fdb,stroke:#c60
    classDef report fill:#fed,stroke:#c90
```
