gregw

Sunday Dec 17, 2006

Unit Test Servlets with Jetty

This rainy weekend, I was inspired by a question from hani about testing servlets. As a result I've added a module to Jetty to simply test servlets with an embedded server configured by the ServletTester class. The HTTP requests and responses for testing can be generated and parsed with the HttpTest class.

An example of a test harness that uses these classes is ServletTest.

Setting up the tester

The ServletTester can configure a single context. Servlets and Filters may be added to the context by class name or class instance. Context attributes, a resource base or a classloader may optionally be set. eg.

ServletTester tester=new ServletTester();
tester.setContextPath("/context");
tester.addServlet("come.acme.TestFilter", "/*");
tester.addServlet(TestServlet.class, "/servlet/*");
tester.addServlet(HelloServlet.class, "/hello");
tester.addServlet("org.mortbay.jetty.servlet.DefaultServlet", "/");
tester.start();

Raw HTTP requests and responses.

The ServletTester takes a string containing requests and returns a string containing the corresponding responses (eventually byte arrays will be supported for testing character encoding and binary content). More than one request can be pipelined and multiple responses will be returned if persistent connection conditions are met. eg.

String requests=
   "GET /context/servlet/info?query=foo HTTP/1.1\r\n"+
   "Host: tester\r\n"+
   "\r\n"+         
   "GET /context/hello HTTP/1.1\r\n"+
   "Host: tester\r\n"+
   "\r\n";
            
String responses = tester.getResponses(requests);
        
String expected=
   "HTTP/1.1 200 OK\r\n"+
   "Content-Type: text/html; charset=iso-8859-1\r\n"+
   "Content-Length: 21\r\n"+
   "\r\n"+
   "<h1>Test Servlet</h1>" +
         
   "HTTP/1.1 200 OK\r\n"+
   "Content-Type: text/html; charset=iso-8859-1\r\n"+
   "Content-Length: 22\r\n"+
   "\r\n"+
   "<h1>Hello Servlet</h1>";
            
assertEquals(expected,responses);

Generated Requests, Parsed Responses

Dealing with raw HTTP can be a bit verbose and difficult to test non protocol aspects. The HttpTest class allows for simple generation of requests and parsing of response (it can also parse requests and generate responses). eg.

HttpTester request = new HttpTester();
HttpTester response = new HttpTester();
request.setMethod("GET");
request.setHeader("Host","tester");
request.setURI("/context/hello/info");
request.setVersion("HTTP/1.0");

response.parse(tester.getResponses(request.generate()));

assertTrue(response.getMethod()==null);
assertEquals(200,response.getStatus());
assertEquals("<h1>Hello Servlet</h1>",response.getContent());

Once setup, the HttpTester instances may be reused and only the parts that change need to be set for subsequent requests. eg.

request.setURI("/context");
response.parse(tester.getResponses(request.generate()));
assertEquals(302,response.getStatus());
assertEquals("http://tester/context/",response.getHeader("location"));

Requirements

This will be in the 6.1.0 release and is currently in 6.1-SNAPSHOT. To use these classes you need the jars for servlet-api, jetty-util, jetty, jetty-servlet-tester.

Comments:

It's nice to be able to test a servlet but how do you set the servletConfig for the servlet under test?

Posted by Anonymous on June 02, 2007 at 07:39 PM EST #

I am trying to find out the same thing. How to set the ServletConfig/init-params programattically in Jetty. Anyone solved this one?

Posted by Eamonn on December 20, 2007 at 03:36 AM EST #

I have servlets which use session data to determine their output and behaviour.  Is there any way to set this up using ServletTester?

Posted by Anonymous on March 05, 2008 at 08:18 AM EST #

If you want to set init parameters for your tests you have to use the ServletHandler class:
ServletTester tester = new ServletTester();
tester.setContextPath("/context");
ServletHandler sh = tester.addServlet("ch.primecommerce.SomeServlet", "/*");
sh.setInitParameter("name", "value");
tester.start();
See: http://www.mortbay.org/apidocs/org/mortbay/jetty/servlet/Holder.html#setInitParameter(java.lang.String,%20java.lang.String)

Posted by Stephen on October 07, 2009 at 09:09 AM EST #

Post a Comment:
  • HTML Syntax: Allowed

Webtide

Calendar

Tags

Search

Links

Navigation