Cucumber BDD Framework with Serenity Reports for Rest-API Automation

Overview

This framework is developed using Behavior-Driven Development (BDD) principles with Cucumber and integrated with Serenity Reports. It is designed specifically for automating REST APIs, providing robust reporting and flexibility for handling API responses and requests.

Key Features

Cucumber BDD:

• Enables writing human-readable test scenarios that bridge the gap between non-technical stakeholders and developers.

Serenity Reports:

• Provides detailed, narrative-style test reports with test case histories and visual documentation.

Response Value Reuse:

• The framework allows passing response values from one API request to another. Simply reference the value using the $ symbol as "$key" to inject it into subsequent API requests dynamically.

Comprehensive Logging:

Logs are configured at a high level, printing detailed information for each test scenario, including:

• Scenario name
• Duration
• Execution status (pass/fail)
• Failure cause or error (if any)

Database Integration:

• The framework can push scenario execution details (status, duration, errors) into a database for further analysis and tracking.

Multi-Database Support:

The framework connects with different SQL databases such as:

• Oracle
• DB2
• MySQL This allows for executing queries across various database environments and validating data integrity.

Spring Batch Integration:

• The framework includes a Batches class, which executes Spring Batch jobs for batch processing use cases.

Pre-requisites

• Java 17 or higher
• Maven 3.6v or higher
• Junit 5.0v or higher
• RestAssured 5.4.0v or higher
• Cucumber 7.16v or higher
• Serenity 4.1.4.0v or higher

How to run from cmd line

In the pom.xml, we have configured Serenity reports and run the features by following different commands.

To build the Project

To build the project and download all dependencies, run the whole suite following Maven command:

mvn clean install

To run specific feature, use the following command:

mvn clean install -Dcucumber.features=src/test/resources/features/GoogleAPI/placeValidations.feature