# kpatil2912/playwright-typescript-tests architecture

> Architecture diagram of the GitHub repository kpatil2912/playwright-typescript-tests, 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/kpatil2912/playwright-typescript-tests
- Repository: https://github.com/kpatil2912/playwright-typescript-tests

## Overview

##### Project type and purpose
- This is an end-to-end test automation framework built with Playwright and TypeScript.
- Its purpose is to drive browser UI tests (and some API calls via Axios), generate reports, and integrate with CI/CD pipelines for continuous automated testing.

##### File structure
- Top-level folders and files:
- .github/workflows – CI configurations (e.g., GitHub Actions)
- Archive – backup of older tests
- src/config – environment and Playwright configuration
- src/pages – Page Object Model classes (LoginPage.ts, homePage.ts, etc.)
- src/tests – actual test suites (UI tests under tests/ui)
- playwright.config.ts, package.json, tsconfig.json – core framework configs
- Key patterns:
- Page Object Model under src/pages
- Test runner orchestration via Playwright Test Runner
- Configurations injected via env.d.ts and src/config files
- Reporting outputs under playwright-report or test-results

##### Extract architecture insights from README
- Tech stack: Playwright Test Runner (TypeScript), Node.js, Axios for API testing
- CI/CD integrations ready for GitHub Actions, Azure DevOps, Jenkins, AWS CodePipeline
- Features: cross-browser parallel tests, custom fixtures, tagging, retry logic, HTML reports

a. Main components
1. Test Runner (Playwright Test CLI)
2. Test Suites & Scripts (src/tests)
3. Page Objects (src/pages)
4. Configuration Layer (playwright.config.ts, src/config/env)
5. API Helper Layer (Axios calls, if applicable)
6. Report Generator (Playwright HTML reporter)
7. CI/CD Orchestrator (GitHub Actions workflow)
8. External Systems under Test (Web Application UI, REST API endpoints)
b. Relationships and data flow
- CI/CD Orchestrator triggers the Test Runner
- Test Runner reads Configuration Layer
- Test Suites instantiate Page Objects and Fixtures
- Page Objects drive Browser sessions to interact with the Web UI
- API Helper Layer issues HTTP requests to APIs when needed
- Test Runner collects results and hands off to Report Generator
- Report Generator outputs HTML/JSON reports to storage (playwright-report folder)
c. Architectural patterns and principles
- Page Object Model for UI abstraction
- Dependency injection of environment variables and fixtures
- Parallel execution and retry policies managed by Playwright’s runner
- Separation of concerns: tests vs. page models vs. config vs. reporting
d. Key technologies and libraries
- Playwright (Chromium, Firefox, WebKit)
- TypeScript & ts-node for test definitions
- Axios for API testing
- GitHub Actions (playwright.yml) for CI

##### Detailed breakdown of components
- CI/CD workflow triggers (GitHub Actions)
- Playwright CLI & test runner entry point
- Environment/config loader (env.d.ts, playwright.config.ts)
- Test suites under src/tests/ui
- Page Object classes under src/pages
- API client module (Axios) if used
- Browser instances and cross-browser grid (Chromium/Firefox/WebKit)
- Test result collector and HTML report output

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CI/CD Orchestrator
    CI["GitHub Actions\n(CI/CD)"]:::framework
    click CI "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/.github/workflows/playwright.yml"

    %% Project Setup
    subgraph "Project Setup"
        PKG["package.json"]:::code
        click PKG "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/package.json"
        TSConfig["tsconfig.json"]:::code
        click TSConfig "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/tsconfig.json"
        EnvRoot["env.d.ts"]:::code
        click EnvRoot "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/env.d.ts"
    end

    %% Test Runner & Configuration
    subgraph "Test Runner Layer"
        Runner["Playwright Test Runner"]:::framework
        click Runner "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/playwright.config.ts"
        Config["Configuration Layer"]:::code
        click Config "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/config/env.d.ts"
    end

    %% Tests and Page Objects
    subgraph "Test Code Modules"
        Tests["UI Test Suites\n(shoppingE2E.spec.ts)"]:::code
        click Tests "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/tests/ui/shoppingE2E.spec.ts"
        subgraph "Page Object Model"
            BasePage["BasePage"]:::code
            click BasePage "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/pages/basePage.ts"
            LoginPage["LoginPage"]:::code
            click LoginPage "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/pages/LoginPage.ts"
            HomePage["HomePage"]:::code
            click HomePage "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/pages/homePage.ts"
            CartPage["CartPage"]:::code
            click CartPage "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/pages/cartPage.ts"
            ProductPage["ProductPage"]:::code
            click ProductPage "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/src/pages/productPage.ts"
        end
        APIHelper["API Helper (Axios)"]:::code
    end

    %% Execution Environment
    subgraph "Execution Environment"
        Browser["Browser Instances\n(Chromium/Firefox/WebKit)"]:::external
        WebApp["Web Application UI"]:::external
        RESTAPI["REST API Endpoints"]:::external
    end

    %% Reporting
    Report["Report Generator\n(HTML/JSON)"]:::framework

    %% Archive
    Archive["Archive of Older Tests"]:::code
    click Archive "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/Archive/tests-examples/demo-todo-app.spec.ts"
    click Archive "https://github.com/kpatil2912/playwright-typescript-tests/blob/main/Archive/tests/example.spec.ts"

    %% Relationships
    CI -->|"triggers"| Runner
    Runner -->|"reads from"| Config
    Runner -->|"uses dependencies from"| PKG
    Runner -->|"compiles with"| TSConfig
    Runner -->|"loads env types from"| EnvRoot
    Runner -->|"executes"| Tests
    Tests -->|"instantiate"| BasePage
    Tests -->|"use"| LoginPage
    Tests -->|"use"| HomePage
    Tests -->|"use"| CartPage
    Tests -->|"use"| ProductPage
    Tests -->|"optionally calls"| APIHelper
    BasePage --> Browser
    LoginPage --> Browser
    HomePage --> Browser
    CartPage --> Browser
    ProductPage --> Browser
    APIHelper --> RESTAPI
    Browser --> WebApp
    Runner -->|"collects results"| Report
    Report -->|"outputs to| playwright-report"| Archive

    %% Styles
    classDef framework fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef code fill:#90EE90,stroke:#000,stroke-width:1px
    classDef external fill:#FFA500,stroke:#000,stroke-width:1px
```
