Package org.springframework.test.web.servlet.assertj

Class AssertableMockMvc

java.lang.Object

org.springframework.test.web.servlet.assertj.AssertableMockMvc

public final class AssertableMockMvc
extends Object

MockMvc variant that tests Spring MVC exchanges and provides fluent assertions using AssertJ.

A main difference with MockMvc is that an unresolved exception is not thrown directly. Rather an AssertableMvcResult is available with an unresolved exception.

AssertableMockMvc can be configured with a list of message converters to allow the response body to be deserialized, rather than asserting on the raw values.

Since:

6.2

Author:

Stephane Nicoll, Brian Clozel

Method Summary

Modifier and Type	Method	Description
static AssertableMockMvc	create(MockMvc mockMvc)	Create a AssertableMockMvc instance that delegates to the given MockMvc instance.
static AssertableMockMvc	from(WebApplicationContext applicationContext)	Shortcut to create an AssertableMockMvc instance using the given, fully initialized (i.e., refreshed) WebApplicationContext.
static AssertableMockMvc	from(WebApplicationContext applicationContext, Function<DefaultMockMvcBuilder,MockMvc> customizations)	Create an AssertableMockMvc instance using the given, fully initialized (i.e., refreshed) WebApplicationContext.
static AssertableMockMvc	of(Object... controllers)	Shortcut to create an AssertableMockMvc instance by registering one or more @Controller instances.
static AssertableMockMvc	of(Collection<?> controllers, Function<StandaloneMockMvcBuilder,MockMvc> customizations)	Create an AssertableMockMvc instance by registering one or more @Controller instances and configuring Spring MVC infrastructure programmatically.
AssertableMvcResult	perform(RequestBuilder requestBuilder)	Perform a request and return a type that can be used with standard AssertJ assertions.
AssertableMockMvc	withHttpMessageConverters(Iterable<HttpMessageConverter<?>> httpMessageConverters)	Return a new AssertableMockMvc instance using the specified message converters.

Methods inherited from class java.lang.Object

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

Method Details

create

public static AssertableMockMvc create(MockMvc mockMvc)

Create a AssertableMockMvc instance that delegates to the given MockMvc instance.

Parameters:

mockMvc - the MockMvc instance to delegate calls to

from

public static AssertableMockMvc from(WebApplicationContext applicationContext,
 Function<DefaultMockMvcBuilder,MockMvc> customizations)

Create an AssertableMockMvc instance using the given, fully initialized (i.e., refreshed) WebApplicationContext. The given customizations are applied to the DefaultMockMvcBuilder that ultimately creates the underlying MockMvc instance.

If no further customization of the underlying MockMvc instance is required, use from(WebApplicationContext).

Parameters:

applicationContext - the application context to detect the Spring MVC infrastructure and application controllers from

customizations - a function that creates a MockMvc instance based on a DefaultMockMvcBuilder.

See Also:

• MockMvcBuilders.webAppContextSetup(WebApplicationContext)

from

public static AssertableMockMvc from(WebApplicationContext applicationContext)

Shortcut to create an AssertableMockMvc instance using the given, fully initialized (i.e., refreshed) WebApplicationContext.

Consider using from(WebApplicationContext, Function) if further customization of the underlying MockMvc instance is required.

Parameters:

applicationContext - the application context to detect the Spring MVC infrastructure and application controllers from

See Also:

• MockMvcBuilders.webAppContextSetup(WebApplicationContext)

of

public static AssertableMockMvc of(Collection<?> controllers,
 Function<StandaloneMockMvcBuilder,MockMvc> customizations)

Create an AssertableMockMvc instance by registering one or more @Controller instances and configuring Spring MVC infrastructure programmatically.

This allows full control over the instantiation and initialization of controllers and their dependencies, similar to plain unit tests while also making it possible to test one controller at a time.

Parameters:

controllers - one or more @Controller instances or @Controller types to test; a type (Class) will be turned into an instance

customizations - a function that creates a MockMvc instance based on a StandaloneMockMvcBuilder, typically to configure the Spring MVC infrastructure

See Also:

• MockMvcBuilders.standaloneSetup(Object...)

of

public static AssertableMockMvc of(Object... controllers)

Shortcut to create an AssertableMockMvc instance by registering one or more @Controller instances.

The minimum infrastructure required by the DispatcherServlet to serve requests with annotated controllers is created. Consider using of(Collection, Function) if additional configuration of the MVC infrastructure is required.

Parameters:

controllers - one or more @Controller instances or @Controller types to test; a type (Class) will be turned into an instance

See Also:

• MockMvcBuilders.standaloneSetup(Object...)

withHttpMessageConverters

public AssertableMockMvc withHttpMessageConverters(Iterable<HttpMessageConverter<?>> httpMessageConverters)

Return a new AssertableMockMvc instance using the specified message converters.

If none are specified, only basic assertions on the response body can be performed. Consider registering a suitable JSON converter for asserting against JSON data structures.

Parameters:

httpMessageConverters - the message converters to use

Returns:

a new instance using the specified converters

perform

public AssertableMvcResult perform(RequestBuilder requestBuilder)

Perform a request and return a type that can be used with standard AssertJ assertions.

Use static methods of MockMvcRequestBuilders to prepare the request, wrapping the invocation in assertThat. The following asserts that a GET request against "/greet" has an HTTP status code 200 (OK) and a simple body:

assertThat(mvc.perform(get("/greet")))
       .hasStatusOk()
       .body().asString().isEqualTo("Hello");
 

Contrary to MockMvc.perform(RequestBuilder), this does not throw an exception if the request fails with an unresolved exception. Rather, the result provides the exception, if any. Assuming that a POST request against /boom throws an IllegalStateException, the following asserts that the invocation has indeed failed with the expected error message:

assertThat(mvc.perform(post("/boom")))
       .unresolvedException().isInstanceOf(IllegalStateException.class)
       .hasMessage("Expected");
 

Parameters:

requestBuilder - used to prepare the request to execute; see static factory methods in MockMvcRequestBuilders

Returns:

an AssertableMvcResult to be wrapped in assertThat

See Also:

• MockMvc.perform(RequestBuilder)