Spring MVC controller Test - print the result JSON String

Question

Hi I have a Spring mvc controller

@RequestMapping(value = "/jobsdetails/{userId}", method = RequestMethod.GET)
@ResponseBody
public List<Jobs> jobsDetails(@PathVariable Integer userId,HttpServletResponse response) throws IOException {
    try {       
        Map<String, Object> queryParams=new LinkedHashMap<String, Object>(); 

        queryParams.put("userId", userId);

        jobs=jobsService.findByNamedQuery("findJobsByUserId", queryParams);

    } catch(Exception e) {
        logger.debug(e.getMessage());
        response.sendError(HttpServletResponse.SC_BAD_REQUEST);
    }
    return jobs;
}

I want to see how the JSON String will looks like when I run this. I wrote this test case

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration("classpath:webapptest")
@ContextConfiguration(locations = {"classpath:test-applicationcontext.xml"})
public class FindJobsControllerTest {
private MockMvc springMvc;

    @Autowired
    WebApplicationContext wContext;

    @Before
    public void init() throws Exception {
        springMvc = MockMvcBuilders.webAppContextSetup(wContext).build();
    }

    @Test
    public void documentsPollingTest() throws Exception {
        ResultActions resultActions = springMvc.perform(MockMvcRequestBuilders.get("/jobsdetails/2").accept(MediaType.APPLICATION_JSON));

        System.out.println(/* Print the JSON String */); //How ?
    }
}

How to get the JSON string?

I am using Spring 3, codehause Jackson 1.8.4

Shiva Saurabh · Accepted Answer · 2014-02-01 08:58:28Z

211

Try this code:

resultActions.andDo(MockMvcResultHandlers.print());

edited Feb 1, 2014 at 8:58

Shiva Saurabh

1,2892 gold badges26 silver badges47 bronze badges

answered Feb 1, 2014 at 8:29

JB Nizet

694k94 gold badges1.3k silver badges1.3k bronze badges

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

1 Comment

delucasvb Over a year ago

Thank you for not just using print() but adding its class name, unlike many other search results!

jax · Accepted Answer · 2014-02-01 22:29:40Z

74

The trick is to use andReturn()

MvcResult result = springMvc.perform(MockMvcRequestBuilders
         .get("/jobsdetails/2").accept(MediaType.APPLICATION_JSON)).andReturn();

String content = result.getResponse().getContentAsString();

edited Feb 1, 2014 at 22:29

answered Feb 1, 2014 at 8:43

jax

38.8k61 gold badges187 silver badges288 bronze badges

Comments

uiroshan · Accepted Answer · 2017-06-20 06:07:59Z

24

You can enable printing response of each test method when setting up the MockMvc instance.

springMvc = MockMvcBuilders.webAppContextSetup(wContext)
               .alwaysDo(MockMvcResultHandlers.print())
               .build();

Notice the .alwaysDo(MockMvcResultHandlers.print()) part of the above code. This way you can avoid applying print handler for each test method.

answered Jun 20, 2017 at 6:07

uiroshan

5,2012 gold badges41 silver badges37 bronze badges

Comments

Chris Sim · Accepted Answer · 2016-08-05 11:51:45Z

10

For me it worked when I used the code below:

ResultActions result =
     this.mockMvc.perform(post(resource).sessionAttr(Constants.SESSION_USER, user).param("parameter", "parameterValue"))
        .andExpect(status().isOk());
String content = result.andReturn().getResponse().getContentAsString();

And it worked !! :D

Hope I can help the other with my answer

answered Aug 5, 2016 at 11:51

Chris Sim

4,1324 gold badges32 silver badges36 bronze badges

Comments

funkygono · Accepted Answer · 2014-02-01 09:27:04Z

0

If you are testing the Controller, you won't get the JSon result, which is returned by the view. Whether you can test the view (or test the controller and then the view), or starting a servlet contrainer (with Cargo for example), and test at HTTP level, which is a good way to check what really happen.

answered Feb 1, 2014 at 9:27

funkygono

4203 silver badges5 bronze badges

2 Comments

jax Over a year ago

Actually you can get the JSON response from the controller using .andReturn()

funkygono Over a year ago

Oh yes, that's true, I just saw this in your answer. I didn't know Spring offered so much mocks, that's very great.

Kirill · Accepted Answer · 2022-08-28 11:16:55Z

0

For modern projects using Spring Boot, where MockMvc is already pre-configured for you with a single @WebMvcTest "slicing" test annotation, the easiest answer to the question would be explicitly adding @AutoConfigureMockMvc with printOnlyOnFailure = false:

@WebMvcTest(MyController.class)
@AutoConfigureMockMvc(printOnlyOnFailure = false)
class MySlicedControllerTest {
  // ...
}

answered Aug 28, 2022 at 11:16

Kirill

8,3885 gold badges63 silver badges106 bronze badges

Collectives™ on Stack Overflow

Spring MVC controller Test - print the result JSON String

6 Answers 6

1 Comment

Comments

Comments

Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

1 Comment

Comments

Comments

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related