feat: add support for named operations in GraphQLTestTemplate

Author: BlasiusSecundus

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

@@ -24,6 +24,8 @@
 import java.util.Arrays;
 import java.util.List;
 
+import static java.util.Objects.nonNull;
+
 public class GraphQLTestTemplate {
 
     private final ResourceLoader resourceLoader;
@@ -46,11 +48,14 @@ public GraphQLTestTemplate(
         this.objectMapper = objectMapper;
     }
 
-    private String createJsonQuery(String graphql, ObjectNode variables)
+    private String createJsonQuery(String graphql, String operation, ObjectNode variables)
             throws JsonProcessingException {
 
         ObjectNode wrapper = objectMapper.createObjectNode();
         wrapper.put("query", graphql);
+        if (nonNull(operation)) {
+            wrapper.put("operationName", operation);
+        }
         wrapper.set("variables", variables);
         return objectMapper.writeValueAsString(wrapper);
     }
@@ -196,18 +201,30 @@ public GraphQLResponse perform(String graphqlResource) throws IOException {
     }
 
     public GraphQLResponse perform(String graphqlResource, ObjectNode variables) throws IOException {
+        return perform(graphqlResource, null, variables);
+    }
+
+    public GraphQLResponse perform(String graphqlResource, String operationName) throws IOException {
+        return perform(graphqlResource, operationName, null);
+    }
+
+    public GraphQLResponse perform(String graphqlResource, String operation, ObjectNode variables) throws IOException {
         String graphql = loadQuery(graphqlResource);
-        String payload = createJsonQuery(graphql, variables);
+        String payload = createJsonQuery(graphql, operation, variables);
         return post(payload);
     }
 
     public GraphQLResponse perform(String graphqlResource, ObjectNode variables, List<String> fragmentResources) throws IOException {
+        return perform(graphqlResource, null, variables, fragmentResources);
+    }
+
+    public GraphQLResponse perform(String graphqlResource, String operationName, ObjectNode variables, List<String> fragmentResources) throws IOException {
         StringBuilder sb = new StringBuilder();
         for (String fragmentResource : fragmentResources) {
             sb.append(loadQuery(fragmentResource));
         }
         String graphql = sb.append(loadQuery(graphqlResource)).toString();
-        String payload = createJsonQuery(graphql, variables);
+        String payload = createJsonQuery(graphql, operationName, variables);
         return post(payload);
     }
 
@@ -219,7 +236,7 @@ public GraphQLResponse perform(String graphqlResource, ObjectNode variables, Lis
      * @throws IOException if the resource cannot be loaded from the classpath
      */
     public GraphQLResponse postForResource(String graphqlResource) throws IOException {
-        return perform(graphqlResource, null);
+        return perform(graphqlResource, (String) null, null);
     }
 
     /**

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

@@ -0,0 +1,86 @@
+package com.graphql.spring.boot.test;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.graphql.spring.boot.test.beans.FooBar;
+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 java.io.IOException;
+import java.util.Collections;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public class GraphQLTestTemplateIntegrationTest {
+
+    private static final String SIMPLE_TEST_QUERY = "simple-test-query.graphql";
+    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 MULTIPLE_QUERIES = "multiple-queries.graphql";
+
+    @Autowired
+    private ResourceLoader resourceLoader;
+
+    @Autowired
+    private TestRestTemplate testRestTemplate;
+
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    private GraphQLTestTemplate graphQLTestTemplate;
+
+    @BeforeEach
+    void setUp() {
+        graphQLTestTemplate = new GraphQLTestTemplate(resourceLoader, testRestTemplate, "/graphql", objectMapper);
+    }
+
+    @Test
+    @DisplayName("Test postForResource with only the GraphQL resource provided.")
+    void testPostForResource() throws IOException {
+        graphQLTestTemplate.postForResource(SIMPLE_TEST_QUERY)
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.otherQuery").asString().isEqualTo("TEST");
+    }
+
+    @Test
+    @DisplayName("Test postForResource with fragments.")
+    void testPostForResourceWithFragments() throws IOException {
+        graphQLTestTemplate.postForResource(SIMPLE_TEST_QUERY_WITH_FRAGMENTS,
+            Collections.singletonList(TEST_FRAGMENT_FILE))
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.fooBar").as(FooBar.class)
+                .usingRecursiveComparison()
+                .ignoringAllOverriddenEquals()
+                .isEqualTo(FooBar.builder().foo("FOO").bar("BAR").build());
+    }
+
+    @Test
+    @DisplayName("Test perform with variables.")
+    void testPerformWithVariables() throws IOException {
+        // GIVEN
+        final String inputString = "test-input-string";
+        final ObjectNode variables = objectMapper.createObjectNode();
+        variables.put("input", inputString);
+        // WHEN - THEN
+        graphQLTestTemplate.perform(QUERY_WITH_VARIABLES, variables)
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.queryWithVariables").asString().isEqualTo(inputString);
+    }
+
+    @Test
+    @DisplayName("Test perform with operation name.")
+    void testPerformWithOperationName() throws IOException {
+        // WHEN - THEN
+        graphQLTestTemplate.perform(MULTIPLE_QUERIES, "testQuery1")
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.dummy").asBoolean().isTrue();
+        graphQLTestTemplate.perform(MULTIPLE_QUERIES, "testQuery2")
+            .assertThatNoErrorsArePresent()
+            .assertThatField("$.data.otherQuery").asString().isEqualTo("TEST");
+    }
+}

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

@@ -9,4 +9,16 @@ public class DummyQuery implements GraphQLQueryResolver {
     public boolean dummy() {
         return true;
     }
+
+    public String otherQuery() {
+        return "TEST";
+    }
+
+    public FooBar fooBar() {
+        return FooBar.builder().bar("BAR").foo("FOO").build();
+    }
+
+    public String queryWithVariables(final String input) {
+        return input;
+    }
 }

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

@@ -0,0 +1,15 @@
+package com.graphql.spring.boot.test.beans;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class FooBar {
+    private String foo;
+    private String bar;
+}

graphql-spring-boot-test/src/test/resources/foo-bar-fragment.graphql

@@ -0,0 +1,4 @@
+fragment FooBarFragment on FooBar {
+    foo
+    bar
+}

graphql-spring-boot-test/src/test/resources/multiple-queries.graphql

@@ -0,0 +1,7 @@
+query testQuery1 {
+    dummy
+}
+
+query testQuery2 {
+    otherQuery
+}

graphql-spring-boot-test/src/test/resources/query-with-variables.graphql

@@ -0,0 +1,3 @@
+query ($input: String!) {
+    queryWithVariables(input: $input)
+}

graphql-spring-boot-test/src/test/resources/simple-test-query-with-fragments.graphql

@@ -0,0 +1,5 @@
+query {
+    fooBar {
+        ...FooBarFragment
+    }
+}

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

@@ -0,0 +1,3 @@
+query {
+    otherQuery
+}

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

@@ -1,3 +1,8 @@
+type FooBar {
+    foo: String!
+    bar: String!
+}
+
 type Subscription {
     timer: Float!
     subscriptionWithParameter(param: String!): String!
@@ -8,4 +13,7 @@ type Subscription {
 
 type Query {
     dummy: Boolean!
+    otherQuery: String!
+    fooBar: FooBar!
+    queryWithVariables(input: String!): String!
 }