Wednesday, February 9, 2011

Unit Testing JSP Custom Tag Using Spring

In order to unit test your JSP tag, you need to mock up ServletContext and PageContext.  This would be a difficult task without the help from 3rd party library.  Spring 2.5 provides a mock up liberary bundled in spring-test-2.5.x.jar.  This greatly speed up the construction of the test code.

Now I'm going to show an example on testing a custom tag using Spring test library:

Assuming we have a custom tag as below:

public class DataInquiryTag extends TagSupport {

 private String name;  // attribute parameter name
 private String size;  // HTML element size 
 
 @Override
 public int doStartTag() throws JspException {
  String msg = "Hello "+name+"";
  pageContext.getOut().write(msg);
  return super.doStartTag();
 } 
}

We test our tag using JUnit 4.
Before every test invocation, we need to mock ServletContext and PageContext. To do that we setup @Before method as below:

@Before
 public void setup(){
  // mock ServletContext
  mockServletContext = new MockServletContext();
  // mock PageContext
  mockPageContext = new MockPageContext(mockServletContext);  
  tag = new MyTag();
  tag.setPageContext(mockPageContext);  
 }
The @Before method will use spring mock library to mock ServletContext and PageContext. The is good enough for simple pojo tag that does not rely on any application context.
What if out tag is depending on application context? An example would be a class referenced in the test implements InitializingBean interface. The use of the class is to load properties and initialize values. This requires spring context to be loaded.
To load Spring Application Context, such as WebApplicationContext, we need to add following lines in @Before method:

String configLocations = "/WEB-INF/applicationContext.xml,/WEB-INF/applicationContext-mock.xml";
 mockServletContext.addInitParameter(ContextLoader.CONFIG_LOCATION_PARAM, configLocations);
 ContextLoader loader = new ContextLoader();  
 loader.initWebApplicationContext(mockServletContext);
We first set the location of applicationContext file. Note that we add a applicationContext-mock.xml file to override beans defined in default context. This is handy because some beans may require external resource such as data source in order to be loaded correctly. We can override these beans to local pojo bean for the sake of unit testing.

Usually, application context is common to all tests so we only need to load spring context once before executing all tests. We can do so by adding these lines in @BeforeClass method. So our final setup looks like below:

@BeforeClass
 public static void init(){
  // mock ServletContext
  mockServletContext = new MockServletContext();
  //Add the following lines if your test depends on spring context to be loaded
  //For example, you have a referenced class that implements   
  org.springframework.beans.factory.InitializingBean interface
  String configLocations = "/WEB-INF/applicationContext.xml,/WEB-INF/applicationContext-mock.xml";
  mockServletContext.addInitParameter(ContextLoader.CONFIG_LOCATION_PARAM, configLocations);
  ContextLoader loader = new ContextLoader();  
  loader.initWebApplicationContext(mockServletContext);
 }
 
 @Before
 public void setup(){
  // mock PageContext
  mockPageContext = new MockPageContext(mockServletContext);  
  tag = new MyTag();
  tag.setPageContext(mockPageContext);  
 }
The test setup as above to load application context at the beginning of all test run. Then every test will create its own PageContext to hold the request and response as well as a new tag instance.

After setting up the test environment, it's time to write our test:
@Test
 public void testDoStartTag() throws Exception{  
 try{
  tag.setName("John");
  tag.doStartTag();
  String output = ((MockHttpServletResponse)mockPageContext.getResponse()).getContentAsString(); 
  assert("Hello John
".equals(output)); }catch(JspException je){ assert(false); } }
The output string contains the actual http response (e.g. generated html code) of the tag when calling doStartTag method. So you can right specific assertion logic against the output of the tag.


The complete test class source is shown below:

public class TestDataInquiryTag {  
 @BeforeClass
 public static void init(){
  // mock ServletContext
  mockServletContext = new MockServletContext();
  //Add the following lines if your test depends on spring context to be loaded
  //For example, you have a referenced class that implements 
  //org.springframework.beans.factory.InitializingBean interface
  String configLocations = "/WEB-INF/applicationContext.xml,/WEB-INF/applicationContext-mock.xml";
  mockServletContext.addInitParameter(ContextLoader.CONFIG_LOCATION_PARAM, configLocations);
  ContextLoader loader = new ContextLoader();  
  loader.initWebApplicationContext(mockServletContext);
 }
 
 @Before
 public void setup(){
  // mock PageContext
  mockPageContext = new MockPageContext(mockServletContext);  
  tag = new MyTag();
  tag.setPageContext(mockPageContext);  
 }

 @Test
 public void testDoStartTag() throws Exception{  
  try{
   tag.setName("John");
   tag.doStartTag();
   String output = ((MockHttpServletResponse)mockPageContext.getResponse()).getContentAsString(); 
   assert("Hello John
".equals(output)); }catch(JspException je){ assert(false); } } }

23 comments :

  1. Hi, I am trying to do the same but I get an UnsupportedOperationException (Spring 3.0.5) when trying to get the JspWriter throuth getOut().

    I checked the source code and there is nothing implemented in that method. It just throws an UnsupportedOperationException.

    I checked the API and it says:
    "Does not support writing to a JspWriter, request dispatching, and handlePageException calls."
    http://static.springsource.org/spring/docs/2.5.x/api/org/springframework/mock/web/MockPageContext.html

    How is it possible it works for you?

    ReplyDelete
    Replies
    1. Machine Learning Projects for Final Year machine learning projects for final year

      Deep Learning Projects assist final year students with improving your applied Deep Learning skills rapidly while allowing you to investigate an intriguing point. Furthermore, you can include Deep Learning projects for final year into your portfolio, making it simpler to get a vocation, discover cool profession openings, and Deep Learning Projects for Final Year even arrange a more significant compensation.

      Python Training in Chennai Project Centers in Chennai

      Delete
  2. Hi alexcuesta,

    I'm using spring-2.5.6.jar and spring-test-2.5.6.SEC01.jar for my testing and it works fine. When I call getOut() method from y mocked PageContext instance, I abtained a MockedJspWriter object which writes http response properly.
    I have not tested the code in Spring 3.x so it could be compatibility issue. Since you are using Spring 3, you should use the org.springframework.test-3.x.jar included in spring 3 download package.

    ReplyDelete
  3. Informative post. Keep sharing such a useful post.

    ppc training in chennai

    ReplyDelete
  4. In your example ContextLoader is it from org.springframework.test.context or org.springframework.web.context

    ReplyDelete
  5. Your way to enlighten everything on this blog is actually pleasant, everyone manage to efficiently be familiar with it, Thanks a great deal.
    UX agency

    ReplyDelete
  6. The work did to validate our idea gave us the confidence how to start a website design company to stay the course and build our product

    ReplyDelete
  7. Their personalized service and knowledge of the market are appreciated and important for the company's digital channels' success
    best branding agency

    ReplyDelete
  8. They assigned project manager to streamline workflow, which has been really effective.
    media agencies in San Francisco

    ReplyDelete
  9. Ability to turn constructive feedback into high-quality best app designers, on-time deliverables are hallmarks of their work.

    ReplyDelete
  10. They delivered excellent design work for the client but had difficulty with other aspects of the project including quality assurance and delivering on schedule.
    brand companies

    ReplyDelete
  11. UX design
    The team was punctual and integrated feedback quickly to ensure efficient collaboration. They managed the project capably to support a partnership that exceeded expectations.

    ReplyDelete
  12. Thank you I am glad about the encouragement! I love your site, you post outstanding.
    UX design studios

    ReplyDelete
  13. Impressive web site, Distinguished feedback that I can tackle. Im moving forward and may apply to my current job as a pet sitter, which is very enjoyable, but I need to additional expand. Regards. check this site

    ReplyDelete
  14. You know your projects stand out of the herd. There is something special about them. It seems to me all of them are really brilliant! canada visum

    ReplyDelete
  15. This is such a great resource that you are providing and you give it away for free. I love seeing blog that understand the value of providing a quality resource for free. Indian vixaj neeg ncig tebchaws

    ReplyDelete
  16. You guys present there are performing an excellent job.
    logo designing agency

    ReplyDelete
  17. Thanks for taking the time to discuss this, I feel strongly about it and love learning more on this topic. If possible, as you gain expertise, would you mind updating your blog with extra information? It is extremely helpful for me. new zealand visa

    ReplyDelete
  18. Thanks meant for sharing this type of satisfying opinion, written piece is fastidious, that’s why I’ve read it completely.
    top web designers in the world

    ReplyDelete
  19. Hello, this is very useful material. This article is really inspiring me to do the same thing as you.. You can read online info about Turkey evisa.The Turkey e visa is an electronic visa that allows entry into Turkey.

    ReplyDelete
  20. This is my very first time that I am visiting here and I’m truly pleasurable to see everything at one place.
    experience design companies

    ReplyDelete