allure-framework/allure-java

Allure integrations for Java test frameworks

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.allure-framework:allure-java:2.13.9'
	}

	dependencies {
		implementation("com.github.allure-framework:allure-java:2.13.9")
	}

	<dependency>
	    <groupId>com.github.allure-framework</groupId>
	    <artifactId>allure-java</artifactId>
	    <version>2.13.9</version>
	</dependency>


                            
    libraryDependencies += "com.github.allure-framework" % "allure-java" % "2.13.9"


                            
    :dependencies [[com.github.allure-framework/allure-java "2.13.9"]]

Readme

[license]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License 2.0" [blog]: https://qameta.io/blog [gitter]: https://gitter.im/allure-framework/allure-core [gitter-ru]: https://gitter.im/allure-framework/allure-ru [twitter]: https://twitter.com/QametaSoftware "Qameta Software" [twitter-team]: https://twitter.com/QametaSoftware/lists/team/members "Team"

[CONTRIBUTING.md]: .github/CONTRIBUTING.md [docs]: https://allurereport.org/docs/

Allure Java Integrations

The repository contains new versions of adaptors for JVM-based test frameworks.

Learn more about Allure Report at https://allurereport.org
📚 Documentation – discover official documentation for Allure Report
❓ Questions and Support – get help from the team and community
📢 Official announcements – stay updated with our latest news and updates
💬 General Discussion – engage in casual conversations, share insights and ideas with the community
🖥️ Live Demo — explore a live example of Allure Report in action

TestNG

🚀 Documentation — https://allurereport.org/docs/testng/
📚 Example project — https://github.com/allure-examples?q=topic%3Atestng
✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

JUnit 4

🚀 Documentation — work in progress
📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit4
✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
JUnit 5
🚀 Documentation — https://allurereport.org/docs/junit5/
📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit5
✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

Cucumber JVM

🚀 Documentation — https://allurereport.org/docs/cucumberjvm/
📚 Example project — https://github.com/allure-examples?q=cucumber&type=all&language=java
✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

Spock

🚀 Documentation — https://allurereport.org/docs/spock/
📚 Example project — https://github.com/allure-examples?q=topic%3Aspock
✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

Selenide

Listener for Selenide, that logging steps for Allure:

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-selenide</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

SelenideLogger.addListener("AllureSelenide", new AllureSelenide().screenshots(true).savePageSource(false));

Capture selenium logs:
SelenideLogger.addListener("AllureSelenide", new AllureSelenide().enableLogs(LogType.BROWSER, Level.ALL));
https://github.com/SeleniumHQ/selenium/wiki/Logging

Rest Assured

Filter for rest-assured http client, that generates attachment for allure.

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-rest-assured</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

.filter(new AllureRestAssured())

You can specify custom templates, which should be placed in src/main/resources/tpl folder:

.filter(new AllureRestAssured()
        .withRequestTemplate("custom-http-request.ftl")
        .withResponseTemplate("custom-http-response.ftl"))

OkHttp

Interceptor for OkHttp client, that generates attachment for allure.

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-okhttp3</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

.addInterceptor(new AllureOkHttp3())

You can specify custom templates, which should be placed in src/main/resources/tpl folder:

.addInterceptor(new AllureOkHttp3()
                .withRequestTemplate("custom-http-request.ftl")
                .withResponseTemplate("custom-http-response.ftl"))

gRPC

Interceptor for gRPC stubs, that generates attachment for allure.

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-grpc</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

.newBlockingStub(channel).withInterceptors(new AllureGrpc());

You can enable interception of response metadata (disabled by default)

.withInterceptors(new AllureGrpc()
                .interceptResponseMetadata(true))

By default, a step will be marked as failed in case that response contains any statuses except 0(OK). You can change this behavior, for example, for negative scenarios

.withInterceptors(new AllureGrpc()
                .markStepFailedOnNonZeroCode(false))

You can specify custom templates, which should be placed in src/main/resources/tpl folder:

.withInterceptors(new AllureGrpc()
                .setRequestTemplate("custom-http-request.ftl")
                .setResponseTemplate("custom-http-response.ftl"))

Http client

Interceptors for Apache HTTP client, that generates attachment for allure.

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-httpclient</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

.addInterceptorFirst(new AllureHttpClientRequest())
.addInterceptorLast(new AllureHttpClientResponse());

Http client 5

Interceptors for Apache httpclient5. Additional info can be found in module allure-httpclient5

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-httpclient5</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

final HttpClientBuilder builder = HttpClientBuilder.create()
        .addRequestInterceptorFirst(new AllureHttpClient5Request("your-request-template-attachment.ftl"))
        .addResponseInterceptorLast(new AllureHttpClient5Response("your-response-template-attachment.ftl"));

JAX-RS Filter

Filter that can be used with JAX-RS compliant clients such as RESTeasy and Jersey

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-jax-rs</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

.register(AllureJaxRs.class)

JsonUnit

JsonPatchMatcher is extension of JsonUnit matcher, that generates pretty html attachment for differences based on json diff patch.

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-jsonunit</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Awaitility

Extended logging for poling and ignored exceptions for awaitility. For more usage example look into module allure-awaitility

<dependency>
   <groupId>io.qameta.allure</groupId>
   <artifactId>allure-awaitility</artifactId>
   <version>$LATEST_VERSION</version>
</dependency>

Usage example:

Awaitility.setDefaultConditionEvaluationListener(new AllureAwaitilityListener());

allure-framework/allure-java

Allure integrations for Java test frameworks

Download

Readme

Allure Java Integrations

TestNG

JUnit 4

JUnit 5

Cucumber JVM

Spock

Selenide

Rest Assured

OkHttp

gRPC

Http client

Http client 5

JAX-RS Filter

JsonUnit

Awaitility