fix: error during assertion when parsing GraphQL errors

Also added one more test scenario.

Author: BlasiusSecundus

graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestError.java

@@ -12,6 +12,9 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
+
+import static java.util.Objects.nonNull;
 
 /**
  * An implementation of the {@link GraphQLError} interface for testing purposes.
@@ -22,9 +25,27 @@
 @AllArgsConstructor
 public class GraphQLTestError implements GraphQLError {
         private String message;
+        @JsonTypeInfo(defaultImpl = JacksonFriendlySourceLocation.class, use = JsonTypeInfo.Id.CLASS)
         private List<SourceLocation> locations;
         @JsonTypeInfo(defaultImpl = ErrorType.class, use = JsonTypeInfo.Id.CLASS)
         private ErrorClassification errorType;
         private List<Object> path;
         private Map<String, Object> extensions;
+
+        @Override
+        public String toString() {
+            final StringBuilder sb = new StringBuilder();
+            sb.append(Optional.of(message).orElse("Error without error message"));
+            if (nonNull(locations) && !locations.isEmpty()) {
+                sb.append(" at line ");
+                locations.forEach(
+                    location -> sb
+                        .append(location.getLine())
+                        .append(", column ")
+                        .append(location.getColumn()).append(" in ")
+                        .append(Optional.ofNullable(location.getSourceName()).orElse("unnamed/unspecified source."))
+                );
+            }
+            return sb.toString();
+        }
 }

graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/JacksonFriendlySourceLocation.java

@@ -0,0 +1,21 @@
+package com.graphql.spring.boot.test;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import graphql.language.SourceLocation;
+import org.springframework.lang.Nullable;
+
+/**
+ * Allow deserialization of {@link graphql.language.SourceLocation}.
+ */
+public class JacksonFriendlySourceLocation extends SourceLocation {
+
+    @JsonCreator
+    public JacksonFriendlySourceLocation(
+        final @JsonProperty("line") int line,
+        final @JsonProperty("column") int column,
+        final @Nullable @JsonProperty("sourceName") String sourceName
+    ) {
+        super(line, column, sourceName);
+    }
+}

graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/assertions/GraphQLErrorListAssertion.java

@@ -33,7 +33,8 @@ public GraphQLErrorListAssertion(final GraphQLResponse graphQLResponse) {
     public GraphQLResponseAssertion hasNoErrors() {
         final List<? extends GraphQLError> graphQLErrors = getGraphQLErrors(graphQLResponse);
         if (nonNull(graphQLErrors) && !graphQLErrors.isEmpty()) {
-            final String combinedMessage = graphQLErrors.stream().map(GraphQLError::getMessage)
+            final String combinedMessage = graphQLErrors.stream()
+                .map(GraphQLError::toString)
                 .collect(Collectors.joining(System.lineSeparator()));
             fail(String.format("Expected no GraphQL errors, but got %s: %s", graphQLErrors.size(), combinedMessage));
         }

graphql-spring-boot-test/src/test/java/com/graphql/spring/boot/test/GraphQLTestTemplateIntegrationTest.java

@@ -3,17 +3,21 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.graphql.spring.boot.test.beans.FooBar;
+import graphql.GraphQLError;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.web.client.TestRestTemplate;
 import org.springframework.core.io.ResourceLoader;
+import org.springframework.http.HttpHeaders;
 
+import java.awt.*;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
+import java.util.UUID;
 
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 public class GraphQLTestTemplateIntegrationTest {
@@ -22,9 +26,13 @@ public class GraphQLTestTemplateIntegrationTest {
     private static final String SIMPLE_TEST_QUERY_WITH_FRAGMENTS = "simple-test-query-with-fragments.graphql";
     private static final String TEST_FRAGMENT_FILE = "foo-bar-fragment.graphql";
     private static final String QUERY_WITH_VARIABLES = "query-with-variables.graphql";
+    private static final String COMPLEX_TEST_QUERY = "complex-query.graphql";
     private static final String MULTIPLE_QUERIES = "multiple-queries.graphql";
     private static final String INPUT_STRING_VALUE = "input-value";
     private static final String INPUT_STRING_NAME = "input";
+    private static final String INPUT_HEADER_NAME = "headerName";
+    private static final String TEST_HEADER_NAME = "x-test";
+    private static final String TEST_HEADER_VALUE = String.valueOf(UUID.randomUUID());
 
     @Autowired
     private ResourceLoader resourceLoader;
@@ -115,4 +123,33 @@ void testPerformWithOperationName() throws IOException {
             .assertThatNoErrorsArePresent()
             .assertThatField("$.data.otherQuery").asString().isEqualTo("TEST");
     }
+
+    @Test
+    @DisplayName("Test perform with GraphQL errors.")
+    void testPerformWithGraphQLError() throws IOException {
+        graphQLTestTemplate.postForResource(SIMPLE_TEST_QUERY, Collections.singletonList(TEST_FRAGMENT_FILE))
+            .assertThatDataField().isNotPresentOrNull()
+            .and().assertThatNumberOfErrors().isOne()
+            .and().assertThatListOfErrors().extracting(GraphQLError::getMessage)
+                .allMatch(message -> message.contains("UnusedFragment"));
+    }
+
+    @Test
+    @DisplayName("Test perform with all possible inputs.")
+    void testPerformWithAllInputs() throws IOException {
+        // GIVEN
+        final ObjectNode variables = objectMapper.createObjectNode();
+        variables.put(INPUT_STRING_NAME, INPUT_STRING_VALUE);
+        variables.put(INPUT_HEADER_NAME, TEST_HEADER_NAME);
+        final HttpHeaders httpHeaders = new HttpHeaders();
+        httpHeaders.add(TEST_HEADER_NAME, TEST_HEADER_VALUE);
+        // WHEN - THEN
+        graphQLTestTemplate
+            .withHeaders(httpHeaders)
+            .perform(COMPLEX_TEST_QUERY, "complexQuery", variables, Collections.singletonList(TEST_FRAGMENT_FILE))
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.queryWithHeader").asString().isEqualTo(TEST_HEADER_VALUE)
+            .and().assertThatField("$.data.queryWithVariables").asString().isEqualTo(INPUT_STRING_VALUE)
+            .and().assertThatField("$.data.fooBar").as(FooBar.class).isEqualTo(new FooBar("FOO", "BAR"));
+    }
 }

graphql-spring-boot-test/src/test/java/com/graphql/spring/boot/test/beans/DummyQuery.java

@@ -1,6 +1,8 @@
 package com.graphql.spring.boot.test.beans;
 
+import graphql.kickstart.servlet.context.GraphQLServletContext;
 import graphql.kickstart.tools.GraphQLQueryResolver;
+import graphql.schema.DataFetchingEnvironment;
 import org.springframework.stereotype.Service;
 
 import java.util.Optional;
@@ -26,4 +28,12 @@ public FooBar fooBar(String foo, String bar) {
     public String queryWithVariables(final String input) {
         return input;
     }
+
+    public String queryWithHeader(
+        final String headerName,
+        final DataFetchingEnvironment dataFetchingEnvironment
+    ) {
+        return ((GraphQLServletContext) dataFetchingEnvironment.getContext()).getHttpServletRequest()
+            .getHeader(headerName);
+    }
 }

graphql-spring-boot-test/src/test/resources/complex-query.graphql

@@ -0,0 +1,11 @@
+query simpleUnusedQuery {
+    dummy
+}
+
+query complexQuery($input: String!, $headerName: String!) {
+    queryWithHeader(headerName: $headerName)
+    queryWithVariables(input: $input)
+    fooBar {
+        ...FooBarFragment
+    }
+}

graphql-spring-boot-test/src/test/resources/test-schema.graphqls

@@ -16,4 +16,5 @@ type Query {
     otherQuery: String!
     fooBar(foo: String, bar: String): FooBar!
     queryWithVariables(input: String!): String!
+    queryWithHeader(headerName: String!): String
 }