org.springframework.graphql.test.tester

Interface WebGraphQlTester

All Superinterfaces:

GraphQlTester

public interface WebGraphQlTester
extends GraphQlTester

Main entry point for testing GraphQL over a Web transport with requests executed via WebTestClient or via WebGraphQlHandler. See the below for examples with different scenarios.

GraphQL requests to Spring MVC without an HTTP server:

 @SpringBootTest
 @AutoConfigureMockMvc
 @AutoConfigureGraphQlTester
 public class MyTests {

   @Autowired
   private WebGraphQlTester graphQlTester;
 }
 

GraphQL requests to Spring WebFlux without an HTTP server:

 @SpringBootTest
 @AutoConfigureWebTestClient
 @AutoConfigureGraphQlTester
 public class MyTests {

   @Autowired
   private WebGraphQlTester graphQlTester;
 }
 

GraphQL requests to a running server:

 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
 @AutoConfigureWebTestClient
 @AutoConfigureGraphQlTester
 public class MyTests {

   @Autowired
   private WebGraphQlTester graphQlTester;
 }
 

GraphQL requests handled directly through a WebGraphQlHandler:

 @SpringBootTest
 public class MyTests {

   private WebGraphQlTester graphQlTester;

   @BeforeEach
   public void setUp(@Autowired WebGraphQLHandler handler) {
       this.graphQlTester = GraphQlTester.create(handler);
   }
 }
 

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebGraphQlTester.Builder A builder to create a WebGraphQlTester instance.
static interface	WebGraphQlTester.WebRequestSpec Extends GraphQlTester.RequestSpec with further input options applicable to Web requests.

Nested classes/interfaces inherited from interface org.springframework.graphql.test.tester.GraphQlTester

GraphQlTester.EntitySpec<D,S extends GraphQlTester.EntitySpec<D,S>>, GraphQlTester.ErrorSpec, GraphQlTester.ExecuteSpec, GraphQlTester.ListEntitySpec<E>, GraphQlTester.PathSpec, GraphQlTester.RequestSpec<T extends GraphQlTester.RequestSpec<T>>, GraphQlTester.ResponseSpec, GraphQlTester.SubscriptionSpec, GraphQlTester.TraverseSpec

Method Summary

Modifier and Type	Method and Description
static WebGraphQlTester.Builder	builder(WebGraphQlHandler handler) Return a builder with options to initialize a WebGraphQlHandler.
static WebGraphQlTester.Builder	builder(WebTestClient client) Return a builder with options to initialize a WebGraphQlTester.
static WebGraphQlTester	create(WebGraphQlHandler handler) Create a WebGraphQlTester that performs GraphQL requests through the given WebGraphQlHandler.
static WebGraphQlTester	create(WebTestClient client) Create a WebGraphQlTester that performs GraphQL requests as an HTTP client through the given WebTestClient.
WebGraphQlTester.WebRequestSpec	query(String query) Prepare to perform a GraphQL request with the given operation which may be a query, mutation, or a subscription.

Methods inherited from interface org.springframework.graphql.test.tester.GraphQlTester

builder, create

Method Detail

query

WebGraphQlTester.WebRequestSpec query(String query)

Prepare to perform a GraphQL request with the given operation which may be a query, mutation, or a subscription.

The returned spec for Web request input also allows adding HTTP headers.

Specified by:

query in interface GraphQlTester

Parameters:

query - the operation to be performed

Returns:

spec for response assertions

create

static WebGraphQlTester create(WebTestClient client)

Create a WebGraphQlTester that performs GraphQL requests as an HTTP client through the given WebTestClient. Depending on how the WebTestClient is set up, tests may be with or without a server. See setup examples in class-level Javadoc.

Parameters:

client - the web client to perform requests with

Returns:

the created WebGraphQlTester

create

static WebGraphQlTester create(WebGraphQlHandler handler)

Create a WebGraphQlTester that performs GraphQL requests through the given WebGraphQlHandler.

Parameters:

handler - the handler to execute requests with

Returns:

the created WebGraphQlTester

builder

static WebGraphQlTester.Builder builder(WebTestClient client)

Return a builder with options to initialize a WebGraphQlTester.

Parameters:

client - the client to execute requests with

Returns:

the builder to use

builder

static WebGraphQlTester.Builder builder(WebGraphQlHandler handler)

Return a builder with options to initialize a WebGraphQlHandler.

Parameters:

handler - the handler to execute requests with

Returns:

the builder to use