How hemanshuchauhan/restassured-cucumber-framework works
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).