# hiltas73/bookit-ui-db-api architecture

> Architecture diagram of the GitHub repository hiltas73/bookit-ui-db-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hiltas73/bookit-ui-db-api
- Repository: https://github.com/hiltas73/bookit-ui-db-api

## Overview

##### Project Type and Purpose
- This is an end-to-end automated testing framework built in Java using Selenium, Cucumber (BDD), RestAssured (API), and JDBC/PostgreSQL (DB).
- It validates a reservations application across three layers: UI, API, and Database.

##### File Structure
- src/test/resources/features: Gherkin feature files (UI and API scenarios).
- src/test/java/com/bookit/stepDefinitions: Cucumber step definitions (UIStepDefinitions, APIStepDefinitions, Hooks).
- src/test/java/com/bookit/pages: Page Object Model classes representing UI pages (SignInPage, SelfPage, TopNavigationBar).
- src/test/java/com/bookit/runners: Test runner classes that configure and kick off Cucumber tests.
- src/test/java/com/bookit/utilities: Helpers (Driver singleton, ConfigurationReader, DBUtil, RestAssured wrappers in BookitUtils, BrowserUtils).
- src/test/resources/Environments: environment-specific property files (qa1.properties, qa2.properties, qa3.properties).
- configuration.properties & pom.xml: Maven configuration, dependencies, and default settings.

##### Extract Insights from README
- Uses Page Object Model to encapsulate locators and actions per page.
- Singleton pattern for WebDriver (Driver class).
- BDD via Cucumber: feature files → step definitions → Page Objects/utilities.
- Three testing layers: UI (Selenium), API (RestAssured), DB (JDBC/PostgreSQL).

##### Main Components & Their Relationships
a. Feature Files (Gherkin)
→ consumed by
b. Cucumber Test Runner
→ invokes
c. Step Definitions (UIStep, APIStep)
→ delegate to
d. Page Objects (UI interactions) and API utility methods
→ rely on
e. Utilities
- Driver (Singleton WebDriver)
- ConfigurationReader (environment selection)
- BrowserUtils (common Selenium actions)
- DBUtil (JDBC for PostgreSQL)
- BookitUtils (API calls via RestAssured)
f. External Systems
- Web Application under test (UI endpoints)
- REST API endpoints
- PostgreSQL Database

##### Architectural Patterns & Design Principles
- BDD: Clear separation between feature definitions (behavior) and implementation (step definitions).
- Page Object Model: Encapsulation of page elements and UI actions.
- Singleton: Single WebDriver instance across tests.
- Layered Testing Architecture: UI layer, API layer, DB layer.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Test Orchestration"
        Runner["Runner.java (Test Runner)"]:::core
        FailedRunner["FailedTestRunner.java"]:::core
        Features["Feature Files (UI & API)"]:::artifact
        Hooks["Hooks"]:::artifact
    end

    subgraph "UI Layer"
        UISteps["UIStepDefinitions"]:::artifact
        SignIn["SignInPage (POM)"]:::ui
        SelfPage["SelfPage (POM)"]:::ui
        TopNav["TopNavigationBar (POM)"]:::ui
    end

    subgraph "API Layer"
        APISteps["APIStepDefinitions"]:::artifact
        BookitUtils["BookitUtils (RestAssured)"]:::api
    end

    subgraph "DB Layer"
        DBUtil["DBUtil (JDBC/PostgreSQL)"]:::db
        DB["PostgreSQL DB"]:::db
    end

    subgraph "Core Utilities"
        Driver["Driver (WebDriver Singleton)"]:::core
        ConfigReader["ConfigurationReader"]:::core
        Env["Environment Enum"]:::core
        BrowserUtils["BrowserUtils"]:::core
    end

    subgraph "External Systems"
        WebApp["Web Application"]:::external
        APIEndpoint["REST API Endpoints"]:::external
    end

    Features -->|consumed by| Runner
    Runner -->|executes| UISteps
    Runner -->|executes| APISteps
    Runner -->|before/after| Hooks

    UISteps -->|uses| SignIn
    UISteps -->|uses| SelfPage
    UISteps -->|uses| TopNav

    SignIn -->|calls| Driver
    SelfPage -->|calls| Driver
    TopNav -->|calls| Driver

    Driver -->|drives| WebApp

    APISteps -->|calls| BookitUtils
    BookitUtils -->|calls| APIEndpoint

    APISteps -->|queries| DBUtil
    DBUtil -->|connects to| DB

    ConfigReader -->|provides config to| Driver
    ConfigReader -->|provides config to| BookitUtils
    ConfigReader -->|provides config to| DBUtil
    Env -->|selects| ConfigReader

    BrowserUtils -->|used by| SignIn
    BrowserUtils -->|used by| SelfPage
    BrowserUtils -->|used by| TopNav

    click Features "https://github.com/hiltas73/bookit-ui-db-api/tree/master/src/test/resources/features"
    click Runner "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/runners/Runner.java"
    click FailedRunner "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/runners/FailedTestRunner.java"
    click UISteps "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/stepDefinitions/UIStepDefinitions.java"
    click APISteps "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/stepDefinitions/APIStepDefinitions.java"
    click Hooks "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/stepDefinitions/Hooks.java"
    click SignIn "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/pages/SignInPage.java"
    click SelfPage "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/pages/SelfPage.java"
    click TopNav "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/pages/TopNavigationBar.java"
    click Driver "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/Driver.java"
    click ConfigReader "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/ConfigurationReader.java"
    click Env "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/Environment.java"
    click BrowserUtils "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/BrowserUtils.java"
    click DBUtil "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/DBUtil.java"
    click BookitUtils "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/java/com/bookit/utilities/BookitUtils.java"
    click qa1 "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/resources/Environments/qa1.properties"
    click qa2 "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/resources/Environments/qa2.properties"
    click qa3 "https://github.com/hiltas73/bookit-ui-db-api/blob/master/src/test/resources/Environments/qa3.properties"
    click Pom "https://github.com/hiltas73/bookit-ui-db-api/blob/master/pom.xml"
    click ConfigProp "https://github.com/hiltas73/bookit-ui-db-api/blob/master/configuration.properties"

    classDef ui fill:#D6EAF8,stroke:#3498DB,color:#1B4F72
    classDef api fill:#D5F5E3,stroke:#27AE60,color:#1E8449
    classDef db fill:#FCF3CF,stroke:#F4D03F,color:#B9770E
    classDef core fill:#D5D8DC,stroke:#566573,color:#1C2833
    classDef artifact fill:#FADBD8,stroke:#E74C3C,color:#922B21
    classDef external fill:#E8E8E8,stroke:#BDC3C7,color:#566573
```
