Print cookies in human-readable form in Spring MVC Test [SPR-13168]

[spring-projects-issues]

Sam Brannen opened SPR-13168 and commented

Status Quo

When rendering cookies via andDo(print()) in Spring MVC Test, the output for the MockHttpServletResponse looks something like the following:

Cookies = [javax.servlet.http.Cookie@3ccd3277]

The reason is that Cookie in javax.servlet-api-3.0.1.jar does not implement toString(). Consequently, nothing about the cookie's name, value, etc., is displayed, thereby making the debug output for cookies next to useless.

---

Deliverables

1. Implement custom toString() logic in PrintingResultHandler for Cookies.

Before

MockHttpServletResponse:
   ...
   Cookies = [javax.servlet.http.Cookie@25084a1e]

After

MockHttpServletResponse:
   ...
   Cookies = [[Cookie@47faa49c name = 'enigma', value = '42', comment = [null], domain = [null], maxAge = -1, path = [null], secure = false, version = 0, httpOnly = false]]

---

Affects: 3.2 GA

Issue Links:

• Spring MVC Test framework never stores more than one cookie [SPR-13166] #17757 Spring MVC Test framework never stores more than one cookie
• Improve documentation on limitations of Spring MVC Test [SPR-13169] #17760 Improve documentation on limitations of Spring MVC Test

Referenced from: commits 895d43a

[spring-projects-issues]

Sam Brannen commented

Completed in GitHub commit 895d43a:

Print cookies in human-readable form in Spring MVC Test

Prior to this commit, when rendering cookies via andDo(print()) in Spring MVC Test, the output for the MockHttpServletResponse would look something like the following:

Cookies = [javax.servlet.http.Cookie@25084a1e]

The reason is that the Cookie class in javax.servlet-api-3.0.1.jar does not implement toString(). Consequently, nothing about the cookie's name, value, etc., is displayed, thereby making the debug output for cookies next to useless.

This commit improves on this by implementing custom toString() logic for cookies in debug output in Spring MVC Test. For example, the output now looks like this:

Cookies = [[Cookie@47faa49c name = 'enigma', value = '42', comment = [null], domain = [null], maxAge = -1, path = [null], secure = false, version = 0, httpOnly = false]]

In addition, this commit fixes a minor bug for FlashMap debug output if the FlashMap is empty.