mockMvc - Test Error Message

Question

Does anybody have any tips, or does anybody know how I can test the "error message" returned by the HTTP response object?

@Autowired
private WebApplicationContext ctx;

private MockMvc mockMvc;

@Before
public void setUp() throws Exception {
    mockMvc = MockMvcBuilders.webAppContextSetup(ctx).build();
}

Response:

MockHttpServletResponse:
              Status = 200
       Error message = null
             Headers = {Content-Type=[application/json;charset=UTF-8]}
        Content type = application/json;charset=UTF-8

does [this](https://developer.mozilla.org/en-US/docs/Web/HTTP/Response_codes) helps you. — Ankur Singhal, Aug 13 '14 at 15:19
I am pretty sure that `.andExpect(model().hasNoErrors())` will do the trick — geoand, Aug 13 '14 at 17:58
Any way I can do something like assertEquals("expected error message", "actual error message") instead of .andExpect(model().hasNoErrors()) — Vinchenzo, Aug 13 '14 at 18:07
see https://github.com/spring-projects/spring-boot/issues/7321 — ams, Mar 09 '20 at 00:42

score 68 · Accepted Answer · answered Aug 07 '15 at 16:24

You can use the method status.reason().

For example:

     @Test
     public void loginWithBadCredentials() {
        this.mockMvc.perform(
                post("/rest/login")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content("{\"username\": \"baduser\", \"password\": \"invalidPassword\"}")
                )
                .andDo(MockMvcResultHandlers.print())
                .andExpect(status().isUnauthorized())
                .andExpect(status().reason(containsString("Bad credentials")))
                .andExpect(unauthenticated());
    }


    MockHttpServletResponse:
                  Status = 401
           Error message = Authentication Failed: Bad credentials
            Content type = null
                    Body = 
           Forwarded URL = null
          Redirected URL = null
                 Cookies = []

score 9 · Answer 2 · answered Oct 09 '18 at 08:22

9

Even simpler:

String error =  mockMvc...
    .andExpect(status().isUnauthorized())
    .andReturn().getResolvedException().getMessage();

assertTrue(StringUtils.contains(error, "Bad credentials"));

answered Oct 09 '18 at 08:22

membersound

81,582
193
585
1,120

score 3 · Answer 3 · edited Nov 20 '18 at 01:14

3

This is the solution I found using JsonPath and MockMvc

this.mvc.perform(post(BASE_URL).contentType(MediaType.APPLICATION_JSON).content(responseJson)).andDo(print())
.andExpect(status().is5xxServerError())
.andExpect(jsonPath("$.message", is("There is an error while executing this test request ")));

Hope this helps.

edited Nov 20 '18 at 01:14

DaFois

2,197
8
26
43

answered Nov 19 '18 at 13:37

Akshay Shinde

159
8

2

`jsonPath` seems to work only when "Body" is not empty, which is true for the above case. – Yi Doe Feb 07 '20 at 11:25

score 3 · Answer 4 · answered Jul 05 '20 at 20:05

3

it works for me:

.andExpect( status().reason( "invalid.duplicate" ) )

answered Jul 05 '20 at 20:05

XING

31
1

By itself? Without e.g. `.andExpect(status().isUnauthorized())`, as proposed in other answers? – Jeremy Caney Jul 05 '20 at 22:27
it's just a code snippet, please work with other .andExpect( ... ) – XING Jul 06 '20 at 23:04

mockMvc - Test Error Message

4 Answers4

Linked