Query param & path param equivalence

Author: mathare

src/test/java/com/typicode/jsonplaceholder/features/Posts.feature

@@ -184,3 +184,9 @@ Feature: Posts Endpoint
       | 0   |
       | 101 |
       | -1  |
+
+  Scenario: Path parameter equivalent to id query parameter
+    When I make a GET request to the Posts endpoint with a path parameter of 1
+    And I make a GET request to the Posts endpoint with an "id" query parameter of 1
+    Then the two response bodies are identical
+

src/test/java/com/typicode/jsonplaceholder/helpers/RequestHelpers.java

@@ -5,6 +5,9 @@
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
 
 public class RequestHelpers {
 
@@ -64,4 +67,17 @@ public static HttpResponse<String> sendDeleteRequestTo(String endpoint) {
             return null;
         }
     }
+
+    public static String buildQueryParamsString(Map<String, String> params) {
+        StringBuilder paramString = new StringBuilder();
+        if (params.size() > 0) {
+            List<String> keys = new ArrayList<>(params.keySet());
+            for (String key : keys) {
+                paramString.append("&").append(key).append("=").append(params.get(key));
+            }
+            //Strip off initial &=
+            paramString.substring(2);
+        }
+        return "?" + paramString;
+    }
 }

src/test/java/com/typicode/jsonplaceholder/steps/CommonSteps.java

@@ -15,6 +15,7 @@
 import java.net.http.HttpResponse;
 import java.nio.file.Files;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -102,6 +103,13 @@ public static void makeRequestWithBody(String requestType, String endpoint, int
         responses.add(response);
     }
 
+    @When("^I make a GET request to the (Posts|Comments|Albums|Photos|ToDos|Users) endpoint with an? \"(.*)\" query parameter of (.*)$")
+    public static void makeGetRequestWithQueryParameter(String endpoint, String key, String value) {
+        Map<String, String> params = new HashMap<>();
+        params.put(key, value);
+        response = RequestHelpers.sendGetRequestTo(endpoints.get(endpoint) + RequestHelpers.buildQueryParamsString(params));
+        responses.add(response);
+    }
 
     @Then("the response has a status code of {int}")
     public static void verifyResponseStatusCode(int code) {
@@ -156,5 +164,16 @@ public static void verifyResponseBodyIsEmptyJSONObject() {
         assertEquals(new JSONObject().toString(), response.body());
     }
 
-
+    @Then("the two response bodies are identical")
+    public static void verifyResponseBodiesMatch() {
+        String[] responseBodies = {responses.get(responses.size() - 2).body(), responses.get(responses.size() - 1).body()};
+        for (int i = 0; i < responseBodies.length; i++) {
+            if (responseBodies[i].startsWith("[")) {
+                responseBodies[i] = new JSONArray(responseBodies[i]).get(0).toString();
+            } else {
+                responseBodies[i] = new JSONObject((responseBodies[i])).toString();
+            }
+        }
+        assertEquals(responseBodies[0], responseBodies[1]);
+    }
 }