Merge pull request #382 from BlasiusSecundus/feature/subscription-testing

Add facilities to test subscriptions

Author: oliemansm

graphql-spring-boot-test-autoconfigure/build.gradle

@@ -26,6 +26,8 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-actuator")
     implementation("org.springframework.boot:spring-boot-starter-websocket")
     implementation("com.graphql-java-kickstart:graphql-java-tools:$LIB_GRAPHQL_JAVA_TOOLS_VER")
+
+    testImplementation "io.reactivex.rxjava2:rxjava"
 }
 
 compileJava.dependsOn(processResources)

graphql-spring-boot-test-autoconfigure/src/main/java/com/graphql/spring/boot/test/GraphQLTestAutoConfiguration.java

@@ -1,10 +1,13 @@
 package com.graphql.spring.boot.test;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
 
 @Configuration
 @ConditionalOnWebApplication
@@ -17,4 +20,15 @@ public GraphQLTestTemplate graphQLTestUtils() {
         return new GraphQLTestTemplate();
     }
 
+    @Bean
+    @ConditionalOnMissingBean
+    public GraphQLTestSubscription graphQLTestSubscription(
+        final Environment environment,
+        final ObjectMapper objectMapper,
+        @Value("${graphql.servlet.subscriptions.websocket.path:subscriptions}")
+        final String subscriptionPath
+    ) {
+        return new GraphQLTestSubscription(environment, objectMapper, subscriptionPath);
+    }
+
 }

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/GraphQLTestAutoConfigurationTestBase.java

@@ -0,0 +1,40 @@
+package com.graphql.spring.boot.test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationContext;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public class GraphQLTestAutoConfigurationTestBase {
+
+    static final String FOO = "foo";
+
+    @Autowired
+    ApplicationContext applicationContext;
+
+    void assertThatTestSubscriptionWorksCorrectly() {
+        // GIVEN
+        final GraphQLTestSubscription graphQLTestSubscription
+            = applicationContext.getBean(GraphQLTestSubscription.class);
+        // WHEN
+        final GraphQLResponse graphQLResponse
+            = graphQLTestSubscription.start("test-subscription.graphql").awaitAndGetNextResponse(1000);
+        // THEN
+        assertThat(graphQLResponse.get("$.data.testSubscription")).isEqualTo(FOO);
+    }
+
+    void assertThatTestTemplateAutoConfigurationWorksCorrectly() throws IOException {
+        // GIVEN
+        final GraphQLTestTemplate graphQLTestTemplate
+            = applicationContext.getBean(GraphQLTestTemplate.class);
+        // WHEN
+        final GraphQLResponse graphQLResponse
+            = graphQLTestTemplate.postForResource("test-query.graphql");
+        // THEN
+        assertThat(graphQLResponse.get("$.data.testQuery")).isEqualTo(FOO);
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/GraphQLTestSubscriptionAutoConfigurationCustomConfigTest.java

@@ -0,0 +1,23 @@
+package com.graphql.spring.boot.test;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ActiveProfiles({"test", "custom-subscription-path"})
+@DisplayName("Testing the auto-configuration of the GraphQLTestSubscription bean / custom subscription endpoint.")
+public class GraphQLTestSubscriptionAutoConfigurationCustomConfigTest extends GraphQLTestAutoConfigurationTestBase {
+
+    @Test
+    @DisplayName("Should provide a GraphQLTestTemplate bean.")
+    void shouldProvideGraphQLTestSubscriptionBean() {
+        assertThatTestSubscriptionWorksCorrectly();
+        assertThat(ReflectionTestUtils.getField(applicationContext.getBean(GraphQLTestSubscription.class),
+            "subscriptionPath"))
+            .as("Should use the configured subscription path.")
+            .isEqualTo("/myCustomPath");
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/GraphQLTestSubscriptionAutoConfigurationDefaultConfigTest.java

@@ -0,0 +1,14 @@
+package com.graphql.spring.boot.test;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+@DisplayName("Testing the auto-configuration of the GraphQLTestSubscription bean / default settings.")
+public class GraphQLTestSubscriptionAutoConfigurationDefaultConfigTest extends GraphQLTestAutoConfigurationTestBase {
+
+    @Test
+    @DisplayName("Should provide a GraphQLTestTemplate bean.")
+    void shouldProvideGraphQLTestSubscriptionBean() {
+        assertThatTestSubscriptionWorksCorrectly();
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/GraphQLTestTemplateAutoConfigurationCustomConfigTest.java

@@ -0,0 +1,25 @@
+package com.graphql.spring.boot.test;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ActiveProfiles({"test", "custom-servlet-mapping"})
+@DisplayName("Testing auto-configuration of the GraphQLTestTemplate bean / custom servlet endpoint.")
+public class GraphQLTestTemplateAutoConfigurationCustomConfigTest extends GraphQLTestAutoConfigurationTestBase {
+
+    @Test
+    @DisplayName("GraphQLTestTemplate bean should work properly.")
+    void shouldProvideGraphQLTestTemplateBean() throws IOException {
+        assertThatTestTemplateAutoConfigurationWorksCorrectly();
+        assertThat(ReflectionTestUtils.getField(applicationContext.getBean(GraphQLTestTemplate.class),
+            "graphqlMapping"))
+            .as("Should use the configured servlet path.")
+            .isEqualTo("/myCustomGraphQLEndpoint");
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/GraphQLTestTemplateAutoConfigurationDefaultConfigTest.java

@@ -0,0 +1,16 @@
+package com.graphql.spring.boot.test;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+@DisplayName("Testing auto-configuration of the GraphQLTestTemplate bean / default servlet endpoint.")
+public class GraphQLTestTemplateAutoConfigurationDefaultConfigTest extends GraphQLTestAutoConfigurationTestBase {
+
+    @Test
+    @DisplayName("GraphQLTestTemplate bean should work properly.")
+    void shouldProvideGraphQLTestTemplateBean() throws IOException {
+        assertThatTestTemplateAutoConfigurationWorksCorrectly();
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/TestApplication.java

@@ -0,0 +1,13 @@
+package com.graphql.spring.boot.test;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class TestApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(TestApplication.class, args);
+    }
+}
+

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/beans/TestQuery.java

@@ -0,0 +1,12 @@
+package com.graphql.spring.boot.test.beans;
+
+import graphql.kickstart.tools.GraphQLQueryResolver;
+import org.springframework.stereotype.Service;
+
+@Service
+public class TestQuery implements GraphQLQueryResolver {
+
+    public String testQuery() {
+        return "foo";
+    }
+}

graphql-spring-boot-test-autoconfigure/src/test/java/com/graphql/spring/boot/test/beans/TestSubscription.java

@@ -0,0 +1,13 @@
+package com.graphql.spring.boot.test.beans;
+
+import graphql.kickstart.tools.GraphQLSubscriptionResolver;
+import io.reactivex.Flowable;
+import org.springframework.stereotype.Service;
+
+@Service
+public class TestSubscription implements GraphQLSubscriptionResolver {
+
+    public Flowable<String> testSubscription() {
+        return Flowable.just("foo");
+    }
+}