feat: improve to string method of GraphQLTestError; add tests for it

Author: BlasiusSecundus

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

@@ -9,10 +9,12 @@
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
+import org.springframework.util.NumberUtils;
 
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 import static java.util.Objects.nonNull;
 
@@ -35,17 +37,36 @@ public class GraphQLTestError implements GraphQLError {
         @Override
         public String toString() {
             final StringBuilder sb = new StringBuilder();
-            sb.append(Optional.of(message).orElse("Error without error message"));
+            sb.append(Optional.ofNullable(errorType).map(ErrorClassification::toString).orElse("<Unspecified error>"));
+            sb.append(": ");
+            sb.append(Optional.ofNullable(message).orElse("<error message not provided>"));
             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."))
+                        .append(Optional.ofNullable(location.getSourceName()).orElse("unnamed/unspecified source"))
                 );
             }
+            if (nonNull(path) && !path.isEmpty()) {
+               sb.append(". Selection path: ");
+               sb.append(path.stream()
+                   .map(Object::toString)
+                   .map(this::toNumericIndexIfPossible)
+                   .collect(Collectors.joining("/"))
+                   .replaceAll("/\\[", "[")
+               );
+            }
             return sb.toString();
         }
+
+    private String toNumericIndexIfPossible(final String s) {
+        try {
+            return "[" + NumberUtils.parseNumber(s, Long.class) + "]";
+        } catch (IllegalArgumentException e) {
+            return s;
+        }
+    }
 }

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

@@ -186,7 +186,7 @@ void testExpectNoErrorsFail() {
         // THEN
         assertThatExceptionOfType(AssertionError.class)
             .isThrownBy(graphQLResponse::assertThatNoErrorsArePresent)
-            .withMessage("Expected no GraphQL errors, but got 1: Test error.");
+            .withMessage("Expected no GraphQL errors, but got 1: <Unspecified error>: Test error.");
     }
 
     @Test

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

@@ -0,0 +1,74 @@
+package com.graphql.spring.boot.test;
+
+import graphql.ErrorType;
+import graphql.GraphQLError;
+import graphql.language.SourceLocation;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class GraphQLTestErrorToStringTest {
+
+    private static Stream<Arguments> toStringTestArguments() {
+        return Stream.of(
+            Arguments.of(
+                new GraphQLTestError(null, null, null, null, null),
+                "<Unspecified error>: <error message not provided>"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", null, null, null, null),
+                "<Unspecified error>: Test message"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", null, ErrorType.DataFetchingException, null, null),
+                "DataFetchingException: Test message"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.emptyList(), ErrorType.DataFetchingException, null, null),
+                "DataFetchingException: Test message"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2)),
+                    ErrorType.DataFetchingException, null, null),
+                "DataFetchingException: Test message at line 1, column 2 in unnamed/unspecified source"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2)),
+                    ErrorType.DataFetchingException, Collections.emptyList(), null),
+                "DataFetchingException: Test message at line 1, column 2 in unnamed/unspecified source"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2)),
+                    ErrorType.DataFetchingException, Arrays.asList("path", "to", "error"), null),
+                "DataFetchingException: Test message at line 1, column 2 in unnamed/unspecified source. Selection path: path/to/error"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2, "test.graphql")),
+                    ErrorType.DataFetchingException, Arrays.asList("path", "to", "error"), null),
+                "DataFetchingException: Test message at line 1, column 2 in test.graphql. Selection path: path/to/error"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2)),
+                    ErrorType.DataFetchingException, Arrays.asList("path", 123, "error"), null),
+                "DataFetchingException: Test message at line 1, column 2 in unnamed/unspecified source. Selection path: path[123]/error"
+            ),
+            Arguments.of(
+                new GraphQLTestError("Test message", Collections.singletonList(new SourceLocation(1, 2)),
+                    ErrorType.DataFetchingException, Arrays.asList("path", 123, "error"), Collections.singletonMap("please ignore", "this")),
+                "DataFetchingException: Test message at line 1, column 2 in unnamed/unspecified source. Selection path: path[123]/error"
+            )
+        );
+    }
+
+    @ParameterizedTest(name = "{1}")
+    @MethodSource("toStringTestArguments")
+    void testGraphQLTestErrorToString(final GraphQLError error, final String expectedToString) {
+        assertThat(error.toString()).isEqualTo(expectedToString);
+    }
+}