Cucumber

Cucumber is an Eclipse Java project to test the Rest API. The following libraries / frameworks / plugins / tools have been used:

Rest-Assured to ping the API endpoints.
Maven as the build tool.
JUnit5 and Cucumber for test-case creation.
Jackson2 (by FasterXML) for serialization of Java Objects to JSON.
Maven Wrapper to allow non-maven users the ability to build and run the tests.
Blaze (by Fizzed) to remove the long commands and shorten them for ease of use.
maven-cucumber-reporting (by net.masterthought) for HTML Report generation upon execution of testAllHTML.

Requirements

Java 21

Installation

Download the package from Github and unzip it.

Usage

# To run tests on a single endpoint, use the feature file name as argument
java -jar blaze.jar users

# To test all features
java -jar blaze.jar testAll

# To generate HTML Report per feature
java -jar blaze.jar loginHTML

# To generate HTML Report upon execution of all feature files
java -jar blaze.jar testAllHTML

# To use maven test instead
# Us mvnw.cmd for Windows, mvnw for Linux and Mac
mvnwd.cmd test

# To generate HTML Report using Maven
# Us mvnw.cmd for Windows, mvnw for Linux and Mac
mvnw.cmd verify

Notes

The Rest API has been split into 4 feature files, namely:

login
resources
register
users

Simply provide the feature name to blaze.jar to execute in terminal or append HTML to generate HTML report. The generated HTML report is named after the feature file being executed.

HTML Reports are generated at the following locations:

Upon individual feature file execution at \target\cucumber-reports\.
Upon execution of testAllHTML at \target\cucumber-html-reports\.

When running on Linux / Mac, add executable permissions to mvnw before running any of the commands in the Usage section.

License