Interface RestTestClient

public interface RestTestClient

Client for testing web servers that uses RestClient internally to perform requests while also providing a fluent API to verify responses.

This client can connect to any server over HTTP or to a MockMvc server with a mock request and response.

Use one of the bindToXxx() methods to create an instance. For example:

• bindToController(Object...)
• bindToRouterFunction(RouterFunction[])
• bindToApplicationContext(WebApplicationContext)
• bindToServer()
• ...

Since:

7.0

Author:

Rob Worsnop, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RestTestClient.BodyContentSpec	Spec for expectations on the response body content.
static interface	RestTestClient.BodySpec<B, S extends RestTestClient.BodySpec<B,S>>	Spec for expectations on the response body decoded to a single Object.
static interface	RestTestClient.Builder<B extends RestTestClient.Builder<B>>	Steps to customize the underlying RestClient via RestClient.Builder.
static interface	RestTestClient.MockMvcSetupBuilder<S extends RestTestClient.Builder<S>, M extends MockMvcBuilder>	Extension of RestTestClient.Builder for tests against a MockMvc server.
static interface	RestTestClient.RequestBodySpec	Specification for providing the body of a request.
static interface	RestTestClient.RequestBodyUriSpec	Specification for providing the body and the URI of a request.
static interface	RestTestClient.RequestHeadersSpec<S extends RestTestClient.RequestHeadersSpec<S>>	Specification for adding request headers and performing an exchange.
static interface	RestTestClient.RequestHeadersUriSpec<S extends RestTestClient.RequestHeadersSpec<S>>	Specification for providing request headers and the URI of a request.
static interface	RestTestClient.ResponseSpec	Chained API for applying assertions to a response.
static interface	RestTestClient.RouterFunctionSetupBuilder	Extension of RestTestClient.Builder for tests against а RouterFunction MockMvc setup.
static interface	RestTestClient.StandaloneSetupBuilder	Extension of RestTestClient.Builder for tests against а standalone MockMvc setup.
static interface	RestTestClient.UriSpec<S extends RestTestClient.RequestHeadersSpec<?>>	Specification for providing the URI of a request.
static interface	RestTestClient.WebAppContextSetupBuilder	Extension of RestTestClient.Builder for tests against а WebAppContext MockMvc setup.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESTTESTCLIENT_REQUEST_ID	The name of a request header used to assign a unique ID to every request performed through the RestTestClient.

Method Summary

Modifier and Type	Method	Description
static RestTestClient.Builder<?>	bindTo(MockMvc mockMvc)	Begin creating a RestTestClient by providing an already initialized MockMvc instance to use as the server.
static RestTestClient.WebAppContextSetupBuilder	bindToApplicationContext(WebApplicationContext context)	Begin creating a RestTestClient with a WebApplicationContext MockMvc setup.
static RestTestClient.StandaloneSetupBuilder	bindToController(Object... controllers)	Begin creating a RestTestClient with a Standalone MockMvc setup.
static RestTestClient.RouterFunctionSetupBuilder	bindToRouterFunction(RouterFunction<?>... routerFunctions)	Begin creating a RestTestClient with a RouterFunction MockMvc setup.
static RestTestClient.Builder<?>	bindToServer()	This server setup option allows you to connect to a live server.
static RestTestClient.Builder<?>	bindToServer(ClientHttpRequestFactory requestFactory)	A variant of bindToServer() with a pre-configured request factory.
RestTestClient.RequestHeadersUriSpec<?>	delete()	Prepare an HTTP DELETE request.
RestTestClient.RequestHeadersUriSpec<?>	get()	Prepare an HTTP GET request.
RestTestClient.RequestHeadersUriSpec<?>	head()	Prepare an HTTP HEAD request.
RestTestClient.RequestBodyUriSpec	method(HttpMethod method)	Prepare a request for the specified HttpMethod.
<B extends RestTestClient.Builder<B>> RestTestClient.Builder<B>	mutate()	Return a builder to mutate properties of this test client.
RestTestClient.RequestHeadersUriSpec<?>	options()	Prepare an HTTP OPTIONS request.
RestTestClient.RequestBodyUriSpec	patch()	Prepare an HTTP PATCH request.
RestTestClient.RequestBodyUriSpec	post()	Prepare an HTTP POST request.
RestTestClient.RequestBodyUriSpec	put()	Prepare an HTTP PUT request.

Field Details

RESTTESTCLIENT_REQUEST_ID

static final String RESTTESTCLIENT_REQUEST_ID

The name of a request header used to assign a unique ID to every request performed through the RestTestClient. This can be useful to store contextual information under that ID at all phases of request processing (for example, from a server-side component) and later look up that information once an ExchangeResult is available.

See Also:

• Constant Field Values

Method Details

get

RestTestClient.RequestHeadersUriSpec<?> get()

Prepare an HTTP GET request.

Returns:

a spec for specifying the target URL

head

RestTestClient.RequestHeadersUriSpec<?> head()

Prepare an HTTP HEAD request.

Returns:

a spec for specifying the target URL

post

RestTestClient.RequestBodyUriSpec post()

Prepare an HTTP POST request.

Returns:

a spec for specifying the target URL

put

RestTestClient.RequestBodyUriSpec put()

Prepare an HTTP PUT request.

Returns:

a spec for specifying the target URL

patch

RestTestClient.RequestBodyUriSpec patch()

Prepare an HTTP PATCH request.

Returns:

a spec for specifying the target URL

delete

RestTestClient.RequestHeadersUriSpec<?> delete()

Prepare an HTTP DELETE request.

Returns:

a spec for specifying the target URL

options

RestTestClient.RequestHeadersUriSpec<?> options()

Prepare an HTTP OPTIONS request.

Returns:

a spec for specifying the target URL

method

RestTestClient.RequestBodyUriSpec method(HttpMethod method)

Prepare a request for the specified HttpMethod.

Returns:

a spec for specifying the target URL

mutate

<B extends RestTestClient.Builder<B>>
RestTestClient.Builder<B> mutate()

Return a builder to mutate properties of this test client.

bindToController

static RestTestClient.StandaloneSetupBuilder bindToController(Object... controllers)

Begin creating a RestTestClient with a Standalone MockMvc setup.

bindToRouterFunction

static RestTestClient.RouterFunctionSetupBuilder bindToRouterFunction(RouterFunction<?>... routerFunctions)

Begin creating a RestTestClient with a RouterFunction MockMvc setup.

bindToApplicationContext

static RestTestClient.WebAppContextSetupBuilder bindToApplicationContext(WebApplicationContext context)

Begin creating a RestTestClient with a WebApplicationContext MockMvc setup.

bindTo

static RestTestClient.Builder<?> bindTo(MockMvc mockMvc)

Begin creating a RestTestClient by providing an already initialized MockMvc instance to use as the server.

bindToServer

static RestTestClient.Builder<?> bindToServer()

This server setup option allows you to connect to a live server.

RestTestClient client = RestTestClient.bindToServer()
        .baseUrl("http://localhost:8080")
        .build();

Returns:

chained API to customize client config

bindToServer

static RestTestClient.Builder<?> bindToServer(ClientHttpRequestFactory requestFactory)

A variant of bindToServer() with a pre-configured request factory.

Returns:

chained API to customize client config