rework grpc

Author: skuznetsov-al

allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java

@@ -45,7 +45,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-
 /**
  * Allure interceptor logger for gRPC.
  *
@@ -132,6 +131,22 @@ public void sendMessage(final T message) {
         };
     }
 
+    private void addRawJsonAttachment(
+        final String stepUuid,
+        final String attachmentName,
+        final String jsonBody,
+        final AllureLifecycle lifecycle
+    ) {
+        if (jsonBody == null || jsonBody.isEmpty()) {
+            return;
+        }
+        final String source = UUID.randomUUID() + ".json";
+        lifecycle.updateStep(stepUuid, step -> step.getAttachments().add(
+            new Attachment().setName(attachmentName).setSource(source).setType("application/json")
+        ));
+        lifecycle.writeAttachment(source, new ByteArrayInputStream(jsonBody.getBytes(StandardCharsets.UTF_8)));
+    }
+
     private static final class StepContext<T, R> {
         final String stepUuid;
         final MethodDescriptor<T, R> methodDescriptor;
@@ -226,6 +241,7 @@ private <T, R> void attachRequestIfPresent(
             .setBody(body)
             .build();
         addRenderedAttachmentToStep(stepUuid, requestAttachment.getName(), requestAttachment, requestTemplatePath, lifecycle);
+        addRawJsonAttachment(stepUuid, name + " (json)", body, lifecycle);
     }
 
     private void attachResponse(
@@ -259,6 +275,9 @@ private void attachResponse(
         final GrpcResponseAttachment responseAttachment = builder.build();
         addRenderedAttachmentToStep(stepUuid, responseAttachment.getName(),
             responseAttachment, responseTemplatePath, lifecycle);
+        if (body != null) {
+            addRawJsonAttachment(stepUuid, name + " (json)", body, lifecycle);
+        }
     }
 
     private void stopStepSafely(final AllureLifecycle lifecycle, final String stepUuid) {

allure-grpc/src/test/java/io/qameta/allure/grpc/AllureGrpcTest.java

@@ -14,6 +14,7 @@
  *  limitations under the License.
  */
 package io.qameta.allure.grpc;
+
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.grpc.ManagedChannel;
@@ -24,6 +25,7 @@
 import io.qameta.allure.Allure;
 import io.qameta.allure.model.Attachment;
 import io.qameta.allure.model.StepResult;
+import io.qameta.allure.model.TestResult;
 import io.qameta.allure.test.AllureResults;
 import org.grpcmock.GrpcMock;
 import org.grpcmock.junit5.GrpcMockExtension;
@@ -77,7 +79,7 @@ void configureMockServer() {
             .willReturn(Response.newBuilder().setMessage(RESPONSE_MESSAGE).build()));
 
         GrpcMock.stubFor(bidiStreamingMethod(TestServiceGrpc.getCalculateBidiStreamMethod())
-            .willProxyTo(responseObserver -> new StreamObserver<>() {
+            .willProxyTo(responseObserver -> new StreamObserver<Request>() {
                 @Override
                 public void onNext(Request request) {
                     responseObserver.onNext(Response.newBuilder().setMessage(RESPONSE_MESSAGE).build());
@@ -174,10 +176,10 @@ void shouldCreateAttachmentsForClientStreamingWithAsynchronousStub() {
             TestServiceGrpc.TestServiceStub asynchronousStub =
                 TestServiceGrpc.newStub(managedChannel).withInterceptors(new AllureGrpc());
 
-            final List<Response> receivedResponses = new ArrayList<>();
+            final List<Response> receivedResponses = new ArrayList<Response>();
 
             Allure.step("async-root-client-stream", () -> {
-                StreamObserver<Response> responseObserver = new StreamObserver<>() {
+                StreamObserver<Response> responseObserver = new StreamObserver<Response>() {
                     @Override
                     public void onNext(Response value) {
                         receivedResponses.add(value);
@@ -213,7 +215,7 @@ void shouldCreateAttachmentsForBidirectionalStreamingWithAsynchronousStub() {
             List<Response> receivedResponses = new ArrayList<>();
 
             Allure.step("async-root-bidi-stream", () -> {
-                StreamObserver<Response> responseObserver = new StreamObserver<>() {
+                StreamObserver<Response> responseObserver = new StreamObserver<Response>() {
                     @Override public void onNext(Response value) { receivedResponses.add(value); }
                     @Override public void onError(Throwable throwable) { }
                     @Override public void onCompleted() { }
@@ -245,8 +247,7 @@ void unaryRequestBodyIsCapturedAsJsonObject() throws Exception {
             assertThat(response.getMessage()).isEqualTo("ok");
         });
 
-        String attachmentHtmlContent = readAttachmentContentByName(allureResults, "gRPC request");
-        String jsonPayload = extractJsonPayload(attachmentHtmlContent);
+        String jsonPayload = readJsonAttachmentByName(allureResults, "gRPC request (json)");
         JsonNode actualJsonNode = JSON.readTree(jsonPayload);
         JsonNode expectedJsonNode = JSON.createObjectNode().put("topic", "topic-1");
 
@@ -267,8 +268,7 @@ void unaryResponseBodyIsCapturedAsJsonObject() throws Exception {
             assertThat(response.getMessage()).isEqualTo("hello-world");
         });
 
-        String attachmentHtmlContent = readAttachmentContentByName(allureResults, "gRPC response");
-        String jsonPayload = extractJsonPayload(attachmentHtmlContent);
+        String jsonPayload = readJsonAttachmentByName(allureResults, "gRPC response (json)");
         JsonNode actualJsonNode = JSON.readTree(jsonPayload);
         JsonNode expectedJsonNode = JSON.createObjectNode().put("message", "hello-world");
 
@@ -296,18 +296,33 @@ void serverStreamingResponseBodyIsJsonArrayInOrder() throws Exception {
             assertThat(responseIterator.hasNext()).isFalse();
         });
 
-        String attachmentHtmlContent = readAttachmentContentByName(
-            allureResults,
-            "gRPC response (collection of elements from Server stream)"
+        String jsonPayload = readJsonAttachmentByName(
+            allureResults, "gRPC response (collection of elements from Server stream) (json)"
         );
-        String jsonPayload = extractJsonPayload(attachmentHtmlContent);
         JsonNode actualJsonArray = JSON.readTree(jsonPayload);
 
         assertThat(actualJsonArray.isArray()).isTrue();
         assertThat(actualJsonArray.size()).isEqualTo(2);
         assertThat(actualJsonArray.get(0)).isEqualTo(JSON.createObjectNode().put("message", "first"));
         assertThat(actualJsonArray.get(1)).isEqualTo(JSON.createObjectNode().put("message", "second"));
     }
+    private static String readJsonAttachmentByName(AllureResults allureResults, String jsonAttachmentName) {
+        TestResult test = allureResults.getTestResults().get(0);
+
+        Attachment matchedAttachment = flattenSteps(test.getSteps()).stream()
+            .flatMap(step -> step.getAttachments().stream())
+            .filter(attachment -> jsonAttachmentName.equals(attachment.getName()))
+            .findFirst()
+            .orElseThrow(() -> new IllegalStateException("Attachment not found: " + jsonAttachmentName));
+
+        String attachmentSourceKey = matchedAttachment.getSource();
+        Map<String, byte[]> attachmentsContent = allureResults.getAttachments();
+        byte[] rawAttachmentContent = attachmentsContent.get(attachmentSourceKey);
+        if (rawAttachmentContent == null) {
+            throw new IllegalStateException("Attachment content not found by source: " + attachmentSourceKey);
+        }
+        return new String(rawAttachmentContent, StandardCharsets.UTF_8);
+    }
 
     protected final AllureResults executeUnary(Request request) {
         return runWithinTestContext(() -> {
@@ -352,111 +367,6 @@ protected final AllureResults executeUnaryExpectingException(Request request) {
         );
     }
 
-    private static String readAttachmentContentByName(AllureResults allureResults, String attachmentName) {
-        var test = allureResults.getTestResults().get(0);
-
-        Attachment matchedAttachment = flattenSteps(test.getSteps()).stream()
-            .flatMap(step -> step.getAttachments().stream())
-            .filter(attachment -> attachmentName.equals(attachment.getName()))
-            .findFirst()
-            .orElseThrow(() -> new IllegalStateException("Attachment not found: " + attachmentName));
-
-        String attachmentSourceKey = matchedAttachment.getSource();
-        Map<String, byte[]> attachmentsContent = allureResults.getAttachments();
-        byte[] rawAttachmentContent = attachmentsContent.get(attachmentSourceKey);
-        if (rawAttachmentContent == null) {
-            throw new IllegalStateException("Attachment content not found by source: " + attachmentSourceKey);
-        }
-        return new String(rawAttachmentContent, StandardCharsets.UTF_8);
-    }
-
-    private static String extractJsonPayload(String htmlContent) {
-        String textWithoutHtml = stripHtmlTags(unescapeHtml(htmlContent));
-        int fullLength = textWithoutHtml.length();
-        for (int currentIndex = 0; currentIndex < fullLength; currentIndex++) {
-            char currentChar = textWithoutHtml.charAt(currentIndex);
-            if (currentChar == '{' || currentChar == '[') {
-                int matchingBracketIndex = findMatchingBracket(textWithoutHtml, currentIndex);
-                if (matchingBracketIndex > currentIndex) {
-                    String candidateJson = textWithoutHtml.substring(currentIndex, matchingBracketIndex + 1).trim();
-                    if (looksLikeJson(candidateJson) && canParseJson(candidateJson)) {
-                        return candidateJson;
-                    }
-                }
-            }
-        }
-        throw new IllegalStateException("JSON payload not found or not valid inside attachment");
-    }
-
-    private static boolean canParseJson(String candidateJson) {
-        try {
-            JSON.readTree(candidateJson);
-            return true;
-        } catch (Exception ignore) {
-            return false;
-        }
-    }
-
-    private static boolean looksLikeJson(String input) {
-        if (input == null) {
-            return false;
-        }
-        String trimmed = input.trim();
-        if (!(trimmed.startsWith("{") || trimmed.startsWith("["))) {
-            return false;
-        }
-        return trimmed.matches("(?s).*\"[^\"]+\"\\s*:\\s*.*");
-    }
-
-    private static int findMatchingBracket(String input, int startIndex) {
-        char openingBracket = input.charAt(startIndex);
-        char closingBracket = (openingBracket == '{') ? '}' : ']';
-        int nestingDepth = 0;
-        boolean insideString = false;
-        for (int index = startIndex; index < input.length(); index++) {
-            char symbol = input.charAt(index);
-            if (symbol == '"' && (index == 0 || input.charAt(index - 1) != '\\')) {
-                insideString = !insideString;
-            }
-            if (insideString) {
-                continue;
-            }
-            if (symbol == openingBracket) {
-                nestingDepth++;
-            } else if (symbol == closingBracket) {
-                nestingDepth--;
-                if (nestingDepth == 0) {
-                    return index;
-                }
-            }
-        }
-        return -1;
-    }
-
-    private static String stripHtmlTags(String input) {
-        String withoutTags = input.replaceAll("(?is)<script.*?</script>", "")
-            .replaceAll("(?is)<style.*?</style>", "")
-            .replaceAll("(?s)<[^>]*>", " ");
-        return withoutTags
-            .replace("\r", " ")
-            .replace("\n", " ")
-            .replaceAll("[ \\t\\x0B\\f\\r]+", " ")
-            .trim();
-    }
-
-    private static String unescapeHtml(String input) {
-        return input.replace("&quot;", "\"")
-            .replace("&lt;", "<")
-            .replace("&gt;", ">")
-            .replace("&amp;", "&")
-            .replace("&#123;", "{")
-            .replace("&#125;", "}")
-            .replace("&#91;", "[")
-            .replace("&#93;", "]")
-            .replace("&#58;", ":")
-            .replace("&#44;", ",");
-    }
-
     private static List<StepResult> flattenSteps(List<StepResult> rootSteps) {
         List<StepResult> allSteps = new ArrayList<>();
         if (rootSteps == null) {

allure-grpc/src/test/proto/api.proto

@@ -6,6 +6,8 @@ option java_package = "io.qameta.allure.grpc";
 service TestService {
   rpc Calculate (Request) returns (Response);
   rpc CalculateServerStream (Request) returns (stream Response);
+  rpc CalculateClientStream   (stream Request)        returns (Response);
+  rpc CalculateBidiStream     (stream Request)        returns (stream Response);
 }
 
 message Request {