# girishgktester/playwright_framework architecture

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

## Overview

##### Project type and purpose
- This is a Playwright-based end-to-end test automation framework (Node.js) for e-commerce sites (dev: automationexercise.com, qa: demo.nopcommerce.com).
- Its goal is to provide a scalable, POM-driven test suite with environment management, data-driven tests, custom fixtures, reports, screenshots and CI/CD integration.

##### File structure
- Top-level modules:
- configs/ (dev, qa, stage + loader) – environment settings
- Data/ (FakerTestData.js, testData.json) – data generation & static JSON
- pages/ – Page Object Model classes (Home, Cart, Login, Search, etc.)
- tests/ – test specs invoking POM classes
- utils/ – common helpers (Hooks, Pageutils, constants, pageFactory, fixtures)
- playwright.config.js + test-runner.js – Playwright runner entry points
- .github/workflows/playwright-tests.yml – CI pipeline
- playwright-report/, screenshots/ – output artifacts

##### Key architecture notes from README
- Playwright Test Runner with parallel & cross-browser support
- Page Object Model + Page Factory
- Custom Playwright fixtures via test.extend
- Tag-based filtering, screenshot/video capture
- Environment loader using cross-env, dotenv, minimist
- CI via GitHub Actions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Layer
    CLI["CLI/Test Runner"]:::runner
    PLAY_CONFIG["playwright.config.js"]:::runner
    RUNNER_ENTRY["test-runner.js"]:::runner

    %% Configuration Layer
    subgraph "Configuration Layer"
        CONFIG_LOADER["Config Loader"]:::config
        DEV["dev.js"]:::config
        QA["qa.js"]:::config
        STAGE["stage.js"]:::config
    end

    %% Fixture Layer
    FIXTURES["Custom Fixtures"]:::fixture

    %% POM Layer
    subgraph "Page Factory & POM Layer"
        PAGE_FACTORY["Page Factory"]:::pom
        subgraph "Page Objects"
            HOME["Homepage"]:::pom
            CART["Cartpage"]:::pom
            LOGIN["LoginPage"]:::pom
            REGISTER["Register"]:::pom
            SEARCH["Searchpage"]:::pom
            PLACE_ORDER["Placeorder"]:::pom
        end
    end

    %% Test Data Layer
    subgraph "Test Data Layer"
        STATIC_DATA["testData.json"]:::data
        DYNAMIC_DATA["FakerTestData.js"]:::data
    end

    %% Utility Modules
    subgraph "Utility Modules"
        PAGE_UTILS["Pageutils"]:::util
        CONSTANTS["constants"]:::util
        HOOKS["Hooks"]:::util
    end

    %% Test Suites Layer
    subgraph "Test Suites"
        HOME_TEST["HompageTest.spec.js"]:::test
        CART_TEST["CartTest.spec.js"]:::test
        LOGIN_TEST["LoginTest.spec.js"]:::test
        SEARCH_TEST["SearchTests.spec.js"]:::test
        PLACE_ORDER_TEST["Placeorder.spec.js"]:::test
    end

    %% Reporting & Artifacts
    subgraph "Reporting & Artifacts"
        REPORT_HTML["playwright-report/index.html"]:::report
        REPORT_DATA["playwright-report/data/"]:::report
        SCREENSHOTS["screenshots/"]:::report
    end

    %% CI/CD Pipeline
    CI[".github/workflows/playwright-tests.yml"]:::ci

    %% Relationships
    CLI -->|reads| PLAY_CONFIG
    CLI -->|invokes| RUNNER_ENTRY
    RUNNER_ENTRY -->|loads env| CONFIG_LOADER
    CONFIG_LOADER --> DEV
    CONFIG_LOADER --> QA
    CONFIG_LOADER --> STAGE

    RUNNER_ENTRY -->|applies| FIXTURES
    RUNNER_ENTRY -->|calls| PAGE_FACTORY

    PAGE_FACTORY --> HOME
    PAGE_FACTORY --> CART
    PAGE_FACTORY --> LOGIN
    PAGE_FACTORY --> REGISTER
    PAGE_FACTORY --> SEARCH
    PAGE_FACTORY --> PLACE_ORDER

    HOME_TEST --> HOME
    CART_TEST --> CART
    LOGIN_TEST --> LOGIN
    SEARCH_TEST --> SEARCH
    PLACE_ORDER_TEST --> PLACE_ORDER

    HOME_TEST --> STATIC_DATA
    HOME_TEST --> DYNAMIC_DATA
    CART_TEST --> STATIC_DATA
    CART_TEST --> DYNAMIC_DATA

    HOME_TEST --> PAGE_UTILS
    HOME_TEST --> CONSTANTS
    HOME_TEST --> HOOKS

    RUNNER_ENTRY -->|runs| HOME_TEST
    RUNNER_ENTRY --> CART_TEST
    RUNNER_ENTRY --> LOGIN_TEST
    RUNNER_ENTRY --> SEARCH_TEST
    RUNNER_ENTRY --> PLACE_ORDER_TEST

    RUNNER_ENTRY -->|outputs| REPORT_HTML
    REPORT_HTML --> REPORT_DATA
    REPORT_HTML --> SCREENSHOTS

    CI -->|triggers| CLI
    CI -->|collects| REPORT_HTML

    %% Click Events
    click RUNNER_ENTRY "https://github.com/girishgktester/playwright_framework/blob/main/test-runner.js"
    click PLAY_CONFIG "https://github.com/girishgktester/playwright_framework/blob/main/playwright.config.js"
    click CONFIG_LOADER "https://github.com/girishgktester/playwright_framework/blob/main/configs/configLoader.js"
    click DEV "https://github.com/girishgktester/playwright_framework/blob/main/configs/dev.js"
    click QA "https://github.com/girishgktester/playwright_framework/blob/main/configs/qa.js"
    click STAGE "https://github.com/girishgktester/playwright_framework/blob/main/configs/stage.js"
    click FIXTURES "https://github.com/girishgktester/playwright_framework/blob/main/utils/hooksFixture.js"
    click PAGE_FACTORY "https://github.com/girishgktester/playwright_framework/blob/main/utils/pageFactory.js"
    click HOME "https://github.com/girishgktester/playwright_framework/blob/main/pages/Homepage.js"
    click CART "https://github.com/girishgktester/playwright_framework/blob/main/pages/Cartpage.js"
    click LOGIN "https://github.com/girishgktester/playwright_framework/blob/main/pages/LoginPage.js"
    click REGISTER "https://github.com/girishgktester/playwright_framework/blob/main/pages/Register.js"
    click SEARCH "https://github.com/girishgktester/playwright_framework/blob/main/pages/Searchpage.js"
    click PLACE_ORDER "https://github.com/girishgktester/playwright_framework/blob/main/pages/Placeorder.js"
    click HOME_TEST "https://github.com/girishgktester/playwright_framework/blob/main/tests/HompageTest.spec.js"
    click CART_TEST "https://github.com/girishgktester/playwright_framework/blob/main/tests/CartTest.spec.js"
    click LOGIN_TEST "https://github.com/girishgktester/playwright_framework/blob/main/tests/LoginTest.spec.js"
    click SEARCH_TEST "https://github.com/girishgktester/playwright_framework/blob/main/tests/SearchTests.spec.js"
    click PLACE_ORDER_TEST "https://github.com/girishgktester/playwright_framework/blob/main/tests/Placeorder.spec.js"
    click STATIC_DATA "https://github.com/girishgktester/playwright_framework/blob/main/Data/testData.json"
    click DYNAMIC_DATA "https://github.com/girishgktester/playwright_framework/blob/main/Data/FakerTestData.js"
    click PAGE_UTILS "https://github.com/girishgktester/playwright_framework/blob/main/utils/Pageutils.js"
    click CONSTANTS "https://github.com/girishgktester/playwright_framework/blob/main/utils/constants.js"
    click HOOKS "https://github.com/girishgktester/playwright_framework/blob/main/utils/Hooks.js"
    click REPORT_HTML "https://github.com/girishgktester/playwright_framework/blob/main/playwright-report/index.html"
    click REPORT_DATA "https://github.com/girishgktester/playwright_framework/tree/main/playwright-report/data/"
    click SCREENSHOTS "https://github.com/girishgktester/playwright_framework/tree/main/screenshots/"
    click CI "https://github.com/girishgktester/playwright_framework/blob/main/.github/workflows/playwright-tests.yml"

    %% Styles
    classDef runner fill:#cce5ff,stroke:#0066cc,color:#003366;
    classDef config fill:#fff3cd,stroke:#ffcc00,color:#665500;
    classDef fixture fill:#e2e3e5,stroke:#6c757d,color:#343a40;
    classDef pom fill:#d4edda,stroke:#28a745,color:#155724;
    classDef data fill:#f8d7da,stroke:#dc3545,color:#721c24;
    classDef util fill:#d1ecf1,stroke:#17a2b8,color:#0c5460;
    classDef test fill:#ffe5b4,stroke:#ff8c00,color:#804000;
    classDef report fill:#f5c6cb,stroke:#c82333,color:#721c24;
    classDef ci fill:#f0f0f0,stroke:#333333,color:#111111;
```
