Getting started with Allure REST Assured

Enrich your Allure Report test reports with the detailed information about the HTTP requests performed via REST Assured.

This integration is compatible with all JVM-based adapters of Allure Report, including Allure JUnit 5, Allure Cucumber-JVM, Allure Spock, and more.

To enable the integration in your project:

1. Make sure you have the Allure Report adapter enabled for the test framework you use.

   See the instructions in the adapter's documentation in Frameworks.

2. Add the Allure REST Assured integration to your project's dependencies.

   Maven

   <!-- Define the version of Allure you want to use via the allure.version property -->
   <properties>
       <allure.version>2.25.0</allure.version>
   </properties>
   
   <!-- Add allure-bom to dependency management to ensure correct versions of all the dependencies are used -->
   <dependencyManagement>
   <dependencies>
       <dependency>
           <groupId>io.qameta.allure</groupId>
           <artifactId>allure-bom</artifactId>
           <version>${allure.version}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
   </dependencies>
   </dependencyManagement>
   
   <!-- Add necessary Allure dependencies to dependencies section -->
   <dependencies>
   <dependency>
       <groupId>io.qameta.allure</groupId>
       <artifactId>allure-rest-assured</artifactId>
       <scope>test</scope>
   </dependency>
   </dependencies>

   Gradle (Kotlin)

   // Define the version of Allure you want to use via the allureVersion property
   val allureVersion = "2.25.0"
   // ...
   dependencies {
       // Import allure-bom to ensure correct versions of all the dependencies are used
       testImplementation(platform("io.qameta.allure:allure-bom:$allureVersion"))
       // Add necessary Allure dependencies to dependencies section
       testImplementation("io.qameta.allure:allure-rest-assured")
   }

   Gradle (Groovy)

   // Define the version of Allure you want to use via the allureVersion property
   def allureVersion = "2.25.0"
   
   dependencies {
       // Import allure-bom to ensure correct versions of all the dependencies are used
       testImplementation platform("io.qameta.allure:allure-bom:$allureVersion")
       // Add necessary Allure dependencies to dependencies section
       testImplementation "io.qameta.allure:allure-rest-assured"
   }

3. For every HTTP request you make in your tests, pass an instance of AllureRestAssured to the REST Assured's filter() method.

   The example below shows usage of Allure REST Assured in a JUnit 5 test.

   import io.qameta.allure.restassured.AllureRestAssured;
   import org.junit.jupiter.api.Test;
   
   import static io.restassured.RestAssured.*;
   import static org.hamcrest.Matchers.*;
   
   class TestMyWebsite {
   
       @Test
       void testSomeRequest() {
           given()
                   .filter(new AllureRestAssured())
                   .get("https://jsonplaceholder.typicode.com/todos/1")
                   .then()
                   .body("userId", equalTo(1));
       }
   }

   Both the request and the response will be added to the test results as attachments.

   Some aspects of the AllureRestAssured behavior can be affected via its configuration methods.

4. Run your tests and generate a test report the same way as you would do usually.