How to test in GraphQL Spring Boot #267

alioth865 · 2019-07-11T14:29:48Z

alioth865
Jul 11, 2019

Hello, im new in GraphQL world, I'm doing my first API with this technology and I have one doubt. It's possible with JUnit do testing for my GraphQLResolver, GraphQLMutationResolver or GraphQLQueryResolver? Or simply don't have sence doing? If is possible doing, please can you share me someone class than example?
Sorry for my bad english!
Best regards

oliemansm · 2019-07-11T17:39:19Z

oliemansm
Jul 11, 2019
Maintainer

As mentioned in the documentation there's a test starter available which exposes the @GraphQLTest annotation. Take a look at https://github.com/graphql-java-kickstart/graphql-spring-boot/blob/master/example-graphql-tools/src/test/java/com/graphql/sample/boot/GraphQLToolsSampleApplicationTest.java for an example how to use it.

3 replies

Cat-Lord Jun 22, 2022

For anyone trying to access the test in the link, here is an updated version.

You can find samples in the a separate repository.

yusuffurkanyalcin Jul 8, 2022

Hello ,

I just write like this code but it is not working on my code

@ExtendWith(SpringExtension.class)
@graphqltest
public class PlayerMutationIntTest {

private static final String GRAPHQL_MUTATION_REQUEST_PATH = "graphql/request/create-player.graphql";

@Autowired
private GraphQLTestTemplate graphQLTestTemplate;


@Test
public void create() throws IOException{
        GraphQLResponse response = graphQLTestTemplate.postForResource(GRAPHQL_MUTATION_REQUEST_PATH);
        System.out.println(response.getRawResponse().getBody());
}

}

yusuffurkanyalcin Jul 8, 2022

My response is :

<!doctype html><title>HTTP Status 404 – Not Found</title><style type="text/css">body {font-family:Tahoma,Arial,sans-serif;} h1, h2, h3, b {color:white;background-color:#525D76;} h1 {font-size:22px;} h2 {font-size:16px;} h3 {font-size:14px;} p {font-size:12px;} a {color:black;} .line {height:1px;background-color:#525D76;border:none;}</style>

HTTP Status 404 – Not Found

Type Status Report

Description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

Apache Tomcat/9.0.56

anrolmar · 2020-02-03T11:17:43Z

anrolmar
Feb 3, 2020

Hi. I used the example, but I retrieved a 404 error. If I look around the code, the error is this piece of code:
ResponseEntity<String> response = this.restTemplate.exchange(this.graphqlMapping, HttpMethod.POST, request, String.class, new Object[0]);

this.graphqlMapping has the value /graphql.

Is this correct?

0 replies

FranBisquerra · 2020-04-01T23:16:47Z

FranBisquerra
Apr 1, 2020

Hi! I'm trying to use the test library as I found it pretty easy and useful and I'm facing the same 404 error.. In my case I found that is related with the

@RunWith(SpringRunner::class) @GraphQLTest

annotations, if I use the

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

it works perfectly, I can't seem to find the reason as @GraphQLTest is supposed to configure the environment the same way.

Anyone that knows what the problem might be?

Thx!

1 reply

arjun-oodle Apr 15, 2021

When you add the above code, ./gradlew test hangs. Unlike the Injteli J IDE where it runs perfectly.

oliemansm · 2020-04-05T19:21:36Z

oliemansm
Apr 5, 2020
Maintainer

This test class uses @GraphQLTest too without specifying RANDOM_PORT specifically either and is working fine.

You shouldn't have to add this:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

since that's already set on the @GraphQLTest annotation.

Maybe it's a Kotlin config issue?

0 replies

FranBisquerra · 2020-04-05T20:41:40Z

FranBisquerra
Apr 5, 2020

Hi! I've been trying for a while to find the problem but didn't find anything.. Reading the annotation doc I realized that It was not loading the full application context, and I need it anyway, so I ended up using the @SpringBootTest annotation.

Thank you for the support!

0 replies

imamika · 2020-10-08T22:38:12Z

imamika
Oct 8, 2020

Hello! I am working on building GraphQL Webflux api using graphql-kickstart-spring-boot-starter-webflux. I tried finding resources on how i could test this. Any pointers in this regard are helpful. Thanks!

0 replies

imamika · 2020-10-09T16:05:54Z

imamika
Oct 9, 2020

I think i found what i am looking for.

https://github.com/graphql-java-kickstart/graphql-spring-webclient/blob/master/graphql-webclient/src/test/java/graphql/kickstart/spring/webclient/boot/GraphQLWebClientTest.java

0 replies

mustafa-qamaruddin · 2020-11-08T00:23:44Z

mustafa-qamaruddin
Nov 8, 2020

I am trying the following test:

@GraphQLTest
public class UserTest {
  @Autowired
  private GraphQLTestTemplate graphQLTestTemplate;

  @Test
  public void createUser() throws IOException {
    GraphQLResponse response = graphQLTestTemplate.postForResource("graphql/register.graphql");
    assertNotNull(response);
    assertTrue(response.isOk());
    assertEquals("1", response.get("$.data.post.id"));
  }
}

and I get the following response:

<404,<!doctype html><html lang="en"><head><title>HTTP Status 404 – Not Found</title><style type="text/css">body {font-family:Tahoma,Arial,sans-serif;} h1, h2, h3, b {color:white;background-color:#525D76;} h1 {font-size:22px;} h2 {font-size:16px;} h3 {font-size:14px;} p {font-size:12px;} a {color:black;} .line {height:1px;background-color:#525D76;border:none;}</style></head><body><h1>HTTP Status 404 – Not Found</h1><hr class="line" /><p><b>Type</b> Status Report</p><p><b>Message</b> The requested resource [&#47;api&#47;graphql] is not available</p><p><b>Description</b> The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.</p><hr class="line" /><h3>Apache Tomcat/9.0.37</h3></body></html>,[Content-Type:"text/html;charset=utf-8", Content-Language:"en", Content-Length:"766", Date:"Sun, 08 Nov 2020 00:18:11 GMT", Keep-Alive:"timeout=60", Connection:"keep-alive"]>

Any help is appreciated ...

1 reply

rizvisar Mar 8, 2021

I am getting the same response. @mustafa-qamaruddin were you able to get past this ??

EriRan · 2020-11-15T12:20:21Z

EriRan
Nov 15, 2020

@mustafa-qamaruddin That test class is correct. There is something wrong with the servlet, possibly due to the graphql not being available in URI/graphql

0 replies

mustafa-qamaruddin · 2020-11-17T01:25:01Z

mustafa-qamaruddin
Nov 17, 2020

Thank you, I have my /graphql pointing to /api/graphql, shouldn't the test detect it automaticaly, and from debugging I think it hits /api/graphql

graphql:
  tools:
    schema-location-pattern: "**/*.graphqls"
    introspection-enabled: true
  servlet:
    mapping: /api/graphql
    enabled: true

Also, I @graphqltest should be initializing the servlet?

0 replies

chenbocheng · 2021-03-31T15:05:48Z

chenbocheng
Mar 31, 2021

I had the same issue. However, once I just put my test class into the same package, then it worked.

10 replies

oliemansm Apr 7, 2021
Maintainer

Something is pulling in a very old version of one of the libraries that still used the com.oembedler.moon package. Older versions of com.zhokhov.graphql:graphql-datetime-spring-boot-starter can do that for example. Make sure that you only have the compatible versions. When using the spring-boot-starter you don't need to define any other kickstart dependencies, since it pulls in the correct and compatible versions for you.

lloyd137 Apr 7, 2021

@oliemansm @cr-lgl Okay so what I think you mean is that I'm using a not compatible library for my project. These are the dependencies I'm using, do you maybe see which ones aren't 'correct'?

    <dependency>
        <groupId>com.graphql-java</groupId>
        <artifactId>graphql-spring-boot-starter</artifactId>
        <version>5.0.2</version>
    </dependency>
    <dependency>
        <groupId>com.graphql-java</groupId>
        <artifactId>graphql-java-tools</artifactId>
        <version>5.2.4</version>
    </dependency>
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>30.1-jre</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

For testing:

    <dependency>
        <groupId>com.graphql-java-kickstart</groupId>
        <artifactId>graphql-spring-boot-starter-test</artifactId>
        <version>7.0.1</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.junit.vintage</groupId>
        <artifactId>junit-vintage-engine</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.hamcrest</groupId>
                <artifactId>hamcrest-core</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

oliemansm Apr 7, 2021
Maintainer

Yes, you're using incompatible versions. Remove graphql-java-tools (the second one) entirely and change the group and version of graphql-spring-boot-starter to the same values as graphql-spring-boot-starter-test. So group "com.graphql-java-kickstart" and version 7.0.1.

You're main GraphQL package is depending on a very old and outdated version.

lloyd137 Apr 7, 2021

@oliemansm It works now! I appreciate your help a lot, thankyou!! :)

and @cr-lgl thankyou too!

arjun-oodle Apr 15, 2021

./gradlew test hangs when I do this. But runs perfect through the intelij IDE. Unable to deploy as jenkins fails because of ./gradlew test

Predarion · 2021-04-09T12:51:48Z

Predarion
Apr 9, 2021

I had the same issue and solved it with:
In my pom.xml:

<!-- Spring Webflux server -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

<!-- GraphQL --> 
<dependency>
	<groupId>com.graphql-java</groupId>
	<artifactId>graphql-java-spring-boot-starter-webflux</artifactId>
	<version>2.0</version>
</dependency>
<dependency>
	<groupId>com.graphql-java-kickstart</groupId>
	<artifactId>graphql-java-tools</artifactId>
	<version>11.0.0</version>
</dependency>

<!-- Testing -->
<dependency>
	<groupId>com.graphql-java-kickstart</groupId>
	<artifactId>graphql-spring-boot-starter-test</artifactId>
	<version>11.0.0</version>
	<scope>test</scope>
</dependency>

Then, I can test with

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class QueryResolverIT {
    @Autowired
    private GraphQLTestTemplate template;

    @Test
    void testAffiliation() throws IOException {
        GraphQLResponse response = template.postForResource("graphql/query/affiliation.graphql");
        Assertions.assertThat(response).isNotNull();
        Assertions.assertThat(response.isOk()).isTrue();
    }
}

@GraphqlTest didn't work for me.

0 replies

arjun-oodle · 2021-04-16T08:29:53Z

arjun-oodle
Apr 16, 2021

Adding this works for me @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT).
But the test fail on jenkins with weird issue.

13:29:58  > Task :test
13:29:58  
13:29:58  ExternalQueryResolverTest > testValidAddressEndpoint() FAILED
13:29:58      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:58          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:58              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:29:58  
13:29:58  ExternalQueryResolverTest > testValidAddressesEndpoint() FAILED
13:29:58      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:58          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:58              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:29:58  
13:29:58  ExternalQueryResolverTest > testValidAddressEndpointUnableToFetchAddressException() FAILED
13:29:58      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:58          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:58              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:29:58  
13:29:58  ExternalQueryResolverTest > testValidAddressesEndpointUnableToFetchAddressException() FAILED
13:29:58      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:58          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:58              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:29:58  
13:29:58  ExternalQueryResolverTest > testValidAddressEndpointInvalidPostcode() FAILED
13:29:58      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:58          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:58              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:29:59  
13:29:59  ExternalQueryResolverTest > testValidAddressesEndpointInvalidPostcode() FAILED
13:29:59      java.lang.IllegalStateException at DefaultCacheAwareContextLoaderDelegate.java:132
13:29:59          Caused by: org.springframework.beans.factory.BeanDefinitionStoreException at ConfigurationClassParser.java:189
13:29:59              Caused by: java.io.FileNotFoundException at ClassPathResource.java:180
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  2021-04-16 08:00:47.778  INFO 7147 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
13:30:49  
13:30:49  260 tests completed, 6 failed

The test that passed are for Rest API. GraphQL tests are failing.

Can anyone help?

0 replies

ermadmi78 · 2021-04-24T22:04:10Z

ermadmi78
Apr 24, 2021

Hi, you can find GraphQL Spring Boot server example here:
https://github.com/ermadmi78/kobby-gradle-example

Tests example is placed here:
https://github.com/ermadmi78/kobby-gradle-example/blob/main/cinema-server/src/test/kotlin/io/github/ermadmi78/kobby/cinema/server/CinemaServerTest.kt

To run tests from IntelliJ IDEA install Kotest plugin:
https://plugins.jetbrains.com/plugin/14080-kotest

0 replies

How to test in GraphQL Spring Boot #267

Replies: 14 comments · 15 replies

oliemansm Jul 11, 2019 Maintainer

HTTP Status 404 – Not Found

Apache Tomcat/9.0.56

oliemansm Apr 5, 2020 Maintainer

oliemansm Apr 7, 2021 Maintainer

oliemansm Apr 7, 2021 Maintainer

Replies: 14 comments 15 replies

oliemansm
Jul 11, 2019
Maintainer

oliemansm
Apr 5, 2020
Maintainer

oliemansm Apr 7, 2021
Maintainer

oliemansm Apr 7, 2021
Maintainer