added log4j for logging response details, added helper method to print log response details

Author: mfaisalkhatri

pom.xml

@@ -19,6 +19,9 @@
         <lombok-version>1.18.34</lombok-version>
         <datafaker-version>2.3.1</datafaker-version>
         <org-json-verion>20240303</org-json-verion>
+        <jackson-databind-version>2.17.2</jackson-databind-version>
+        <log4j-core-version>2.12.4</log4j-core-version>
+        <log4j-api-version>2.12.4</log4j-api-version>
         <maven-compiler-plugin-version>3.13.0</maven-compiler-plugin-version>
         <maven-surefire-plugin-version>3.3.1</maven-surefire-plugin-version>
         <java-release-version>17</java-release-version>
@@ -54,6 +57,21 @@
             <artifactId>datafaker</artifactId>
             <version>${datafaker-version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind-version}</version>
+        </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-api</artifactId>
+                <version>${log4j-api-version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-core</artifactId>
+                <version>${log4j-core-version}</version>
+            </dependency>
     </dependencies>
     <build>
         <pluginManagement>

src/main/resources/log4j2.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="INFO">
+    <Appenders>
+        <Console name="LogToConsole" target="SYSTEM_OUT">
+            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
+        </Console>
+    </Appenders>
+    <Loggers>
+        <Logger name="io.github.mfaisalkhatri" level="info" additivity="false">
+            <AppenderRef ref="LogToConsole"/>
+        </Logger>
+        <Root level="error">
+            <AppenderRef ref="LogToConsole"/>
+        </Root>
+    </Loggers>
+</Configuration>

src/test/java/io/github/mfaisalkhatri/api/restfulecommerce/APITests.java

@@ -1,7 +1,15 @@
 package io.github.mfaisalkhatri.api.restfulecommerce;
 
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParser;
+import com.microsoft.playwright.APIRequest;
 import com.microsoft.playwright.APIResponse;
+import com.microsoft.playwright.Request;
 import com.microsoft.playwright.options.RequestOptions;
 import io.github.mfaisalkhatri.api.restfulecommerce.testdata.OrderData;
 import org.json.JSONArray;
@@ -19,28 +27,27 @@
 public class APITests extends BaseTest{
 
 
-    private OrderData orderData;
-
-    @BeforeClass
-    public void setupTest() {
-        orderData = getNewOrder();
-    }
     @Test
-    public void testShouldCreateNewOrders() {
+    public void testShouldCreateNewOrders() throws JsonProcessingException {
 
         int totalOrders = 4;
         List<OrderData> orderList = new ArrayList<>();
         for (int i = 0; i < totalOrders; i++) {
-            orderList.add(orderData);
+            orderList.add(getNewOrder());
         }
 
         APIResponse response = request.post("/addOrder", RequestOptions.create()
                 .setData(orderList));
+        Helper helper = new Helper(response);
+
+        helper.logResponseDetails();
+
         assertEquals(response.status(), 201);
 
         final JSONObject responseObject = new JSONObject(response.text());
         final JSONArray ordersArray = responseObject.getJSONArray("orders");
 
+
         assertEquals(responseObject.get("message"), "Orders added successfully!");
         assertNotNull(ordersArray.getJSONObject(0).get("id"));
         assertEquals(orderList.get(0).getUserId(), ordersArray.getJSONObject(0).get("user_id"));
@@ -50,6 +57,7 @@ public void testShouldCreateNewOrders() {
     @Test
     public void testShouldGetAllOrders() {
 
+        
 
 
 

src/test/java/io/github/mfaisalkhatri/api/restfulecommerce/Helper.java

@@ -0,0 +1,41 @@
+package io.github.mfaisalkhatri.api.restfulecommerce;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.microsoft.playwright.APIResponse;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+
+public class Helper {
+
+    private APIResponse response;
+    private Logger log;
+
+    public Helper(APIResponse response) {
+        this.response = response;
+        log = LogManager.getLogger(getClass());
+    }
+
+    public void logResponseDetails() {
+
+        log.info("Response Headers: \n{}",response.headers());
+        log.info("Status Code: {}", response.status());
+        log.info("Response Body: \n{}", prettyPrintJson(response.text()));
+    }
+
+    private String prettyPrintJson(String text) {
+        String prettyPrintJson = "";
+        try {
+            ObjectMapper objectMapper = new ObjectMapper();
+            Object jsonObject = objectMapper.readValue(response.text(), Object.class);
+            prettyPrintJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(jsonObject);
+
+
+        } catch (JsonProcessingException e) {
+            log.error("Error Printing Pretty Json : {}", e.getMessage());
+        }
+        ;
+        return prettyPrintJson;
+    }
+}