Using Spring's mockMvc, how do I check if the returned data contains part of a string?

Question

I’m using Spring 3.2.11.RELEASE and JUnit 4.11. Using the Spring mockMvc framework, how do I check if a method returning JSON data contains a particular JSON element? I have

    mockMvc.perform(get("/api/users/" + id))
        .andExpect(status().isOk())
        .andExpect(content().string("{\"id\":\"" + id + "\"}"));

but this checks for an exact match against the string returned and I’d rather check if the JSON string contains the value contained by my local field “id”.

score 48 · Accepted Answer · answered May 18 '16 at 16:18

Looks like you can pass a Hamcrest Matcher instead of a string there. Should be something like:

mockMvc.perform(get("/api/users/" + id))
    .andExpect(status().isOk())
    .andExpect(content().string(org.hamcrest.Matchers.containsString("{\"id\":\"" + id + "\"}")));

score 19 · Answer 2 · answered Nov 13 '18 at 10:03

19

A more appropriate way to do that is:

mockMvc.perform(get("/api/users/" + id))
    .andExpect(status().isOk())
    .andExpect(jsonPath("$.id", org.hamcrest.Matchers.is(id)));

answered Nov 13 '18 at 10:03

Jean-Christophe

624
5
11

score 15 · Answer 3 · answered Oct 20 '21 at 11:54

15

I know it's been too many years, but still, I hope my answer can be useful for someone =) When I need to check if a json value form a response contains some string I use containsString method:

mockMvc.perform(post("/url")
        .contentType(MediaType.APPLICATION_JSON_VALUE)
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.field1").value(value1))
        .andExpect(jsonPath("$.field2", containsString(value2)));

answered Oct 20 '21 at 11:54

Elizaveta Kuznetsova

329
4
6

this should be a right answer! – radistao Feb 28 '23 at 13:31

score 7 · Answer 4 · answered May 22 '17 at 20:14

Another way you can get to the String respone of a mockMVC requst so you can compare or manipulate it in other ways is as follows:

MvcResult result = mockMvc.perform(get("/api/users/" + id))
    .andExpect(status().isOk())
    .andReturn();
String stringResult = result.getResponse().getContentAsString();
boolean doesContain = stringResult.contains("{\"id\":\"" + id + "\"}");

You could also wrap the whole thing in an assertTrue while still using String methods:

assertTrue(mockMvc.perform(get("/api/users/" + id))
    .andExpect(status().isOk())
    .andReturn()
    .getResponse()
    .getContentAsString()
    .contains("{\"id\":\"" + id + "\"}");

I prefer the approved answer, just thought I would submit this as another alternative.

Using Spring's mockMvc, how do I check if the returned data contains part of a string?

4 Answers4