# hemanshuchauhan/restassured-cucumber-framework architecture

> Architecture diagram of the GitHub repository hemanshuchauhan/restassured-cucumber-framework, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hemanshuchauhan/restassured-cucumber-framework
- Repository: https://github.com/hemanshuchauhan/restassured-cucumber-framework

## Overview

##### Project Type and Purpose
- This project is not a traditional “full‐stack app” but an automation test suite (open‐source tool) built in Java using Cucumber, Rest Assured, and JUnit/Gradle (or Maven).
- Its sole purpose is to execute BDD‐style tests (feature files) against the external Swagger Petstore REST API and produce HTML/XML reports.

##### File Structure Analysis
- Top‐level build files: build.gradle, pom.xml, settings.gradle → indicates support for both Gradle and Maven.
- src/test/java/endpoints → wrapper classes for each API resource (PetEndpoint, OrderEndpoint, UserEndpoint).
- src/test/java/model → POJOs that mirror request/response payloads (Pet, Order, User, Tag, Category).
- src/test/java/stepdefs → Cucumber step definitions that glue feature steps to Java code (CommonDefinitions, *EndpointStepDefinitions, World).
- src/test/resources → Cucumber feature files (OrderTests.feature, PetTests.feature, UserTests.feature).
- Reports under build/reports/tests/test and build/test-results → result artifacts (HTML, XML, binary).

##### Key Insights from README
- Twelve scenarios defined with tags (e.g., @smokeTest).
- Execution invoked via “gradle clean test” or “mvn clean test.”
- Report output path described.
- External dependency: the publicly available Swagger Petstore API.

##### Main Components & Their Relationships
a. Test Runner Layer
- JUnit + Cucumber Engine orchestrates execution.
- Reads feature files and spins up scenarios tagged as @smokeTest.
b. BDD Layer
- Feature Files (.feature) define behavior.
- Step Definitions map Gherkin steps to Java methods.
c. Service Client Layer
- Endpoint classes encapsulate HTTP operations using Rest Assured.
- Model classes serialize/deserialize JSON payloads.
d. External System
- Swagger Petstore REST API (hosted externally).
e. Report Generator
- Cucumber/JUnit reporters produce HTML, XML, and binary results under build/reports and build/test-results.

Data Flow:
Feature File → Cucumber Runner → Step Definition → Endpoint call (Rest Assured + Model) → External API → Response → Assertions in Step Definition → Test Result → Report Generator

##### Architectural Patterns & Design Principles
- Layered Test Architecture:
1. Presentation: Cucumber feature files (Gherkin).
2. Glue: Step Definitions.
3. Service Abstraction: Endpoint wrappers.
4. Domain Model: POJOs.
5. Infrastructure: Rest Assured HTTP client, JUnit runner, Gradle/Maven build.
- Single Responsibility: each endpoint class handles one resource.
- Dependency Injection (via Cucumber’s World object) to share state between steps.
- Externalization of test data (feature files).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build Tool Layer
    subgraph "Build Tool (Gradle/Maven)"
        direction TB
        GradleFile["build.gradle"]:::tool
        PomFile["pom.xml"]:::tool
        SettingsFile["settings.gradle"]:::tool
    end

    %% Test Runner Layer
    RunTests["RunCukesTest.java\n(JUnit + Cucumber Runner)"]:::engine

    %% BDD Artifacts
    subgraph "Feature Files" 
        direction TB
        PetFeature(("PetTests.feature")):::feature
        OrderFeature(("OrderTests.feature")):::feature
        UserFeature(("UserTests.feature")):::feature
    end

    %% Glue Code Layer
    subgraph "Step Definitions\n(src/test/java/stepdefs)" 
        direction TB
        CommonDefs["CommonDefinitions.java"]:::code
        PetStepDefs["PetEndpointStepDefinitions.java"]:::code
        OrderStepDefs["OrderEndpointStepDefinitions.java"]:::code
        UserStepDefs["UserEndpointStepDefinitions.java"]:::code
        WorldContext["World.java"]:::code
    end

    %% Service Abstraction Layer
    subgraph "Endpoint Wrappers\n(src/test/java/endpoints)"
        direction TB
        BaseEndpoints["BaseEndpoints.java"]:::code
        PetEndpoint["PetEndpoint.java"]:::code
        OrderEndpoint["OrderEndpoint.java"]:::code
        UserEndpoint["UserEndpoint.java"]:::code
    end

    RestAssured["Rest Assured HTTP Client"]:::infra

    %% External API
    SwaggerAPI[(Swagger Petstore API)]:::external

    %% Domain Model Layer
    subgraph "Model Classes\n(src/test/java/model)"
        direction TB
        PetModel["Pet.java"]:::model
        OrderModel["Order.java"]:::model
        UserModel["User.java"]:::model
        TagModel["Tag.java"]:::model
        CategoryModel["Category.java"]:::model
    end

    %% Report Generator
    subgraph "Reports"
        direction TB
        HTMLReport[/"index.html"/]:::report
        ClassReports[/"classes/*.html"/]:::report
        XMLReport[/"TEST-*.xml"/]:::report
    end

    %% Execution Flow
    GradleFile -->|invokes| RunTests
    PomFile -->|invokes| RunTests
    SettingsFile -->|invokes| RunTests

    RunTests -->|reads| PetFeature
    RunTests -->|reads| OrderFeature
    RunTests -->|reads| UserFeature

    RunTests -->|glues| CommonDefs
    RunTests -->|glues| PetStepDefs
    RunTests -->|glues| OrderStepDefs
    RunTests -->|glues| UserStepDefs
    RunTests -->|provides| WorldContext

    PetStepDefs -->|invokes| PetEndpoint
    OrderStepDefs -->|invokes| OrderEndpoint
    UserStepDefs -->|invokes| UserEndpoint
    CommonDefs -->|may invoke| BaseEndpoints

    PetEndpoint -->|uses| RestAssured
    OrderEndpoint -->|uses| RestAssured
    UserEndpoint -->|uses| RestAssured
    BaseEndpoints -->|uses| RestAssured

    RestAssured -->|HTTP request| SwaggerAPI
    SwaggerAPI -->|HTTP response| PetModel
    SwaggerAPI -->|HTTP response| OrderModel
    SwaggerAPI -->|HTTP response| UserModel
    SwaggerAPI -->|HTTP response| TagModel
    SwaggerAPI -->|HTTP response| CategoryModel

    PetModel -.->|serializes/deserializes| PetStepDefs
    OrderModel -.->|serializes/deserializes| OrderStepDefs
    UserModel -.->|serializes/deserializes| UserStepDefs

    RunTests -->|produces report| HTMLReport
    RunTests -->|produces report| ClassReports
    RunTests -->|produces report| XMLReport

    %% Click Events
    click GradleFile "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/build.gradle"
    click PomFile "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/pom.xml"
    click SettingsFile "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/settings.gradle"
    click RunTests "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/RunCukesTest.java"
    click PetFeature "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/resources/PetTests.feature"
    click OrderFeature "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/resources/OrderTests.feature"
    click UserFeature "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/resources/UserTests.feature"
    click CommonDefs "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/stepdefs/CommonDefinitions.java"
    click PetStepDefs "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/stepdefs/PetEndpointStepDefinitions.java"
    click OrderStepDefs "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/stepdefs/OrderEndpointStepDefinitions.java"
    click UserStepDefs "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/stepdefs/UserEndpointStepDefinitions.java"
    click WorldContext "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/stepdefs/World.java"
    click BaseEndpoints "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/endpoints/BaseEndpoints.java"
    click PetEndpoint "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/endpoints/PetEndpoint.java"
    click OrderEndpoint "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/endpoints/OrderEndpoint.java"
    click UserEndpoint "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/endpoints/UserEndpoint.java"
    click PetModel "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/model/Pet.java"
    click OrderModel "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/model/Order.java"
    click UserModel "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/model/User.java"
    click TagModel "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/model/Tag.java"
    click CategoryModel "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/src/test/java/model/Category.java"
    click HTMLReport "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/build/reports/tests/test/index.html"
    click ClassReports "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/build/reports/tests/test/classes/*.html"
    click XMLReport "https://github.com/hemanshuchauhan/restassured-cucumber-framework/blob/master/build/test-results/test/TEST-*.xml"

    %% Styles
    classDef tool fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef engine fill:#f0f8ff,stroke:#333,stroke-width:1px
    classDef feature fill:#ccffcc,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
    classDef code fill:#add8e6,stroke:#333,stroke-width:1px
    classDef infra fill:#e6e6fa,stroke:#333,stroke-width:1px,stroke-dasharray: 2 2
    classDef model fill:#add8e6,stroke:#333,stroke-width:1px
    classDef external fill:#ffa500,stroke:#333,stroke-width:1px
    classDef report fill:#dda0dd,stroke:#333,stroke-width:1px,stroke-dasharray: 3 3
```
