Package org.springframework.test.web.servlet

Interface ResultActions

public interface ResultActions
Allows applying actions, such as expectations, on the result of an executed request.

See static factory methods in MockMvcResultMatchers and MockMvcResultHandlers.

Since:
3.2
Author:
Rossen Stoyanchev, Sam Brannen, Michał Rowicki

  • Method Details

    • andExpect

      ResultActions andExpect(ResultMatcher matcher) throws Exception
      Perform an expectation.

      Example

      You can invoke andExpect() multiple times as in the following example. 

       // static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*

 mockMvc.perform(get("/person/1"))
   .andExpect(status().isOk())
   .andExpect(content().contentType(MediaType.APPLICATION_JSON))
   .andExpect(jsonPath("$.person.name").value("Jason"));
      Throws:
      Exception
      See Also:

    • andExpectAll

      default ResultActions andExpectAll(ResultMatcher... matchers) throws Exception
      Perform multiple expectations, with the guarantee that all expectations will be asserted even if one or more expectations fail with an exception.

      If a single Error or Exception is thrown, it will be rethrown.

      If multiple exceptions are thrown, this method will throw an AssertionError whose error message is a summary of all the exceptions. In addition, each exception will be added as a suppressed exception to the AssertionError.

      This feature is similar to the SoftAssertions support in AssertJ and the assertAll() support in JUnit Jupiter.

      Example

      Instead of invoking andExpect() multiple times, you can invoke andExpectAll() as in the following example. 

       // static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*

 mockMvc.perform(get("/person/1"))
   .andExpectAll(
       status().isOk(),
       content().contentType(MediaType.APPLICATION_JSON),
       jsonPath("$.person.name").value("Jason")
   );
      Throws:
      Exception
      Since:
      5.3.10
      See Also:

    • andDo

      ResultActions andDo(ResultHandler handler) throws Exception
      Perform a general action.

      Example

       static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*

 mockMvc.perform(get("/form")).andDo(print());
      Throws:
      Exception

    • andReturn

      MvcResult andReturn()
      Return the result of the executed request for direct access to the results.
      Returns:
      the result of the request