Validate LocalDate in JSON response with Spring MockMVC

Question

I'm trying to validate a LocalDate object in a JSON result returned by a Spring MVC webservice but I can't figure out how.

At the moment I always run into assertion errors like the following one:

java.lang.AssertionError: JSON path "$[0].startDate" Expected: is <2017-01-01> but: was <[2017,1,1]>

The important part of my test is posted below. Any ideas how to fix the test to pass?

import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup;

public class WebserviceTest {

    @Mock
    private Service service;

    @InjectMocks
    private Webservice webservice;

    private MockMvc mockMvc;

    @Before
    public void before() {
        mockMvc = standaloneSetup(webservice).build();
    }

    @Test
    public void testLocalDate() throws Exception {
        // prepare service mock to return a valid result (left out)

        mockMvc.perform(get("/data/2017")).andExpect(status().isOk())
            .andExpect(jsonPath("$[0].startDate", is(LocalDate.of(2017, 1, 1))));
    }
}

The webservice returns a list of view objects looking like this:

public class ViewObject {

    @JsonProperty
    private LocalDate startDate;
}

[edit]

Another try was

.andExpect(jsonPath("$[0].startDate", is(new int[] { 2017, 1, 1 })))

which resulted in

java.lang.AssertionError: JSON path "$[0].startDate" Expected: is [<2017>, <1>, <1>] but: was <[2017,1,1]>

[edit 2] The returned startDate object seems to be of type: net.minidev.json.JSONArray

score 3 · Answer 1 · answered May 27 '20 at 22:20

3

This should pass:

.andExpect(jsonPath("$[0].startDate", is(LocalDate.of(2017, 1, 1).toString())));

answered May 27 '20 at 22:20

Jiří Švarc

31
1
1
3

Adding toString worked for me. – Inanc Cakil Jul 24 '23 at 11:00

score 2 · Accepted Answer · answered Oct 10 '17 at 06:49

2

This is the way to go. Thanks to 'Amit K Bist' to point me in the right direction

...
.andExpect(jsonPath("$[0].startDate[0]", is(2017)))
.andExpect(jsonPath("$[0].startDate[1]", is(1)))
.andExpect(jsonPath("$[0].startDate[2]", is(1)))

answered Oct 10 '17 at 06:49

GreenTurtle

1,144
2
21
35

score 1 · Answer 3 · answered Oct 10 '17 at 00:23

1

LocalDate in JSON response will be like "startDate":

"startDate": {
    "year": 2017,
    "month": "JANUARY",
    "dayOfMonth": 1,
    "dayOfWeek": "SUNDAY",
    "era": "CE",
    "dayOfYear": 1,
    "leapYear": false,
    "monthValue": 1,
    "chronology": {
        "id": "ISO",
        "calendarType": "iso8601"
    }
}

So, you should check each attribute like below:

.andExpect(jsonPath("$[0].startDate.year", is(2017)))
                .andExpect(jsonPath("$[0].startDate.dayOfMonth", is(1)))
                .andExpect(jsonPath("$[0].startDate.dayOfYear", is(1)))

answered Oct 10 '17 at 00:23

Amit K Bist

6,760
1
11
26

I did not realize that you are using jsr310 so above will work only for non-jsr310 localdate – Amit K Bist Oct 10 '17 at 04:49
Sorry: java.lang.AssertionError: No value at JSON path "$[0].startDate.year", exception: Expected to find an object with property ['year'] in path $[0]['startDate'] but found 'net.minidev.json.JSONArray'. This is not a json object according to the JsonProvider: 'com.jayway.jsonpath.spi.json.JsonSmartJsonProvider'. – GreenTurtle Oct 10 '17 at 06:32

score 0 · Answer 4 · answered Aug 17 '22 at 12:32

0

Because it expects a list of values, you can use it like that.

.andExpect(jsonPath("$[0].startDate", is(List.of(2022, 1, 1))))

answered Aug 17 '22 at 12:32

Mirkelor

1

marco · Answer 5 · 2017-10-09T15:02:38.557

-1

I think that at that level you are validating the Json not the parsed object. So you have a string, not a LocalDate.

So basically try changing your code in:

...
.andExpect(jsonPath("$[0].startDate", is("2017-01-01"))));

edited Oct 09 '17 at 15:02

answered Oct 09 '17 at 14:55

marco

671
6
22

1

This results into java.lang.AssertionError: JSON path "$[0].startDate" Expected: is "2017-01-01" but: was <[2017,1,1]> – GreenTurtle Oct 09 '17 at 15:18
better compare with org.springframework.test.web.servlet.result.JsonPathResultMatchers#value, i.e. `.andExpect(jsonPath("$[0].startDate").value("2017-01-01"))` – WeGa Dec 06 '21 at 13:07

Validate LocalDate in JSON response with Spring MockMVC

5 Answers5

Linked