org.springframework.graphql.test.tester

Interface GraphQlTester.Builder<T extends GraphQlTester.Builder<T>>

All Known Subinterfaces:

WebGraphQlTester.Builder

Enclosing interface:

GraphQlTester

public static interface GraphQlTester.Builder<T extends GraphQlTester.Builder<T>>

A builder to create a GraphQlTester instance.

Method Summary

Modifier and Type	Method and Description
GraphQlTester	build() Build the GraphQlTester.
T	errorFilter(Predicate<GraphQLError> predicate) Add a global filter for expected errors.
T	jsonPathConfig(com.jayway.jsonpath.Configuration config) Provide JSONPath configuration settings, including a JsonProvider as well as a MappingProvider that are used to serialize and deserialize GraphQL JSON content.
T	responseTimeout(Duration timeout) Max amount of time to wait for a GraphQL response.

Method Detail

errorFilter

T errorFilter(Predicate<GraphQLError> predicate)

Add a global filter for expected errors. All errors that match the given predicate are treated as expected and ignored on GraphQlTester.ErrorSpec.verify() or when traversing to a data path.

Parameters:

predicate - the error filter to add

Returns:

the same builder instance

jsonPathConfig

T jsonPathConfig(com.jayway.jsonpath.Configuration config)

Provide JSONPath configuration settings, including a JsonProvider as well as a MappingProvider that are used to serialize and deserialize GraphQL JSON content.

By default the configuration is to use Jackson JSON if it is present on the classpath.

Parameters:

config - the JSONPath configuration to use

Returns:

the same builder instance

responseTimeout

T responseTimeout(Duration timeout)

Max amount of time to wait for a GraphQL response.

By default this is set to 5 seconds.

Parameters:

timeout - the response timeout value

build

GraphQlTester build()

Build the GraphQlTester.

Returns:

the created instance