Skip to content

README.md

Latest commit

 

History

History
60 lines (44 loc) · 1.5 KB

README.md

File metadata and controls

60 lines (44 loc) · 1.5 KB
Raw

allure-grpc

gRPC client interceptor integration for Allure Java.

Use this module when your tests call gRPC services and you want method calls, metadata, messages, timing, and statuses to appear in Allure Report.

Supported Versions

  • Allure Java 3.x requires Java 17 or newer.
  • This module targets gRPC Java.
  • The current build validates against gRPC Java 1.81.0 and Protobuf Java 4.35.0.

Installation

Gradle:

dependencies {
    testImplementation(platform("io.qameta.allure:allure-bom:<allure-version>"))
    testImplementation("io.qameta.allure:allure-grpc")
}

Maven, with allure-bom imported in dependency management:

<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-grpc</artifactId>
    <scope>test</scope>
</dependency>

Setup

Attach io.qameta.allure.grpc.AllureGrpc to a gRPC channel or stub as a client interceptor.

ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 8080)
        .intercept(new AllureGrpc())
        .usePlaintext()
        .build();

For advanced capture policy, use the constructor that accepts an HTTP exchange builder customizer:

ClientInterceptor allure = new AllureGrpc(
        Allure.getLifecycle(),
        true,
        true,
        exchange -> exchange.redactHeader("authorization")
);

Report Output

  • gRPC method calls as Allure steps.
  • Request and response messages, metadata, status, and timing.
  • Stream metadata for unary and streaming calls where available.