# vinaykumarbm/playwright-sample-project architecture

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

- Interactive diagram: https://gitdiagram.com/vinaykumarbm/playwright-sample-project
- Repository: https://github.com/vinaykumarbm/playwright-sample-project

## Overview

This repository is a data-driven Playwright/TypeScript automation framework. Its documented workflow uses Excel execution data to create a suite, then runs UI, REST/SOAP, or database automation and produces reports and logs. The sampled suite manager confirms Excel-driven suite generation; source excerpts also show UI action composition, REST response handling, browser selection, and logging. Other capabilities are retained where documented, but their internal call paths are not inferred from unsampled code.

Main entry points: [`playwright.config.ts`](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/playwright.config.ts) (Playwright configuration), [`src/framework/manager/SuiteManager.ts`](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/manager/SuiteManager.ts) (Suite manager), [`src/framework/playwright/actions/UIActions.ts`](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/actions/UIActions.ts) (UI action facade), [`src/framework/logger/TestListener.ts`](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/logger/TestListener.ts) (Test listener)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_suite["Suite and data"]
  node_suite_manager["Suite manager<br/>[SuiteManager.ts]"]
  node_excel["Excel data<br/>[ExcelUtil.ts]"]
  node_suite_template["Suite template<br/>[SuiteTemplate.ts]"]
end

subgraph group_ui["Web UI automation"]
  node_ui_steps["Shopping UI steps"]
  node_ui_pages["Shopping page objects"]
  node_ui_actions["UI action facade<br/>[UIActions.ts]"]
  node_ui_elements["Element actions"]
  node_ui_special_actions["Specialized UI actions"]
end

subgraph group_api["API automation"]
  node_rest_steps["REST user steps<br/>[UserSteps.ts]"]
  node_rest_request["REST requests<br/>[RESTRequest.ts]"]
  node_rest_response["REST responses<br/>[RESTResponse.ts]"]
  node_soap_steps["SOAP account steps"]
  node_soap_request["SOAP requests<br/>[SOAPRequest.ts]"]
  node_soap_response["SOAP responses<br/>[SOAPResponse.ts]"]
  node_xml_parser["XML parser<br/>[XMLParserUtil.ts]"]
end

subgraph group_services["Database and utilities"]
  node_database_steps["Database steps<br/>[DatabaseStep.ts]"]
  node_database_util["Database utilities<br/>[DBUtil.ts]"]
  node_pdf_util["PDF validation<br/>[PDFUtil.ts]"]
  node_image_util["Image comparison<br/>[ImageComparator.ts]"]
end

subgraph group_runtime["Runtime and results"]
  node_playwright_config["Playwright configuration"]
  node_browser["Browser selection<br/>[Browser.ts]"]
  node_test_listener["Test listener<br/>[TestListener.ts]"]
  node_logger["Execution logger<br/>[Logger.ts]"]
  node_allure["Allure reporting<br/>[Allure.ts]"]
  node_html_reporter["HTML reporting<br/>[HTMLReporter.ts]"]
  node_runner["Playwright runner"]
end

node_engineer(("Test engineer"))
node_shopping_site(("Shopping website"))
node_rest_service(("REST service"))
node_soap_service(("SOAP service"))
node_database_service[("Database systems")]

node_engineer -->|"selects sheet"| node_suite_manager
node_suite_manager -->|"reads test list"| node_excel
node_suite_manager -->|"uses template"| node_suite_template
node_engineer -->|"runs suite"| node_runner
node_playwright_config -->|"selects browser"| node_browser
node_playwright_config -->|"registers reporter"| node_test_listener
node_playwright_config -->|"configures reporting"| node_allure
node_playwright_config -->|"configures reporting"| node_html_reporter
node_test_listener -->|"writes logs"| node_logger
node_ui_actions -->|"delegates actions"| node_ui_elements
node_ui_actions -->|"configures helpers"| node_ui_special_actions
node_ui_steps -->|"automates UI"| node_shopping_site
node_rest_request -->|"builds response"| node_rest_response
node_rest_steps -->|"tests REST API"| node_rest_service
node_soap_steps -->|"tests SOAP API"| node_soap_service
node_soap_response -->|"uses parser"| node_xml_parser
node_database_steps -->|"supports database tests"| node_database_service
node_engineer -.->|"validates PDFs"| node_pdf_util
node_engineer -.->|"compares images"| node_image_util

click node_suite_manager "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/manager/SuiteManager.ts"
click node_excel "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/ExcelUtil.ts"
click node_suite_template "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/template/SuiteTemplate.ts"
click node_ui_steps "https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/advantage/steps"
click node_ui_pages "https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/advantage/pages"
click node_ui_actions "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/actions/UIActions.ts"
click node_ui_elements "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/actions/UIElementActions.ts"
click node_ui_special_actions "https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/framework/playwright/actions"
click node_rest_steps "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/API/REST/steps/UserSteps.ts"
click node_rest_request "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/RESTRequest.ts"
click node_rest_response "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/RESTResponse.ts"
click node_soap_steps "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/API/SOAP/steps/AccountServiceSteps.ts"
click node_soap_request "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/SOAPRequest.ts"
click node_soap_response "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/SOAPResponse.ts"
click node_xml_parser "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/XMLParserUtil.ts"
click node_database_steps "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/database/steps/DatabaseStep.ts"
click node_database_util "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/DBUtil.ts"
click node_pdf_util "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/PDFUtil.ts"
click node_image_util "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/ImageComparator.ts"
click node_playwright_config "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/playwright.config.ts"
click node_browser "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/manager/Browser.ts"
click node_test_listener "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/logger/TestListener.ts"
click node_logger "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/logger/Logger.ts"
click node_allure "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/reporter/Allure.ts"
click node_html_reporter "https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/reporter/HTMLReporter.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_suite_manager,node_excel,node_suite_template toneBlue
class node_ui_steps,node_ui_pages,node_ui_actions,node_ui_elements,node_ui_special_actions,node_database_service toneAmber
class node_rest_steps,node_rest_request,node_rest_response,node_soap_steps,node_soap_request,node_soap_response,node_xml_parser toneMint
class node_database_steps,node_database_util,node_pdf_util,node_image_util toneRose
class node_playwright_config,node_browser,node_test_listener,node_logger,node_allure,node_html_reporter,node_runner,node_engineer,node_shopping_site,node_rest_service,node_soap_service toneIndigo
```

## Components

### Suite and data

- [Suite manager](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/manager/SuiteManager.ts): `src/framework/manager/SuiteManager.ts`
- [Excel data](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/ExcelUtil.ts): `src/framework/utils/ExcelUtil.ts`
- [Suite template](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/template/SuiteTemplate.ts): `src/framework/template/SuiteTemplate.ts`

### Web UI automation

- [Shopping UI steps](https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/advantage/steps): `src/advantage/steps`
- [Shopping page objects](https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/advantage/pages): `src/advantage/pages`
- [UI action facade](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/actions/UIActions.ts): `src/framework/playwright/actions/UIActions.ts`
- [Element actions](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/actions/UIElementActions.ts): `src/framework/playwright/actions/UIElementActions.ts`
- [Specialized UI actions](https://github.com/vinaykumarbm/playwright-sample-project/tree/master/src/framework/playwright/actions): `src/framework/playwright/actions`

### API automation

- [REST user steps](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/API/REST/steps/UserSteps.ts): `src/API/REST/steps/UserSteps.ts`
- [REST requests](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/RESTRequest.ts): `src/framework/playwright/API/RESTRequest.ts`
- [REST responses](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/RESTResponse.ts): `src/framework/playwright/API/RESTResponse.ts`
- [SOAP account steps](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/API/SOAP/steps/AccountServiceSteps.ts): `src/API/SOAP/steps/AccountServiceSteps.ts`
- [SOAP requests](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/SOAPRequest.ts): `src/framework/playwright/API/SOAPRequest.ts`
- [SOAP responses](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/playwright/API/SOAPResponse.ts): `src/framework/playwright/API/SOAPResponse.ts`
- [XML parser](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/XMLParserUtil.ts): `src/framework/utils/XMLParserUtil.ts`

### Database and utilities

- [Database steps](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/database/steps/DatabaseStep.ts): `src/database/steps/DatabaseStep.ts`
- [Database utilities](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/DBUtil.ts): `src/framework/utils/DBUtil.ts`
- [PDF validation](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/PDFUtil.ts): `src/framework/utils/PDFUtil.ts`
- [Image comparison](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/utils/ImageComparator.ts): `src/framework/utils/ImageComparator.ts`

### Runtime and results

- [Playwright configuration](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/playwright.config.ts): `playwright.config.ts`
- [Browser selection](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/manager/Browser.ts): `src/framework/manager/Browser.ts`
- [Test listener](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/logger/TestListener.ts): `src/framework/logger/TestListener.ts`
- [Execution logger](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/logger/Logger.ts): `src/framework/logger/Logger.ts`
- [Allure reporting](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/reporter/Allure.ts): `src/framework/reporter/Allure.ts`
- [HTML reporting](https://github.com/vinaykumarbm/playwright-sample-project/blob/master/src/framework/reporter/HTMLReporter.ts): `src/framework/reporter/HTMLReporter.ts`
- **Playwright runner**

### Other components

- **Test engineer**
- **Shopping website**
- **REST service**
- **SOAP service**
- **Database systems**

## Connections

- Test engineer → Suite manager: selects sheet (evidence: `README.md`)
- Suite manager → Excel data: reads test list (evidence: `src/framework/manager/SuiteManager.ts`)
- Suite manager → Suite template: uses template (evidence: `src/framework/manager/SuiteManager.ts`)
- Test engineer → Playwright runner: runs suite (evidence: `README.md`)
- Playwright configuration → Browser selection: selects browser (evidence: `playwright.config.ts`)
- Playwright configuration → Test listener: registers reporter (evidence: `playwright.config.ts`)
- Playwright configuration → Allure reporting: configures reporting (evidence: `playwright.config.ts`)
- Playwright configuration → HTML reporting: configures reporting (evidence: `playwright.config.ts`)
- Test listener → Execution logger: writes logs (evidence: `src/framework/logger/TestListener.ts`)
- UI action facade → Element actions: delegates actions (evidence: `src/framework/playwright/actions/UIActions.ts`)
- UI action facade → Specialized UI actions: configures helpers (evidence: `src/framework/playwright/actions/UIActions.ts`)
- Shopping UI steps → Shopping website: automates UI (evidence: `README.md`)
- REST requests → REST responses: builds response (evidence: `src/framework/playwright/API/RESTRequest.ts`)
- REST user steps → REST service: tests REST API (evidence: `README.md`)
- SOAP account steps → SOAP service: tests SOAP API (evidence: `README.md`)
- SOAP responses → XML parser: uses parser (evidence: `src/framework/playwright/API/SOAPResponse.ts`)
- Database steps → Database systems: supports database tests (evidence: `README.md`)
- Test engineer → PDF validation: validates PDFs (evidence: `README.md`)
- Test engineer → Image comparison: compares images
