Skip to content

Fix NPE for gRPC empty stream #973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix NPE for gRPC empty stream #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd55910
fix NPE when for gRPC stream method was called complete without any o…
EveryAndrey Oct 19, 2023
4f18c1f
Merge branch 'master' into allure-grpc-empty-stream-response
EveryAndrey Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 51 additions & 40 deletions allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public <T, A> ClientCall<T, A> interceptCall(MethodDescriptor<T, A> method,
next.newCall(method, callOptions.withoutWaitForReady())) {

private String stepUuid;
private List<String> parsedResponses = new ArrayList<>();
private final List<String> parsedResponses = new ArrayList<>();

@SuppressWarnings("PMD.MethodArgumentCouldBeFinal")
@Override
Expand Down Expand Up @@ -138,49 +138,60 @@ protected Listener<A> delegate() {
@SuppressWarnings({"PMD.MethodArgumentCouldBeFinal", "PMD.AvoidLiteralsInIfCondition"})
@Override
public void onClose(io.grpc.Status status, Metadata trailers) {
GrpcResponseAttachment.Builder responseAttachmentBuilder = null;

if (parsedResponses.size() == 1) {
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create("gRPC response")
.setBody(parsedResponses.iterator().next());
} else if (parsedResponses.size() > 1) {
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create("gRPC response (collection of elements from Server stream)")
.setBody("[" + String.join(",\n", parsedResponses) + "]");
}
if (!status.isOk()) {
String description = status.getDescription();
if (description == null) {
description = "No description provided";
try {
GrpcResponseAttachment.Builder responseAttachmentBuilder;

if (parsedResponses.isEmpty()) {
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create("gRPC response (empty stream)");
} else if (parsedResponses.size() == 1) {
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create("gRPC response")
.setBody(parsedResponses.iterator().next());
} else {
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create("gRPC response (collection of elements from Server stream)")
.setBody("[" + String.join(",\n", parsedResponses) + "]");
}
if (!status.isOk()) {
String description = status.getDescription();
if (description == null) {
description = "No description provided";
}
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create(status.getCode().name())
.setStatus(description);
}
responseAttachmentBuilder = GrpcResponseAttachment.Builder
.create(status.getCode().name())
.setStatus(description);
}

requireNonNull(responseAttachmentBuilder).setStatus(status.toString());
if (interceptResponseMetadata) {
for (String key : headers.keys()) {
requireNonNull(responseAttachmentBuilder).setMetadata(
key,
headers.get(Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER))
);
requireNonNull(responseAttachmentBuilder).setStatus(status.toString());
if (interceptResponseMetadata) {
for (String key : headers.keys()) {
requireNonNull(responseAttachmentBuilder).setMetadata(
key,
headers.get(Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER))
);
}
}
processor.addAttachment(
requireNonNull(responseAttachmentBuilder).build(),
new FreemarkerAttachmentRenderer(responseTemplatePath)
);

if (status.isOk() || !markStepFailedOnNonZeroCode) {
Allure.getLifecycle().updateStep(stepUuid, step -> step.setStatus(Status.PASSED));
} else {
Allure.getLifecycle().updateStep(stepUuid, step -> step.setStatus(Status.FAILED));
}
} catch (RuntimeException e) {
Allure.getLifecycle().updateStep(step ->
step.setStatus(ResultsUtils.getStatus(e).orElse(Status.BROKEN))
.setStatusDetails(ResultsUtils.getStatusDetails(e).orElse(null))
);
} finally {
Allure.getLifecycle().stopStep(stepUuid);
stepUuid = null;
super.onClose(status, trailers);
}
processor.addAttachment(
requireNonNull(responseAttachmentBuilder).build(),
new FreemarkerAttachmentRenderer(responseTemplatePath)
);

if (status.isOk() || !markStepFailedOnNonZeroCode) {
Allure.getLifecycle().updateStep(stepUuid, step -> step.setStatus(Status.PASSED));
} else {
Allure.getLifecycle().updateStep(stepUuid, step -> step.setStatus(Status.FAILED));
}
Allure.getLifecycle().stopStep(stepUuid);
stepUuid = null;
super.onClose(status, trailers);
}

@SuppressWarnings("PMD.MethodArgumentCouldBeFinal")
Expand Down
19 changes: 19 additions & 0 deletions allure-grpc/src/test/java/io/qameta/allure/grpc/AllureGrpcTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import io.grpc.ManagedChannelBuilder;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.stub.CallStreamObserver;
import io.grpc.stub.StreamObservers;
import io.qameta.allure.model.Attachment;
import io.qameta.allure.model.StepResult;
import io.qameta.allure.test.AllureResults;
Expand All @@ -30,6 +32,7 @@
import org.junit.jupiter.api.extension.ExtendWith;

import java.util.Iterator;
import java.util.List;
import java.util.Optional;

import static io.qameta.allure.test.RunUtils.runWithinTestContext;
Expand Down Expand Up @@ -114,6 +117,22 @@ void shouldCreateResponseAttachmentForServerStreamingResponse() {
.contains("gRPC response (collection of elements from Server stream)");
}

@Test
void shouldCreateResponseAttachmentForEmptyServerStreamingResponse() {
GrpcMock.stubFor(serverStreamingMethod(TestServiceGrpc.getCalculateServerStreamMethod())
.willProxyTo((request, responseStreamObserver) ->
StreamObservers.copyWithFlowControl(
List.of(), (CallStreamObserver<Response>) responseStreamObserver))
);

var results = executeStreaming(Request.newBuilder().setTopic("1").build());

assertThat(results.getTestResults().get(0).getSteps())
.flatExtracting(StepResult::getAttachments)
.extracting(Attachment::getName)
.contains("gRPC response (empty stream)");
}

@Test
void shouldCreateResponseAttachmentOnStatusException() {
final Status status = Status.NOT_FOUND;
Expand Down