Class AbstractGraphQlTesterBuilder<B extends AbstractGraphQlTesterBuilder<B>>

java.lang.Object

org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder<B>

Type Parameters:

B - the type of builder

All Implemented Interfaces:

GraphQlTester.Builder<B>

Direct Known Subclasses:

DefaultRSocketGraphQlTesterBuilder

public abstract class AbstractGraphQlTesterBuilder<B extends AbstractGraphQlTesterBuilder<B>>
extends Object
implements GraphQlTester.Builder<B>

Abstract, base class for transport specific GraphQlTester.Builder implementations.

Subclasses must implement GraphQlTester.Builder.build() and call buildGraphQlTester(GraphQlTransport) to obtain a default, transport agnostic GraphQlTester. A transport specific extension can then wrap this default tester by extending AbstractDelegatingGraphQlTester.

Since:

1.0.0

Author:

Rossen Stoyanchev

See Also:

• AbstractDelegatingGraphQlTester

Constructor Summary

Constructors

Constructor	Description
AbstractGraphQlTesterBuilder()

Method Summary

Modifier and Type	Method	Description
protected static GraphQlTransport	asTransport(GraphQlClient client)	For cases where the Tester needs the GraphQlTransport, we can't use transports directly since they are package private, but we can adapt the corresponding GraphQlClient and adapt it to GraphQlTransport.
protected GraphQlTester	buildGraphQlTester(GraphQlTransport transport)	Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlTester.
protected void	configureJsonPathConfig(Function<com.jayway.jsonpath.Configuration, com.jayway.jsonpath.Configuration> configurer)	Allow transport-specific subclass builders to register a JSON Path MappingProvider that matches the JSON encoding/decoding they use.
B	documentSource(DocumentSource documentSource)	Configure a DocumentSource for use with GraphQlTester.documentName(String) for resolving a document by name.
B	errorFilter(Predicate<ResponseError> predicate)	Configure a global filter that applies to all requests.
protected Consumer<AbstractGraphQlTesterBuilder<?>>	getBuilderInitializer()	Subclasses call this from GraphQlTester.Builder.build() to obtain a Consumer to initialize new builder instances with, based on "this" builder.
B	responseTimeout(Duration timeout)	Max amount of time to wait for a GraphQL response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

build

Constructor Details

AbstractGraphQlTesterBuilder

public AbstractGraphQlTesterBuilder()

Method Details

errorFilter

public B errorFilter(Predicate<ResponseError> predicate)

Description copied from interface: GraphQlTester.Builder

Configure a global filter that applies to all requests.

Specified by:

errorFilter in interface GraphQlTester.Builder<B extends AbstractGraphQlTesterBuilder<B>>

Parameters:

predicate - the error filter to add

Returns:

the same builder instance

documentSource

public B documentSource(DocumentSource documentSource)

Description copied from interface: GraphQlTester.Builder

Configure a DocumentSource for use with GraphQlTester.documentName(String) for resolving a document by name.

By default, this is set to ResourceDocumentSource with classpath location "graphql-test/" and ResourceDocumentSource.FILE_EXTENSIONS as extensions.

Specified by:

documentSource in interface GraphQlTester.Builder<B extends AbstractGraphQlTesterBuilder<B>>

Parameters:

documentSource - the document content loader

responseTimeout

public B responseTimeout(Duration timeout)

Description copied from interface: GraphQlTester.Builder

Max amount of time to wait for a GraphQL response.

By default this is set to 5 seconds.

Specified by:

responseTimeout in interface GraphQlTester.Builder<B extends AbstractGraphQlTesterBuilder<B>>

Parameters:

timeout - the response timeout value

configureJsonPathConfig

protected void configureJsonPathConfig(Function<com.jayway.jsonpath.Configuration, com.jayway.jsonpath.Configuration> configurer)

Allow transport-specific subclass builders to register a JSON Path MappingProvider that matches the JSON encoding/decoding they use.

Parameters:

configurer - a function applied to the JSON Path configuration

buildGraphQlTester

protected GraphQlTester buildGraphQlTester(GraphQlTransport transport)

Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlTester.

Parameters:

transport - the graphql transport to use

getBuilderInitializer

protected Consumer<AbstractGraphQlTesterBuilder<?>> getBuilderInitializer()

Subclasses call this from GraphQlTester.Builder.build() to obtain a Consumer to initialize new builder instances with, based on "this" builder.

asTransport

protected static GraphQlTransport asTransport(GraphQlClient client)

For cases where the Tester needs the GraphQlTransport, we can't use transports directly since they are package private, but we can adapt the corresponding GraphQlClient and adapt it to GraphQlTransport.

Parameters:

client - the graphql client to use for extracting the transport