Get All Posts test

Author: mathare

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

@@ -0,0 +1,9 @@
+Feature: Posts Endpoint
+
+  Scenario: Get all posts
+    When I make a GET request to the Posts endpoint
+    Then the response has a status code of 200
+    And the response body follows the "GetAllPosts" JSON schema
+    And the results array contains 100 elements
+    And the response body matches the "GetAllPosts" expected response
+

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

@@ -0,0 +1,27 @@
+package com.typicode.jsonplaceholder.helpers;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+
+public class RequestHelpers {
+
+    private static final HttpClient httpClient = HttpClient.newBuilder().build();
+    private static final String BASE_URL = "https://jsonplaceholder.typicode.com";
+
+    public static HttpResponse<String> sendGetRequestTo(String endpoint) {
+        HttpRequest request = HttpRequest.newBuilder()
+                .GET()
+                .uri(URI.create(BASE_URL + endpoint))
+                .build();
+        try {
+            return httpClient.send(request, HttpResponse.BodyHandlers.ofString());
+        } catch (IOException | InterruptedException e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
+
+}

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

@@ -0,0 +1,92 @@
+package com.typicode.jsonplaceholder.steps;
+
+import com.typicode.jsonplaceholder.helpers.RequestHelpers;
+import io.cucumber.datatable.DataTable;
+import io.cucumber.java.Before;
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+import org.everit.json.schema.Schema;
+import org.everit.json.schema.loader.SchemaLoader;
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+import java.io.IOException;
+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;
+
+public class CommonSteps {
+
+    private static final String POSTS_ENDPOINT = "/posts";
+    private static final String COMMENTS_ENDPOINT = "/comments";
+    private static final String ALBUMS_ENDPOINT = "/albums";
+    private static final String PHOTOS_ENDPOINT = "/photos";
+    private static final String TODOS_ENDPOINT = "/todos";
+    private static final String USERS_ENDPOINT = "/users";
+
+    private static final Map<String, String> endpoints = Map.ofEntries(
+            Map.entry("Posts", POSTS_ENDPOINT),
+            Map.entry("Comments", COMMENTS_ENDPOINT),
+            Map.entry("Albums", ALBUMS_ENDPOINT),
+            Map.entry("Photos", PHOTOS_ENDPOINT),
+            Map.entry("ToDos", TODOS_ENDPOINT),
+            Map.entry("Users", USERS_ENDPOINT)
+    );
+
+    private static final String BASE_RESOURCES_DIR = "src/test/resources/";
+    private static final String SCHEMAS_DIR = BASE_RESOURCES_DIR + "schemas/";
+    private static final String EXPECTED_RESPONSES_DIR = BASE_RESOURCES_DIR + "expectedResponses/";
+
+    public static HttpResponse<String> response;
+    public static List<HttpResponse<String>> responses;
+
+    @Before
+    public static void setup() {
+        responses = new ArrayList<>();
+    }
+
+    @When("^I make a GET request to the (Posts|Comments|Albums|Photos|ToDos|Users) endpoint$")
+    public static void makeGetRequest(String endpoint) {
+        response = RequestHelpers.sendGetRequestTo(endpoints.get(endpoint));
+        responses.add(response);
+    }
+    @Then("the response has a status code of {int}")
+    public static void verifyResponseStatusCode(int code) {
+        assertEquals(code, response.statusCode());
+    }
+
+    @Then("the response body follows the {string} JSON schema")
+    public static void verifyResponseBodyAgainstJsonSchema(String type) throws IOException {
+        String filename = SCHEMAS_DIR + type.replaceAll(" ", "") + "Schema.json";
+        String json = Files.readString(new File(filename).toPath());
+        JSONObject schemaObject = new JSONObject(json);
+        Schema expectedSchema = SchemaLoader.load(schemaObject);
+        if (response.body().startsWith("[")) {
+            expectedSchema.validate(new JSONArray(response.body()));
+        } else {
+            expectedSchema.validate(new JSONObject(response.body()));
+        }
+    }
+
+    @Then("the results array contains {int} elements")
+    public static void verifyNumberOfResultsArrayElements(int numElements) {
+        JSONArray results = new JSONArray (response.body());
+        assertEquals(numElements, results.length());
+    }
+
+    @Then("the response body matches the {string} expected response")
+    public static void verifyResponseBodyAgainstExpectedResponse(String type) throws IOException {
+        String filename = EXPECTED_RESPONSES_DIR + type.replaceAll(" ", "") + "Response.json";
+        String json = Files.readString(new File(filename).toPath());
+        assertEquals(json.replace("\r", ""), response.body());
+    }
+
+
+}