Add javadoc to 'UtilTests'

Author: SCastroAdriano

backend/src/test/java/de/itermori/pse/kitroomfinder/backend/BackendApplicationTests.java

@@ -5,19 +5,23 @@
 import com.graphql.spring.boot.test.GraphQLResponse;
 import com.graphql.spring.boot.test.GraphQLTestTemplate;
 import io.micrometer.core.instrument.util.IOUtils;
-import org.json.JSONException;
-import org.skyscreamer.jsonassert.JSONAssert;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.core.io.ClassPathResource;
-
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Calendar;
 import java.util.Date;
+import org.json.JSONException;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.springframework.core.io.ClassPathResource;
 
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 
+/**
+ * Utility class that provides utility methods for the test classes.
+ *
+ * @author Lukas Zetto
+ * @version 1.0
+ */
 public class UtilTests {
 
     static final String GRAPHQL_QUERY_REQUEST_PATH = "graphql/resolver/query/request/%s.graphql";
@@ -32,11 +36,30 @@ private static String read(String location) throws IOException {
                 StandardCharsets.UTF_8);
     }
 
-    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname) throws IOException, JSONException {
+    /**
+     * Validates a GraphQL query.
+     *
+     * @param graphQLTestTemplate   The GraphQL test template.
+     * @param testname              The name of the GraphQL query.
+     * @throws IOException          When the validation of the GraphQL query fails.
+     * @throws JSONException        When the validation of the GraphQL query fails.
+     */
+    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname)
+            throws IOException, JSONException {
         compare(graphQLTestTemplate, testname);
     }
 
-    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname, String user) throws IOException, JSONException {
+    /**
+     * Validates a GraphQL query.
+     *
+     * @param graphQLTestTemplate   The GraphQL test template.
+     * @param testname              The name of the GraphQL query.
+     * @param user                  The name of the user.
+     * @throws IOException          When the validation of the GraphQL query fails.
+     * @throws JSONException        When the validation of the GraphQL query fails.
+     */
+    public static void validate(GraphQLTestTemplate graphQLTestTemplate, String testname, String user)
+            throws IOException, JSONException {
         String token = JWT
                 .create()
                 .withIssuer("my-graphql-api")
@@ -48,10 +71,10 @@ public static void validate(GraphQLTestTemplate graphQLTestTemplate, String test
         compare(graphQLTestTemplate, testname);
     }
 
-    private static void compare(GraphQLTestTemplate graphQLTestTemplate, String testname) throws IOException, JSONException {
+    private static void compare(GraphQLTestTemplate graphQLTestTemplate, String testname)
+            throws IOException, JSONException {
         String expectedResultBody = read(format(GRAPHQL_QUERY_RESPONSE_PATH, testname));
         GraphQLResponse response = graphQLTestTemplate.postForResource(format(GRAPHQL_QUERY_REQUEST_PATH, testname));
-        String test = response.getRawResponse().getBody();
         assertThat(response.isOk()).isTrue();
         JSONAssert.assertEquals(expectedResultBody, response.getRawResponse().getBody(), true);
     }