Add ability to send HTTP headers in GraphQLTestTemplate

[bakert]

I use an Authorization: Bearer {jwt} HTTP header for permissions on various parts of the graph. My tests use GraphQLTestTemplate which is super useful but I don't see any way to send the required header for tests of those parts that require it.

(Excuse my kotlin here but the code should be very similar to Java.)

@RunWith(SpringRunner::class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class ApplicationTests {
    @Autowired
    private lateinit var graphQLTestTemplate: GraphQLTestTemplate

    @Test
    fun testQueryThatRequiresPermissions() {
        val response = graphQLTestTemplate.postForResource("graphql/query-that-requires-permissions.graphql")
        assertEquals(1, response.get("$.data.thingQueried.id", Int::class.java))
    }
}

GraphQLTestTemplate has a postRequest method that looks like it might be useful to fiddle with the request before it goes to the endpoint but unfortunately it is private.

Any obvious workaround or should I not use GraphQLTestTemplate for this?

[oliemansm]

Hadn't thought about that use case before actually. Just quickly looked at the current code. I've tried to keep the public API of that class simple and at the same level, so having to deal with queries or resources representing queries. Not the lower lever of the actual HttpEntity. What we could do is add a method with an additional HttpHeaders or Map<String,String> parameter allowing you to pass in headers you'd want to add. Would that work for you?

[bakert]

That would be wonderful :D

[bakert]

I had a little attempt at this:

diff --git a/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestTemplate.java b/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestTemplate.java
index 355dd08..23839e1 100644
--- a/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestTemplate.java
+++ b/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestTemplate.java
@@ -9,6 +9,7 @@ import org.springframework.boot.test.web.client.TestRestTemplate;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders
 import org.springframework.http.HttpMethod;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.StreamUtils;
@@ -27,6 +28,7 @@ public class GraphQLTestTemplate {
     private String graphqlMapping;
 
     private ObjectMapper objectMapper = new ObjectMapper();
+    private HttpHeaders headers = new HttpHeaders();
 
     private String createJsonQuery(String graphql, ObjectNode variables)
             throws JsonProcessingException {
@@ -48,6 +50,10 @@ public class GraphQLTestTemplate {
         }
     }
 
+    public void addHeader(String name, String value) {
+        headers.add(name, value);
+    }
+
     /**
      * @deprecated Use {@link #postForResource(String)} instead
      *
@@ -77,11 +83,11 @@ public class GraphQLTestTemplate {
     }
 
     public GraphQLResponse postMultipart(String query, String variables) {
-        return postRequest(RequestFactory.forMultipart(query, variables));
+        return postRequest(RequestFactory.forMultipart(query, variables, headers));
     }
 
     private GraphQLResponse post(String payload) {
-        return postRequest(RequestFactory.forJson(payload));
+        return postRequest(RequestFactory.forJson(payload, headers));
     }
 
     private GraphQLResponse postRequest(HttpEntity<Object> request) {
diff --git a/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/RequestFactory.java b/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/RequestFactory.java
index 31c43c8..9e269b4 100644
--- a/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/RequestFactory.java
+++ b/graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/RequestFactory.java
@@ -11,14 +11,12 @@ class RequestFactory {
         // utility class
     }
 
-    static HttpEntity<Object> forJson(String json) {
-        HttpHeaders headers = new HttpHeaders();
+    static HttpEntity<Object> forJson(String json, HttpHeaders headers) {
         headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
         return new HttpEntity<>(json, headers);
     }
 
-    static HttpEntity<Object> forMultipart(String query, String variables) {
-        HttpHeaders headers = new HttpHeaders();
+    static HttpEntity<Object> forMultipart(String query, String variables, HttpHeaders headers) {
         headers.setContentType(MediaType.MULTIPART_FORM_DATA);
         LinkedMultiValueMap<String, Object> values = new LinkedMultiValueMap<>();
         values.add("query", forJson(query));

Unfortunately I can't send as a PR due to unrelated problems running ./gradlew test/./gradlew build. (I get "Could not create service of type ScriptPluginFactory using BuildScopeServices.createScriptPluginFactory" against both master and the last release which I assume is something funky in my local environment.)

Does that general approach look like it makes sense? I'll try and fix the build issues and send a proper PR if it meets approval.

[oliemansm]

Bit difficult to read like this, but looks ok. It does assume you want to use the same headers for each test in the same test class. That might work for most use cases, but if you'd want to be able to test several different header values you might want a way to alter that. Either by overriding these headers by passing in headers as a parameter, or by letting addHeader work more like setHeader where it overrides any previously provided header.

If that build problem is a local thing then the chance is high that when you create the PR the build will be ok.

[bakert]

I fixed my build issue (it was Java version-related) and sent a PR here: #176. Let me know what you think.

Being a total ignoramus of the JVM ecosystem as a whole this is untested (except via gradle build/test). Any tips for a noob on how to hook this up to my existing project/build.gradle without it having a release version appreciated :P

[oliemansm]

You can run the publishToMavenLocal gradle task to install it in your local repository. Then you can use that version as specified in gradle.properties as if it comes from maven central.