# jaymane862/orangehrmframework architecture

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

- Interactive diagram: https://gitdiagram.com/jaymane862/orangehrmframework
- Repository: https://github.com/jaymane862/orangehrmframework

## Overview

This repository is an OrangeHRM end-to-end test automation framework. Its principal workflow is to execute Cucumber scenarios against the OrangeHRM web application, use Selenium and page-object locators to interact with it, and produce reports or failure screenshots. The README documents BDD, POM, browser support, configuration, reporting, and Jenkins integration. Source excerpts cover only the web and mobile locator classes, so links among the unsampled test components are shown as unverified rather than asserted as observed calls.

Main entry points: [`src/test/java/StepDefinitions`](https://github.com/jaymane862/orangehrmframework/tree/master/src/test/java/StepDefinitions) (Step definitions), [`src/test/java/Common/Runner/TestRunner.java`](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/Runner/TestRunner.java) (Cucumber runner), [`src/test/resources/Features`](https://github.com/jaymane862/orangehrmframework/tree/master/src/test/resources/Features) (BDD features), [`src/test/java/Common/utils/BrowserSetup.java`](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/BrowserSetup.java) (Browser setup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_bdd["BDD execution"]
  node_runner["Cucumber runner<br/>[TestRunner.java]"]
  node_features["BDD features"]
  node_steps["Step definitions"]
  node_hooks["Scenario hooks<br/>[Hooks.java]"]
end

subgraph group_interaction["Browser interaction"]
  node_webpage["Web page locators<br/>[homePage.java]"]
  node_mobilepage["Mobile page object<br/>[homePage.java]"]
  node_actions["Browser actions<br/>[ActionMethods.java]"]
end

subgraph group_support["Test support"]
  node_browser["Browser setup<br/>[BrowserSetup.java]"]
  node_webdriver["WebDriver config"]
  node_base["Test base<br/>[BaseTest.java]"]
  node_excel["Excel data<br/>[ExcelUtilites.java]"]
end

subgraph group_outputs["Results and integration"]
  node_screenshots["Failure screenshots"]
  node_reporting["Extent reporting<br/>[extent.properties]"]
  node_jenkins["Jenkins execution"]
end

node_engineer(("Test maintainer"))
node_app["OrangeHRM"]

node_engineer -.->|"starts tests"| node_runner
node_runner -.->|"runs scenarios"| node_features
node_features -.->|"maps steps"| node_steps
node_steps -.->|"uses actions"| node_actions
node_steps -.->|"uses locators"| node_webpage
node_steps -.->|"uses page object"| node_mobilepage
node_steps -->|"tests application"| node_app
node_hooks -.->|"captures failures"| node_screenshots
node_runner -->|"produces reports"| node_reporting
node_runner -.->|"initializes browser"| node_browser
node_browser -.->|"configures driver"| node_webdriver
node_steps -.->|"uses test data"| node_excel
node_jenkins -->|"executes suite"| node_runner

click node_runner "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/Runner/TestRunner.java"
click node_features "https://github.com/jaymane862/orangehrmframework/tree/master/src/test/resources/Features"
click node_steps "https://github.com/jaymane862/orangehrmframework/tree/master/src/test/java/StepDefinitions"
click node_hooks "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/StepDefinitions/Hooks.java"
click node_webpage "https://github.com/jaymane862/orangehrmframework/blob/master/src/main/java/ObjectRepository/WEB/homePage.java"
click node_mobilepage "https://github.com/jaymane862/orangehrmframework/blob/master/src/main/java/ObjectRepository/MOBILE/homePage.java"
click node_actions "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/Helpers/ActionMethods.java"
click node_browser "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/BrowserSetup.java"
click node_webdriver "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/WebDriverConfig.java"
click node_base "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/BaseTest.java"
click node_excel "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/ExcelUtilites.java"
click node_screenshots "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/ScreenshotUtils.java"
click node_reporting "https://github.com/jaymane862/orangehrmframework/blob/master/src/test/resources/extent.properties"
click node_jenkins "https://github.com/jaymane862/orangehrmframework/blob/master/jenkinsfile"

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_runner,node_features,node_steps,node_hooks toneBlue
class node_webpage,node_mobilepage,node_actions toneAmber
class node_browser,node_webdriver,node_base,node_excel toneMint
class node_screenshots,node_reporting,node_jenkins toneRose
class node_engineer,node_app toneIndigo
```

## Components

### BDD execution

- [Cucumber runner](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/Runner/TestRunner.java): `src/test/java/Common/Runner/TestRunner.java`
- [BDD features](https://github.com/jaymane862/orangehrmframework/tree/master/src/test/resources/Features): `src/test/resources/Features`
- [Step definitions](https://github.com/jaymane862/orangehrmframework/tree/master/src/test/java/StepDefinitions): `src/test/java/StepDefinitions`
- [Scenario hooks](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/StepDefinitions/Hooks.java): `src/test/java/StepDefinitions/Hooks.java`

### Browser interaction

- [Web page locators](https://github.com/jaymane862/orangehrmframework/blob/master/src/main/java/ObjectRepository/WEB/homePage.java): `src/main/java/ObjectRepository/WEB/homePage.java`
- [Mobile page object](https://github.com/jaymane862/orangehrmframework/blob/master/src/main/java/ObjectRepository/MOBILE/homePage.java): `src/main/java/ObjectRepository/MOBILE/homePage.java`
- [Browser actions](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/Helpers/ActionMethods.java): `src/test/java/Common/Helpers/ActionMethods.java`

### Test support

- [Browser setup](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/BrowserSetup.java): `src/test/java/Common/utils/BrowserSetup.java`
- [WebDriver config](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/WebDriverConfig.java): `src/test/java/Common/utils/WebDriverConfig.java`
- [Test base](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/BaseTest.java): `src/test/java/Common/utils/BaseTest.java`
- [Excel data](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/ExcelUtilites.java): `src/test/java/Common/utils/ExcelUtilites.java`

### Results and integration

- [Failure screenshots](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/java/Common/utils/ScreenshotUtils.java): `src/test/java/Common/utils/ScreenshotUtils.java`
- [Extent reporting](https://github.com/jaymane862/orangehrmframework/blob/master/src/test/resources/extent.properties): `src/test/resources/extent.properties`
- [Jenkins execution](https://github.com/jaymane862/orangehrmframework/blob/master/jenkinsfile): `jenkinsfile`

### Other components

- **Test maintainer**
- **OrangeHRM**

## Connections

- Test maintainer → Cucumber runner: starts tests
- Cucumber runner → BDD features: runs scenarios
- BDD features → Step definitions: maps steps
- Step definitions → Browser actions: uses actions
- Step definitions → Web page locators: uses locators
- Step definitions → Mobile page object: uses page object
- Step definitions → OrangeHRM: tests application (evidence: `README.md`)
- Scenario hooks → Failure screenshots: captures failures
- Cucumber runner → Extent reporting: produces reports (evidence: `README.md`)
- Cucumber runner → Browser setup: initializes browser
- Browser setup → WebDriver config: configures driver
- Step definitions → Excel data: uses test data
- Jenkins execution → Cucumber runner: executes suite (evidence: `README.md`)
