feat: #115 Add test messages retrieval methods

Signed-off-by: Laurent Broudoux <laurent.broudoux@gmail.com>

Author: lbroudoux

src/main/java/io/github/microcks/testcontainers/MicrocksContainer.java

@@ -15,9 +15,11 @@
  */
 package io.github.microcks.testcontainers;
 
+import io.github.microcks.testcontainers.model.RequestResponsePair;
 import io.github.microcks.testcontainers.model.Secret;
 import io.github.microcks.testcontainers.model.TestResult;
 import io.github.microcks.testcontainers.model.TestRequest;
+import io.github.microcks.testcontainers.model.UnidirectionalEvent;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.github.dockerjava.api.command.InspectContainerResponse;
@@ -44,9 +46,11 @@
 import java.net.HttpURLConnection;
 import java.net.URL;
 import java.net.URLDecoder;
+import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
@@ -455,6 +459,109 @@ public static TestResult testEndpoint(String microcksContainerHttpEndpoint, Test
       throw new MicrocksException("Couldn't launch on new test on Microcks. Please check Microcks container logs");
    }
 
+
+   /**
+    * Retrieve messages exchanged during a test on an endpoint (for further investigation or checks).
+    * @param testResult The TestResult to get messages for
+    * @param operationName The name of the operation to get messages corresponding to test case
+    * @return The list of RequestResponsePair representing messages exchanged during test case
+    * @throws IOException If connection to Microcks container failed (no route to host, low-level network stuffs)
+    * @throws MicrocksException If Microcks fails retrieving the messages
+    */
+   public List<RequestResponsePair> getMessagesForTestCase(TestResult testResult, String operationName) throws IOException, MicrocksException {
+      return getMessagesForTestCase(getHttpEndpoint(), testResult, operationName);
+   }
+
+   /**
+    * Retrieve messages exchanged during a test on an endpoint. This may be a fallback to non-static {@code getMessagesForTestCase(TestResult testResult, String operationName)}
+    * method if you don't have direct access to the MicrocksContainer instance you want to get messages from.
+    * @param microcksContainerHttpEndpoint The Http endpoint where to reach running MicrocksContainer
+    * @param testResult The TestResult to get messages for
+    * @param operationName The name of the operation to get messages corresponding to test case
+    * @return The list of RequestResponsePair representing messages exchanged during test case
+    * @throws IOException If connection to Microcks container failed (no route to host, low-level network stuffs)
+    * @throws MicrocksException If Microcks fails retrieving the messages
+    */
+   public static List<RequestResponsePair> getMessagesForTestCase(String microcksContainerHttpEndpoint, TestResult testResult, String operationName)
+         throws IOException, MicrocksException {
+
+      // Build the testCase unique identifier.
+      String operation = operationName.replace('/', '!');
+      String testCaseId = testResult.getId() + "-" + testResult.getTestNumber() + "-" + URLEncoder.encode(operation);
+
+      URL url = new URL(microcksContainerHttpEndpoint + "/api/tests/" + testResult.getId() + "/messages/" + testCaseId);
+      HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
+      httpConn.setRequestMethod("GET");
+      httpConn.setRequestProperty(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON.getMediaType());
+      httpConn.setDoOutput(false);
+
+      if (httpConn.getResponseCode() == 200) {
+         // Read response content and disconnect Http connection.
+         StringBuilder responseContent = getResponseContent(httpConn);
+         httpConn.disconnect();
+
+         // Unmarshal and return result.
+         return getMapper().readValue(responseContent.toString(),
+               mapper.getTypeFactory().constructCollectionType(List.class, RequestResponsePair.class));
+      }
+      if (log.isErrorEnabled()) {
+         log.error("Couldn't retrieve messages status {} ", httpConn.getResponseCode());
+      }
+      httpConn.disconnect();
+      throw new MicrocksException("Couldn't retrieve messages on test on Microcks. Please check Microcks container logs");
+   }
+
+   /**
+    * Retrieve event messages received during a test on an endpoint (for further investigation or checks).
+    * @param testResult The TestResult to get event messages for
+    * @param operationName The name of the operation to get event messages corresponding to test case
+    * @return The list of UnidirectionalEvent representing events received during test case
+    * @throws IOException If connection to Microcks container failed (no route to host, low-level network stuffs)
+    * @throws MicrocksException If Microcks fails retrieving the messages
+    */
+   public List<UnidirectionalEvent> getEventMessagesForTestCase(TestResult testResult, String operationName) throws IOException, MicrocksException {
+      return getEventMessagesForTestCase(getHttpEndpoint(), testResult, operationName);
+   }
+
+   /**
+    * Retrieve event messages received during a test on an endpoint. This may be a fallback to non-static {@code getEventMessagesForTestCase(TestResult testResult, String operationName)}
+    * method if you don't have direct access to the MicrocksContainer instance you want to get messages from.
+    * @param microcksContainerHttpEndpoint The Http endpoint where to reach running MicrocksContainer
+    * @param testResult The TestResult to get event messages for
+    * @param operationName The name of the operation to get event messages corresponding to test case
+    * @return The list of UnidirectionalEvent representing events received during test case
+    * @throws IOException If connection to Microcks container failed (no route to host, low-level network stuffs)
+    * @throws MicrocksException If Microcks fails retrieving the event messages
+    */
+   public static List<UnidirectionalEvent> getEventMessagesForTestCase(String microcksContainerHttpEndpoint, TestResult testResult, String operationName)
+         throws IOException, MicrocksException {
+
+      // Build the testCase unique identifier.
+      String operation = operationName.replace('/', '!');
+      String testCaseId = testResult.getId() + "-" + testResult.getTestNumber() + "-" + URLEncoder.encode(operation);
+
+      URL url = new URL(microcksContainerHttpEndpoint + "/api/tests/" + testResult.getId() + "/events/" + testCaseId);
+      HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
+      httpConn.setRequestMethod("GET");
+      httpConn.setRequestProperty(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON.getMediaType());
+      httpConn.setDoOutput(false);
+
+      if (httpConn.getResponseCode() == 200) {
+         // Read response content and disconnect Http connection.
+         StringBuilder responseContent = getResponseContent(httpConn);
+         httpConn.disconnect();
+
+         // Unmarshal and return result.
+         return getMapper().readValue(responseContent.toString(),
+               mapper.getTypeFactory().constructCollectionType(List.class, UnidirectionalEvent.class));
+      }
+      if (log.isErrorEnabled()) {
+         log.error("Couldn't retrieve messages status {} ", httpConn.getResponseCode());
+      }
+      httpConn.disconnect();
+      throw new MicrocksException("Couldn't retrieve messages on test on Microcks. Please check Microcks container logs");
+   }
+
    /**
     * Download a remote artifact as a primary or main one within the Microcks container.
     * @param remoteArtifactUrl The URL to remote artifact (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
@@ -600,6 +707,17 @@ private static ObjectMapper getMapper() {
       return mapper;
    }
 
+   private static StringBuilder getResponseContent(HttpURLConnection httpConn) throws IOException {
+      StringBuilder responseContent = new StringBuilder();
+      try (BufferedReader br = new BufferedReader(new InputStreamReader(httpConn.getInputStream(), StandardCharsets.UTF_8))) {
+         String responseLine;
+         while ((responseLine = br.readLine()) != null) {
+            responseContent.append(responseLine.trim());
+         }
+      }
+      return responseContent;
+   }
+
    private static HttpURLConnection uploadFileToMicrocks(URL microcksApiURL, File file, String contentType) throws IOException {
       // Creates a unique boundary based on time stamp
       String boundary = "===" + System.currentTimeMillis() + "===";

src/main/java/io/github/microcks/testcontainers/model/EventMessage.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright The Microcks Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.github.microcks.testcontainers.model;
+
+/**
+ * A simple event message published or sent in an asynchronous exchange.
+ * @author laurent
+ */
+public class EventMessage extends Message {
+
+   private String id;
+   private String mediaType;
+   private String dispatchCriteria;
+
+   public String getId() {
+      return id;
+   }
+
+   public void setId(String id) {
+      this.id = id;
+   }
+
+   public String getMediaType() {
+      return mediaType;
+   }
+
+   public void setMediaType(String mediaType) {
+      this.mediaType = mediaType;
+   }
+
+   public String getDispatchCriteria() {
+      return dispatchCriteria;
+   }
+
+   public void setDispatchCriteria(String dispatchCriteria) {
+      this.dispatchCriteria = dispatchCriteria;
+   }
+}

src/main/java/io/github/microcks/testcontainers/model/Message.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright The Microcks Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.github.microcks.testcontainers.model;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Base class holding common attributes for Request, Response and EventMessage domain objects.
+ * @author laurent
+ */
+public abstract class Message {
+
+   private String name;
+   private String content;
+   private String operationId;
+   private String testCaseId;
+   private String sourceArtifact;
+
+   private Set<Header> headers;
+
+   public String getName() {
+      return name;
+   }
+
+   public void setName(String name) {
+      this.name = name;
+   }
+
+   public String getContent() {
+      return content;
+   }
+
+   public void setContent(String content) {
+      this.content = content;
+   }
+
+   public String getOperationId() {
+      return operationId;
+   }
+
+   public void setOperationId(String operationId) {
+      this.operationId = operationId;
+   }
+
+   public String getTestCaseId() {
+      return testCaseId;
+   }
+
+   public void setTestCaseId(String testCaseId) {
+      this.testCaseId = testCaseId;
+   }
+
+   public String getSourceArtifact() {
+      return sourceArtifact;
+   }
+
+   public void setSourceArtifact(String sourceArtifact) {
+      this.sourceArtifact = sourceArtifact;
+   }
+
+   public Set<Header> getHeaders() {
+      return headers;
+   }
+
+   public void setHeaders(Set<Header> headers) {
+      this.headers = headers;
+   }
+
+   public void addHeader(Header header) {
+      if (this.headers == null) {
+         this.headers = new HashSet<>();
+      }
+      headers.add(header);
+   }
+}

src/main/java/io/github/microcks/testcontainers/model/Parameter.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright The Microcks Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.github.microcks.testcontainers.model;
+
+/**
+ * Companion objects for Request representing query parameter.
+ * @author laurent
+ */
+public class Parameter {
+
+   private String name;
+   private String value;
+
+   public String getName() {
+      return name;
+   }
+
+   public void setName(String name) {
+      this.name = name;
+   }
+
+   public String getValue() {
+      return value;
+   }
+
+   public void setValue(String value) {
+      this.value = value;
+   }
+}

src/main/java/io/github/microcks/testcontainers/model/Request.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright The Microcks Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.github.microcks.testcontainers.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Domain object representing a Microservice operation / action invocation request.
+ * @author laurent
+ */
+public class Request extends Message {
+
+   private String id;
+   private String responseId;
+
+   private List<Parameter> queryParameters;
+
+   public String getId() {
+      return id;
+   }
+
+   public void setId(String id) {
+      this.id = id;
+   }
+
+   public String getResponseId() {
+      return responseId;
+   }
+
+   public void setResponseId(String responseId) {
+      this.responseId = responseId;
+   }
+
+   public List<Parameter> getQueryParameters() {
+      return queryParameters;
+   }
+
+   public void setQueryParameters(List<Parameter> queryParameters) {
+      this.queryParameters = queryParameters;
+   }
+
+   public void addQueryParameter(Parameter parameter) {
+      if (this.queryParameters == null) {
+         this.queryParameters = new ArrayList<>();
+      }
+      queryParameters.add(parameter);
+   }
+}