Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eataborda/api-rest-assured
REST Assured API automation with Java + Junit5 + Gradle + Allure
https://github.com/eataborda/api-rest-assured
allure-java allure-report allure2 gradle gradle-java gradle-kotlin-dsl gradlew java junit-5 junit-jupiter junit-test junit5 restful
Last synced: 14 days ago
JSON representation
REST Assured API automation with Java + Junit5 + Gradle + Allure
- Host: GitHub
- URL: https://github.com/eataborda/api-rest-assured
- Owner: eataborda
- Created: 2024-09-03T13:59:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T09:16:54.000Z (22 days ago)
- Last Synced: 2024-12-16T03:47:27.339Z (18 days ago)
- Topics: allure-java, allure-report, allure2, gradle, gradle-java, gradle-kotlin-dsl, gradlew, java, junit-5, junit-jupiter, junit-test, junit5, restful
- Language: Java
- Homepage: https://eataborda.github.io/api-rest-assured/
- Size: 3.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/eataborda/api-rest-assured/actions/workflows/api-rest-assured-test-run.yml)
[](https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine)
[](https://mvnrepository.com/artifact/io.rest-assured/rest-assured)
[](https://gradle.org/releases/)
# Basic API automation
Automation using Java + Junit5 + REST-Assured + Gradle
used to test the [Restful-Booker](https://restful-booker.herokuapp.com/) 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:
```shellscript
$ 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](https://restful-booker.herokuapp.com/apidoc/index.html)
### 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.