Index
All Classes and Interfaces|All Packages
A
- AbstractDelegatingGraphQlTester - Class in org.springframework.graphql.test.tester
-
Base class for extensions of
GraphQlTesterthat mainly assist with building the underlying transport, but otherwise delegate to the defaultGraphQlTesterimplementation for actual request execution. - AbstractDelegatingGraphQlTester(GraphQlTester) - Constructor for class org.springframework.graphql.test.tester.AbstractDelegatingGraphQlTester
- AbstractGraphQlTesterBuilder<B extends AbstractGraphQlTesterBuilder<B>> - Class in org.springframework.graphql.test.tester
-
Abstract, base class for transport specific
GraphQlTester.Builderimplementations. - AbstractGraphQlTesterBuilder() - Constructor for class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
- asTransport(GraphQlClient) - Static method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
-
For cases where the Tester needs the
GraphQlTransport, we can't use transports directly since they are package private, but we can adapt the correspondingGraphQlClientand adapt it toGraphQlTransport.
B
- build() - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- build() - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder
-
Build a
ExecutionGraphQlServiceTesterinstance. - build() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Builder
-
Build the
GraphQlTester. - build() - Method in interface org.springframework.graphql.test.tester.HttpGraphQlTester.Builder
-
Build the
HttpGraphQlTesterinstance. - build() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Build the
RSocketGraphQlTesterinstance. - build() - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Build a
WebGraphQlTesterinstance. - build() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester.Builder
-
Build the
WebSocketGraphQlTester. - builder() - Static method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester
-
Start with a new
RSocketRequester.Buildercustomized for GraphQL, setting thedataMimeTypeto"application/graphql+json"and adding JSON codecs. - builder(String, WebSocketClient) - Static method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
-
Return a builder for a
WebSocketGraphQlClient. - builder(URI, WebSocketClient) - Static method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
-
Return a builder for a
WebSocketGraphQlClient. - builder(GraphQlTransport) - Static method in interface org.springframework.graphql.test.tester.GraphQlTester
-
Create a builder with a custom
GraphQlTransport. - builder(ExecutionGraphQlService) - Static method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester
-
Return a builder for
ExecutionGraphQlServiceTester. - builder(WebGraphQlHandler) - Static method in interface org.springframework.graphql.test.tester.WebGraphQlTester
-
Return a builder for a
WebGraphQlTester. - builder(RSocketRequester.Builder) - Static method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester
-
Start with a given
RSocketGraphQlTester.builder(). - builder(WebTestClient.Builder) - Static method in interface org.springframework.graphql.test.tester.HttpGraphQlTester
-
Return a builder to initialize an
HttpGraphQlTesterby creating the underlyingWebTestClientthrough the given builder. - buildGraphQlTester(GraphQlTransport) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
-
Build the default transport-agnostic client that subclasses can then wrap with
AbstractDelegatingGraphQlTester.
C
- clientTransport(ClientTransport) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- clientTransport(ClientTransport) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Use a given
ClientTransportto communicate with the remote server. - codecConfigurer(Consumer<CodecConfigurer>) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Configure the underlying
CodecConfigurerto use for all JSON encoding and decoding needs. - configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder
-
Provide a
BiFunctionto help initialize theExecutionInputwith. - configureJsonPathConfig(Function<Configuration, Configuration>) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
-
Allow transport-specific subclass builders to register a JSON Path
MappingProviderthat matches the JSON encoding/decoding they use. - contains(E...) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify the list contains the given values, in any order.
- containsExactly(E...) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify that the list contains exactly the given values and nothing else, in the same order.
- create(URI, WebSocketClient) - Static method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
-
Create a
WebSocketGraphQlTester. - create(ExecutionGraphQlService) - Static method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester
-
Create a
ExecutionGraphQlServiceTesterinstance. - create(WebGraphQlHandler) - Static method in interface org.springframework.graphql.test.tester.WebGraphQlTester
-
Create a
WebGraphQlTesterinstance. - create(WebTestClient) - Static method in interface org.springframework.graphql.test.tester.HttpGraphQlTester
-
Create an
HttpGraphQlTesterthat uses the givenWebTestClient.
D
- dataMimeType(MimeType) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- dataMimeType(MimeType) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Customize the format of data payloads for the connection.
- decoder(Decoder<?>) - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder
-
Configure the JSON decoder to use for mapping response data to higher level objects.
- DefaultRSocketGraphQlTesterBuilder - Class in org.springframework.graphql.test.tester
-
Default implementation of
RSocketGraphQlTester.Builderthat wraps anRSocketGraphQlClient.Builder. - DefaultRSocketGraphQlTesterBuilder(RSocketGraphQlClient) - Constructor for class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
-
Constructor to mutate.
- document(String) - Method in class org.springframework.graphql.test.tester.AbstractDelegatingGraphQlTester
- document(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester
-
Start defining a GraphQL request with the given document, which is the textual representation of an operation (or operations) to perform.
- documentName(String) - Method in class org.springframework.graphql.test.tester.AbstractDelegatingGraphQlTester
- documentName(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester
-
Variant of
GraphQlTester.document(String)that uses the given key to resolve the GraphQL document from a file with the help of the configuredDocumentSource. - documentSource(DocumentSource) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
- documentSource(DocumentSource) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Builder
-
Configure a
DocumentSourcefor use withGraphQlTester.documentName(String)for resolving a document by name. - doesNotContain(E...) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify the list does not contain the given values.
E
- encoder(Encoder<?>) - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder
-
Configure the JSON encoder to use for mapping response data to higher level objects.
- entity(Class<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to the target type.
- entity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to the target type.
- entityList(Class<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to a List of the target type.
- entityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Convert the data at the given path to a List of the target type.
- errorFilter(Predicate<ResponseError>) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
- errorFilter(Predicate<ResponseError>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Builder
-
Configure a global
filterthat applies to all requests. - errors() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Response
-
Return a spec to filter out or inspect errors.
- execute() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request and return a spec for further inspection of response data and errors.
- executeAndVerify() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request and verify the response contains no errors.
- executeSubscription() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Execute the GraphQL request as a subscription and return a spec with options to transform the result stream.
- ExecutionGraphQlServiceTester - Interface in org.springframework.graphql.test.tester
-
GraphQlTesterthat executes requests through anExecutionGraphQlServiceon the server side, without a client. - ExecutionGraphQlServiceTester.Builder<B extends ExecutionGraphQlServiceTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Default
ExecutionGraphQlServiceTester.Builderimplementation. - expect(Predicate<ResponseError>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors
-
Use this to declare errors that are expected.
- extension(String, Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Add a value for a protocol extension.
F
- filter(Predicate<ResponseError>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors
-
Use this to filter out errors that are expected and can be ignored.
- fragment(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Append the given fragment section to the
request document. - fragmentName(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Variant of
GraphQlTester.Request.fragment(String)that uses the given key to resolve the GraphQL fragment document from a file with the help of the configuredDocumentSource.
G
- get() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Return the decoded entity value(s).
- getBuilderInitializer() - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
-
Subclasses call this from
GraphQlTester.Builder.build()to obtain aConsumerto initialize new builder instances with, based on "this" builder. - GraphQlTester - Interface in org.springframework.graphql.test.tester
-
Define a workflow to test GraphQL requests that is independent of the underlying transport.
- GraphQlTester.Builder<B extends GraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
A builder to create a
GraphQlTesterinstance. - GraphQlTester.Entity<D,
S extends GraphQlTester.Entity<D, S>> - Interface in org.springframework.graphql.test.tester -
Contains a decoded entity and provides options to assert it.
- GraphQlTester.EntityList<E> - Interface in org.springframework.graphql.test.tester
-
Contains a List of decoded entities and provides options to assert them.
- GraphQlTester.Errors - Interface in org.springframework.graphql.test.tester
-
Declare options to filter out expected errors or inspect all errors and verify there are no unexpected errors.
- GraphQlTester.Path - Interface in org.springframework.graphql.test.tester
-
Options available to assert the response values at the current path.
- GraphQlTester.Request<T extends GraphQlTester.Request<T>> - Interface in org.springframework.graphql.test.tester
-
Declare options to gather input for a GraphQL request and execute it.
- GraphQlTester.Response - Interface in org.springframework.graphql.test.tester
-
Declare options to check the data and errors of a GraphQL response.
- GraphQlTester.Subscription - Interface in org.springframework.graphql.test.tester
-
Declare options available to assert a GraphQL Subscription response.
- GraphQlTester.Traversable - Interface in org.springframework.graphql.test.tester
-
Declare options to switch to different part of the GraphQL response.
H
- hasSize(int) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify the number of values in the list.
- hasSizeGreaterThan(int) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify the list has more than the specified number of values.
- hasSizeLessThan(int) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList
-
Verify the list has fewer than the number of values.
- hasValue() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Verify there is a
non-nullvalue or a non-empty list at the current path. - header(String, String...) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Add the given header to HTTP requests or to the WebSocket handshake request.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Variant of
WebGraphQlTester.Builder.header(String, String...)that provides access to the underlying headers to inspect or modify directly. - HttpGraphQlTester - Interface in org.springframework.graphql.test.tester
-
GraphQL over HTTP tester that uses
WebTestClientand supports tests with or without a running server, depending on howWebTestClientis configured. - HttpGraphQlTester.Builder<B extends HttpGraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Builder for the GraphQL over HTTP tester.
I
- interceptor(GraphQlClientInterceptor...) - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester.Builder
-
Configure interceptors to be invoked before delegating to the
GraphQlTransportto perform the request. - interceptors(Consumer<List<GraphQlClientInterceptor>>) - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester.Builder
-
Customize the list of interceptors.
- isEqualTo(Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the decoded entity is equal to the given value.
- isNotEqualTo(Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the decoded entity is not equal to the given value.
- isNotSameAs(Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the decoded entity is not the same instance as the given value.
- isSameAs(Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the decoded entity is the same instance as the given value.
M
- matches(Predicate<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the decoded entity matches the given predicate.
- matchesJson(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Parse the JSON at the given path and the given expected JSON and assert that the two are "similar".
- matchesJsonStrictly(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Parse the JSON at the given path and the given expected JSON and assert that the two are "similar" so they contain the same attribute-value pairs regardless of formatting, along with lenient checking, e.g.
- mutate() - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester
- mutate() - Method in interface org.springframework.graphql.test.tester.GraphQlTester
-
Create a builder initialized from the configuration of "this" tester.
- mutate() - Method in interface org.springframework.graphql.test.tester.HttpGraphQlTester
- mutate() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester
- mutate() - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester
- mutate() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
O
- operationName(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Set the operation name.
- org.springframework.graphql.test.tester - package org.springframework.graphql.test.tester
-
GraphQL client testing support.
P
- path(String) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Traversable
-
Navigate to a path under the "data" section of the GraphQL response.
- path(String, Consumer<GraphQlTester.Path>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Traversable
-
Variant of
GraphQlTester.Traversable.path(String)with a callback that allows inspecting multiple paths under the given path. - pathDoesNotExist() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Verify the current path does not exist.
R
- responseTimeout(Duration) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder
- responseTimeout(Duration) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Builder
-
Max amount of time to wait for a GraphQL response.
- route(String) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- route(String) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Customize the route to specify in the metadata of each request so the server can route it to the handler for GraphQL requests.
- RSocketGraphQlTester - Interface in org.springframework.graphql.test.tester
-
GraphQL over RSocket tester that uses
RSocketRequester. - RSocketGraphQlTester.Builder<B extends RSocketGraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Builder for a GraphQL over RSocket tester.
- rsocketRequester(Consumer<RSocketRequester.Builder>) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- rsocketRequester(Consumer<RSocketRequester.Builder>) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Customize the underlying
RSocketRequesterto use.
S
- satisfies(Consumer<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity
-
Verify the entity with the given
Consumer. - satisfy(Consumer<List<ResponseError>>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors
-
Inspect errors in the response, if any.
- start() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester
-
Start the RSocket session.
- start() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
-
This is delegated to the
start()method of the underlyingWebSocketGraphQlClient. - stop() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester
-
Stop the RSocket session.
- stop() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester
-
This is delegated to the
stop()method of the underlyingWebSocketGraphQlClient.
T
- tcp(String, int) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- tcp(String, int) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Select TCP as the underlying network protocol.
- toFlux() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Subscription
-
Return a
FluxofGraphQlTester.Responseinstances, each representing an individual subscription event. - toFlux(String, Class<T>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Subscription
-
Return a
Fluxof entities converted from some part of the data in each subscription event.
U
- url(String) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Set the GraphQL endpoint URL as a String.
- url(URI) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder
-
Set the GraphQL endpoint URL.
V
- valueIsNull() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Path
-
Verify there is a
nullvalue at the current path. - variable(String, Object) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Add a variable.
- variables(Map<String, Object>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Request
-
Add variables from a
Map. - verify() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors
-
Verify there are either no errors or that there are no unexpected errors that have not been
filtered out.
W
- WebGraphQlTester - Interface in org.springframework.graphql.test.tester
-
Server-side tester, without a client, that executes requests through a
WebGraphQlHandler. - WebGraphQlTester.Builder<B extends WebGraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Common builder for Web
GraphQlTesterextensions. - webSocket(URI) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder
- webSocket(URI) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder
-
Select WebSocket as the underlying network protocol.
- WebSocketGraphQlTester - Interface in org.springframework.graphql.test.tester
-
GraphQL over WebSocket client that uses
WebSocketClient. - WebSocketGraphQlTester.Builder<B extends WebSocketGraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester
-
Builder for a GraphQL over WebSocket tester.
- webTestClient(Consumer<WebTestClient.Builder>) - Method in interface org.springframework.graphql.test.tester.HttpGraphQlTester.Builder
-
Customize the
WebTestClientto use.
All Classes and Interfaces|All Packages