Spark & PDF Extent Report generation for REST Assured

Introduction

This article deals with creation of Spark and PDF Extent Report for REST Assured validation by using a Maven Plugin. The artifact uses a custom filter based on the Allure Framework REST Assured Filter for generating the request and response data. This works with JUnit 4, JUnit 5 and TestNG testing frameworks.

This allows the test code to avoid mixing with Extent calls. All that is required in the code is an addition of a REST Assured filter. The remaining changes are all POM configuration changes.

In addition to the usual test statistics, request and response data is also displayed. These includes body, headers, parameters, cookies and multi-part information.

The article is divided into four sections – Report structure summary, POM configuration, Report generation, Additional report details.

To generate Spark and PDF reports with Cucumber-JVM with Rest Assured execution refer to this article.

Source Code

The source code for the report Maven plugin is located here. The source code for the sample implementations for JUnit 4, JUnit 5 and TestNG. The sample reports for JUnit 4, Junit 5 and TestNG.

In case you are upgrading from version 1.6.0 or lower, you will need to change one dependency in the POM and change the name of the filter. From version 2.0.0 onwards, dependency ‘extent-allure-rest-assured‘ with groupid ‘tech.grasshopper’ will replace the existing ‘allure-rest-assured’ dependency and in the test code, change ‘AllureRestAssuredFilter’ with ‘ExtentRestAssuredFilter‘.

Report Structure Summary

The Spark and Pdf report both use the CLASS Analysis Strategy which broadly means that only two levels of tests are used. In this case the primary level is the test class and the secondary level is the test method. The reports do not take test suites into account.

The report supports the categories, authors and devices view with the help of Allure label custom annotations. The system information or environment data can be displayed with the help of a properties file.

Both the reports are enabled by default. This can be changed in the maven plugin configuration.

Spark Report

The Spark report is enabled by default and this can be disabled with the ‘generateSpark‘ plugin configuration. The ‘sparkConfigFilePath‘ can be used for the report configuration. More details can be found in ‘Maven Report Plugin Configurations’ section below. These are the sample of the Spark report for JUnit 4, JUnit 5 and Test NG.

PDF Report

The Pdf report is enabled by default and this can be disabled with the ‘generatePdf‘ plugin configuration. The ‘pdfConfigFilePath‘ can be used for the report configuration. More details can be found in ‘Maven Report Plugin Configurations’ section below. These are the sample of the PDF report for JUnit 4, JUnit 5 and Test NG.

The configuration options for the report can be found in this article, refer to the ‘Configurations’ section.

POM Configuration

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>rest-assured</artifactId>
    <version>4.4.0</version>
</dependency>

1. Dependency

<dependency>
    <groupId>tech.grasshopper</groupId>
    <artifactId>rest-assured-extent-junit4</artifactId>
    <version>1.0.0</version>
</dependency>

<dependency>
    <groupId>tech.grasshopper</groupId>
    <artifactId>rest-assured-extent-junit5</artifactId>
    <version>1.0.0</version>
</dependency>

<dependency>
    <groupId>tech.grasshopper</groupId>
    <artifactId>rest-assured-extent-testng</artifactId>
    <version>1.0.0</version>
</dependency>

2. Maven Failsafe Plugin Configurations

JUnit4 – Sample configuration can be found here.

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-failsafe-plugin</artifactId>
	<version>3.0.0-M5</version>
	<executions>
		<execution>
			<goals>
				<goal>integration-test</goal>
				<goal>verify</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<systemPropertyVariables>
			<allure.results.directory>${project.build.directory}/allure-results
			</allure.results.directory>
		</systemPropertyVariables>
		<properties>
			<property>
				<name>listener</name>
				<value>io.qameta.allure.junit4.AllureJunit4</value>
			</property>
		</properties>
	</configuration>
</plugin>

JUnit 5 – The configuration is similar to that for JUnit4. The listener property needs to be changed for JUnit 5. Sample configuration can be found here.

<properties>
  <property>
    <name>listener</name>
    <value>io.qameta.allure.junit5.AllureJunit5</value>
  </property>
</properties>

<dependency>
   <groupId>org.junit.jupiter</groupId>     
   <artifactId>junit-jupiter</artifactId>					        
   <version>5.8.1</version>
</dependency>

TestNG – The configuration is similar to that for JUnit 4. There is no need for the listener property which needs to be removed. Sample configuration can be found here.

3. Maven Report Plugin Configurations

<plugin>
	<groupId>tech.grasshopper</groupId>
	<artifactId>rest-assured-extent-report-plugin</artifactId>
	<version>2.1.2</version>
	<executions>
		<execution>
			<id>report</id>
			<phase>post-integration-test</phase>
			<goals>
				<goal>extentreport</goal>
			</goals>
		</execution>
	</executions>
</plugin>

An example of a POM with the below plugin configuration settings can be found here.

Report Generation

In this article, we will be using the publically available REST API for Air Quality data. To access this API, a token is required which can be generated from this page by supplying a valid email id. This token needs to be passed as a query parameter. Feel free to use any other REST API available to you.

1. Extent Allure REST Assured Filter

Below is a snippet from the test class located here. The ExtentRestAssured filter captures the request and response to store them in the allure results directory.

@Categories({ @Category("Cities") })
@Authors({ @Author("John") })
@Devices({ @Device("Computer") })
public class CityAirDataIT {
	@Test
	@Categories({ @Category("Europe") })
	@Devices({ @Device("Mac"), @Device("Windows") })
	public void getLondonAirData() {
		given().param("token", <token>).filter(new ExtentRestAssuredFilter()).cookie("Cookie 1", "cookie one")
		.cookie("Cookie 2", "cookie two").header("Header 1", "header 1").when()
		.get("https://api.waqi.info/feed/london/").then().statusCode(equalTo(200));
	}
}

2. Test Execution

The tests can be executed with the ‘mvn clean install‘ command. The reports will be generated in the designated directory (reportDirectory reportDirectoryTimestamp).

It is advisable to place the allureResultsDirectory inside the project build directory so it can be deleted with the ‘clean‘ command. If the contents of the folder are not deleted then previous execution results will be displayed in the report.

3. Sample Report

Below is a part of the report generated from the execution of the above class. The request and response body contents are displayed as a browser pop up. The headers, cookies, parameters are displayed similarly as pop ups too, in a tabular fashion. These are available as links in the Spark report. In the Pdf report, the details are available by clicking on the pin annotations. The details are shown in a browser pop up. The files are embedded inside the Pdf report and can also be viewed from View -> Navigation Panels -> Attachments.

Report Additional Details

Following are some points which can be helpful in successful report generation.

1. Allure Results Directory

This is set by using the allureResultsDirectory configuration in the report plugin. The default value is ‘target/allure-results‘ directory path. This value also needs to be set as a ‘systemPropertyVariables‘ in the failsafe plugin. There are two points to consider.

First, if changing the value, remember to do it in both places, or better create a property and use it in both the locations.

Second, the contents of this folder need to be deleted before the test execution. Else the report will display results from previous runs. It is advisable to place the results directory in the project build so it gets deleted with the ‘clean‘ command.

2. Configuration File

The default path for the Spark report configuration is ‘src/test/resources/spark-config.xml‘. Place a file with the same name and location, will be picked up automatically. A custom file name and location can be set by using the ‘sparkConfigFilePath‘ configuration. If using a JSON file, this will need to be added.

Similarly for Pdf report the configuration is ‘pdfConfigFilePath‘ and the default value is ‘ src/test/resources/pdf-config.xml ‘.

3. System Info Properties File

The default path for this configuration is ‘src/test/resources/systeminfo.properties‘. Placing a file with the same name and location will be picked up automatically. A custom file name and location can be set by using the ‘systemInfoFilePath‘ configuration.

4. Category, Author, Device Annotation

The category, author and device views are automatically displayed by using these custom annotations. These annotations are based on the Label Allure annotation.

5. Blacklist Request and Response Headers

The header values can be hidden by using the ‘requestHeadersBlacklist’ and ‘responseHeadersBlacklist’ configuration. Multiple values can be added by using a comma delimited string as value. The value will be hidden by using the [BLACKLIST] text.

6. Spark Report View Order

The view order can be changed by using the ‘sparkViewOrder‘ configuration. The comma delimited values are from the ViewName enum. The default order is ‘TEST, CATEGORY, AUTHOR, DEVICE, EXCEPTION, DASHBOARD‘.

7. JUnit 5 Nested Tests

The tests inside a nested test class will be treated as a separate class. The nested tests will not be included in the containing class.