Basic API automation

Automation using Java + Junit5 + REST-Assured + Gradle used to test the Restful-Booker service created by Mark Winteringham, current service introduce intentionally errors on the behavior of the service for study purposes and practice API tests

Contains:

• Basic build.gradle.kts config
• Basic API automation with general validations for the following request methods: POST, GET, PUT, PATCH, DELETE

Use sample project locally

• Verify that you have Git
• Verify that you have Java installed, also that you already setup the following environment variables: $PATH and $JAVA_HOME
• Clone the repository and move inside that path:

$ gh repo clone eataborda/api-rest-assured
$ cd ./api-rest-assured

Before run

Automation was setup to get some environment variables from repository to execute the tests on the workflows, to execute the tests locally is necessary to set first the following environment variables:

$  export USER=admin PASSWORD=password123

Values can be consulted on the following restul-booker apidoc

Run tests

• Run all tests on the src:

$ ./gradlew

• Run all tests inside class using Junit5 tags (@Tags):

$ ./gradlew -DincludeTags="regression"

• Run a specific test method (@Test) inside class using Junit5 tags (@Tag):

$ ./gradlew -DincludeTags="status_code:200"

In this way you can use the following tags depending on the tests you need to run:

health_check, workflow, regression, smoke, get-method, post-method, put-method, patch-method, delete-method, status-code:all, status-code:200, status-code:201, status-code:400, status-code:403, status-code:404, status-code:405, status-code:500

Generate report

Once you have run the tests you can generate the Allure report by running the following command:

$ allure generate build/allure-results --clean

After running the above command successfully you will be able to find the report in the following path: your-project-path/allure-report

Open the report

Locally you can open the report in two ways:

• Using the command:

$ allure open /your-project-path/allure-report

The command starts a local web server and show the report directory's contents. Opens the report in your default browser.

• Opening the report file /your-project-path/allure-report/index.html in the browser of your choice. This shows the static contents of the report directory without starting any local web server.