Updated TestHttpClient and DataMock object to accept json file instead of json string

Author: vitalii-t

src/test/java/io/mailtrap/api/AttachmentsImplTest.java

@@ -5,6 +5,7 @@
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.factory.MailtrapClientFactory;
 import io.mailtrap.model.response.AttachmentResponse;
+import io.mailtrap.testutils.BaseTest;
 import io.mailtrap.testutils.DataMock;
 import io.mailtrap.testutils.TestHttpClient;
 import org.junit.jupiter.api.BeforeEach;
@@ -14,12 +15,7 @@
 
 import static org.junit.jupiter.api.Assertions.*;
 
-class AttachmentsImplTest {
-
-    private final Long accountId = 1L;
-    private final int inboxId = 2;
-    private final Long messageId = 3L;
-    private final Long attachmentId = 4L;
+class AttachmentsImplTest extends BaseTest {
 
     private Attachments api;
 
@@ -30,44 +26,13 @@ public void init() {
                         Constants.GENERAL_HOST + "/api/accounts/" + accountId + "/inboxes/" + inboxId + "/messages/" + messageId + "/attachments",
                         "GET",
                         null,
-                        """
-                                [
-                                  {
-                                    "id": 4,
-                                    "message_id": 3,
-                                    "filename": "test.csv",
-                                    "attachment_type": "inline",
-                                    "content_type": "plain/text",
-                                    "content_id": null,
-                                    "transfer_encoding": null,
-                                    "attachment_size": 1,
-                                    "created_at": "2024-07-20T19:25:54.827Z",
-                                    "updated_at": "2024-07-20T19:25:54.827Z",
-                                    "attachment_human_size": "1 Byte",
-                                    "download_path": "/api/accounts/1/inboxes/2/messages/3/attachments/4/download"
-                                  }
-                                ]"""
+                        "api/attachments/getAttachmentsResponse.json"
                 ),
                 DataMock.build(
                         Constants.GENERAL_HOST + "/api/accounts/" + accountId + "/inboxes/" + inboxId + "/messages/" + messageId + "/attachments/" + attachmentId,
                         "GET",
                         null,
-                        """
-                                  {
-                                    "id": 4,
-                                    "message_id": 3,
-                                    "filename": "test.csv",
-                                    "attachment_type": "inline",
-                                    "content_type": "plain/text",
-                                    "content_id": null,
-                                    "transfer_encoding": null,
-                                    "attachment_size": 1,
-                                    "created_at": "2024-07-20T19:25:54.827Z",
-                                    "updated_at": "2024-07-20T19:25:54.827Z",
-                                    "attachment_human_size": "1 Byte",
-                                    "download_path": "/api/accounts/1/inboxes/2/messages/3/attachments/4/download"
-                                  }
-                                  """
+                        "api/attachments/getAttachmentResponse.json"
                 )
         ));
 

src/test/java/io/mailtrap/testutils/BaseTest.java

@@ -0,0 +1,9 @@
+package io.mailtrap.testutils;
+
+public class BaseTest {
+    protected final Long accountId = 1L;
+    protected final int inboxId = 2;
+    protected final Long messageId = 3L;
+    protected final Long attachmentId = 4L;
+
+}

src/test/java/io/mailtrap/testutils/DataMock.java

@@ -15,29 +15,29 @@ public class DataMock {
     @NonNull
     private final String methodName;
 
-    private final String requestJson;
-    private final String responseJson;
+    private final String requestFile;
+    private final String responseFile;
 
     @NonNull
     private final Map<String, ?> queryParams;
 
-    public static DataMock build(String url, String methodName, String requestJson, String responseJson) {
+    public static DataMock build(String url, String methodName, String requestFile, String responseFile) {
         return new DataMock(
                 url,
                 methodName,
-                requestJson,
-                responseJson,
+                requestFile,
+                responseFile,
                 Collections.emptyMap()
         );
     }
 
-    public static DataMock build(String url, String methodName, String requestJson, String responseJson, Map<String, ?> queryParams) {
+    public static DataMock build(String url, String methodName, String requestFile, String responseFile, Map<String, ?> queryParams) {
         return new DataMock(
                 url,
                 methodName,
-                requestJson,
-                responseJson,
+                requestFile,
+                responseFile,
                 queryParams
         );
     }
-}
+}

src/test/java/io/mailtrap/testutils/TestHttpClient.java

@@ -9,6 +9,9 @@
 import io.mailtrap.model.AbstractModel;
 import org.apache.commons.lang3.StringUtils;
 
+import java.io.BufferedReader;
+import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -91,11 +94,19 @@ private <T, V extends AbstractModel> T requestInternal(String url, String method
 
                 // request
                 if (requestBody != null) {
-                    if (StringUtils.isEmpty(dataMock.getRequestJson())) {
+                    if (StringUtils.isEmpty(dataMock.getRequestFile())) {
                         throw new AssertionError("No mock request body provided: " + requestIdentifier);
                     }
 
-                    boolean sameRequests = dataMock.getRequestJson().equals(requestBody.toJson());
+                    InputStream requestInputStream = this.getClass().getClassLoader().getResourceAsStream(dataMock.getRequestFile());
+
+                    if (requestInputStream == null) {
+                        throw new AssertionError(String.format("Failed to load request mock payload %s for request %s", dataMock.getRequestFile(), requestIdentifier));
+                    }
+
+                    String requestPayloadMock = new BufferedReader(new InputStreamReader(requestInputStream)).lines().collect(Collectors.joining("\n"));
+
+                    boolean sameRequests = Mapper.get().readTree(requestPayloadMock).equals(Mapper.get().readTree(requestBody.toJson()));
 
                     if (!sameRequests && i == dataMocks.size() - 1) {
                         throw new AssertionError("No match for request payload " + requestIdentifier);
@@ -113,14 +124,21 @@ private <T, V extends AbstractModel> T requestInternal(String url, String method
                 if (Void.class.equals(responseClassType)) {
                     return null;
                 }
-                if (StringUtils.isEmpty(dataMock.getResponseJson())) {
+                if (StringUtils.isEmpty(dataMock.getResponseFile())) {
                     throw new AssertionError("No mock response body provided: " + requestIdentifier);
                 }
 
+                InputStream responseInputStream = this.getClass().getClassLoader().getResourceAsStream(dataMock.getResponseFile());
+                if (responseInputStream == null) {
+                    throw new AssertionError("Failed to load response mock payload " + dataMock.getResponseFile() + " for request" + requestIdentifier);
+                }
+                String responsePayloadMock = new BufferedReader(new InputStreamReader(responseInputStream)).lines().collect(Collectors.joining("\n"));
+
+
                 if (responseClassType != null) {
-                    return Mapper.get().readValue(dataMock.getResponseJson(), responseClassType);
+                    return Mapper.get().readValue(responsePayloadMock, responseClassType);
                 } else if (responseJavaType != null) {
-                    return Mapper.get().readValue(dataMock.getResponseJson(), responseJavaType);
+                    return Mapper.get().readValue(responsePayloadMock, responseJavaType);
                 } else {
                     throw new IllegalArgumentException("Both responseType and typeReference are null");
                 }

src/test/resources/api/attachments/getAttachmentResponse.json

@@ -0,0 +1,14 @@
+{
+  "id": 4,
+  "message_id": 3,
+  "filename": "test.csv",
+  "attachment_type": "inline",
+  "content_type": "plain/text",
+  "content_id": null,
+  "transfer_encoding": null,
+  "attachment_size": 1,
+  "created_at": "2024-07-20T19:25:54.827Z",
+  "updated_at": "2024-07-20T19:25:54.827Z",
+  "attachment_human_size": "1 Byte",
+  "download_path": "/api/accounts/1/inboxes/2/messages/3/attachments/4/download"
+}

src/test/resources/api/attachments/getAttachmentsResponse.json

@@ -0,0 +1,16 @@
+[
+  {
+    "id": 4,
+    "message_id": 3,
+    "filename": "test.csv",
+    "attachment_type": "inline",
+    "content_type": "plain/text",
+    "content_id": null,
+    "transfer_encoding": null,
+    "attachment_size": 1,
+    "created_at": "2024-07-20T19:25:54.827Z",
+    "updated_at": "2024-07-20T19:25:54.827Z",
+    "attachment_human_size": "1 Byte",
+    "download_path": "/api/accounts/1/inboxes/2/messages/3/attachments/4/download"
+  }
+]