Asserting array of arrays with JSONPath and spring mvc

Question

I'm having difficulty figuring out how to assert with jsonPath in a JSON document response in spring mvc. Perhaps there's a better way of accomplishing this than using jsonPath for this particular scenario. I would like to validate that the links array has a rel item of "self" and that "href" attribute of the object of "self" also has an "href" attribute which is equal to "/". The JSON response looks like this:

 {  
   "links":[  
      {  
         "rel":[  
            "self"
         ],
         "href":"/"
      },
      {  
         "rel":[  
            "next"
         ],
         "href":"/1"
      }
   ]
}

I tried this where I can see that it has rel [0] has self but I would prefer to not rely on where in the links array and rel array the self is and actually test what that href is at links[rel][self] is "/". Any ideas?

 @Before
  public void setup() {
    MockitoAnnotations.initMocks(this);
    mockMvc = MockMvcBuilders.standaloneSetup(welcomeController).build();
  }

  @Test
  public void givenRootUrl_thenReturnLinkToSelf() throws Exception {
    mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
        .andExpect(jsonPath("$.links[0].rel[0].", is("self")));
  }

Akmal Rakhimov · Accepted Answer · 2015-04-14 10:27:42Z

46

How about adding several andExpect methods? Something similar to:

mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
    .andExpect(jsonPath("$.links[0].rel[0]", is("self")))
    .andExpect(jsonPath("$.links[0].href[0]", is("/"));

answered Apr 14, 2015 at 10:27

Akmal Rakhimov

4996 silver badges5 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Kevin M Over a year ago

Do you know if there is a way to do this without hardcoding the array indices (in case the order is different)?

Akmal Rakhimov Over a year ago

Kevin, you can use regexp in your jsonpath, like this $.links[?(@.rel =~ /.*self/i)] or something like this. Please, check full documentation here: github.com/json-path/JsonPath

Leonid Dashko Over a year ago

This approach won't work for HashSet because the order of elements is not deterministic

moffeltje · Accepted Answer · 2021-07-02 13:42:23Z

12

I guess you could do it like this if you don't want to hardcode array index value

MockMvc.perform(get("/"))
.andDo(print()).andExpect(status().isOk())
.andExpect(jsonPath("$.links[*].rel").value(Matchers.containsInAnyOrder(Matchers.containsInAnyOrder(Matchers.is("self")))));

edited Jul 2, 2021 at 13:42

moffeltje

4,6878 gold badges40 silver badges65 bronze badges

answered Dec 13, 2020 at 4:28

Satrajit A

3102 silver badges10 bronze badges

Comments

robjwilkins · Accepted Answer · 2023-01-05 17:07:12Z

The Accepted answer looks alright to me. But I am not familiar with junit4. Therefore I will add here how I would test a typical scenario using Junit5.

mockMvc.perform(get("/"))
    .andDo(print())
    .andExpect(status().isOk())
    .andExpect(jsonPath("$.links", hasSize(2)))
    .andExpect(jsonPath("$.links[0].rel[0]")
        .value("self"))
    .andExpect(jsonPath("$.links[0].href[0]")
        .value("/"))

I will here add static imports(in case of a beginner) because when first I was working of I had to figure which imports within several imports.

import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import static org.hamcrest.Matchers.hasSize;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.hamcrest.CoreMatchers.is;

Hope this is helpful for someone. especially someone new to unit testing :)

Ahmed Ashref · Accepted Answer · 2022-04-05 14:12:44Z

3

you can try :

mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
    .andExpect(jsonPath("$.links[*].rel[*]", containsInAnyOrder("self")))
    .andExpect(jsonPath("$.links[*].href[*]", containsInAnyOrder("/")))

answered Apr 5, 2022 at 14:12

Ahmed Ashref

311 bronze badge

Comments

Tushar Guliany · Accepted Answer · 2024-02-15 14:08:05Z

2

I know a very old post and you have probably figured it out already, but for the sake of new devs wondering this question, like me.

You can use the following.

import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.hasSize;
.......AdditionalCode
.andExpect(jsonPath("$.path").isArray())
.andExpect(jsonPath("$.path").value(hasSize(2))
.andExpect(jsonPath("$.path").value(hasItem("self!"))

Source => https://mkyong.com/spring-boot/spring-test-how-to-test-a-json-array-in-jsonpath/

answered Feb 15, 2024 at 14:08

Tushar Guliany

318 bronze badges

Collectives™ on Stack Overflow

Asserting array of arrays with JSONPath and spring mvc

5 Answers 5

3 Comments

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

3 Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related