Creating a mock HttpServletRequest out of a url string?

I have a service that does some work on an HttpServletRequest object, specifically using the request.getParameterMap and request.getParameter to construct an object.

I was wondering if there is a straightforward way to take a provided url, in the form of a string, say

String url = "http://www.example.com/?param1=value1&param";

and easily convert it to a HttpServletRequest object so that I can test it with my unit tests? Or at least just so that request.getParameterMap and request.getParameter work correctly?

Here it is how to use MockHttpServletRequest:

// given
MockHttpServletRequest request = new MockHttpServletRequest();
request.setServerName("www.example.com");
request.setRequestURI("/foo");
request.setQueryString("param1=value1&param");

// when
String url = request.getRequestURL() + '?' + request.getQueryString(); // assuming there is always queryString.

// then
assertThat(url, is("http://www.example.com:80/foo?param1=value1&param"));

Spring has MockHttpServletRequest in its spring-test module.

If you are using maven you may need to add the appropriate dependency to your pom.xml. You can find spring-test at mvnrepository.com.

Simplest ways to mock an HttpServletRequest:

1. Create an anonymous subclass:

   HttpServletRequest mock = new HttpServletRequest ()
   {
       private final Map<String, String[]> params = /* whatever */
   
       public Map<String, String[]> getParameterMap()
       {
           return params;
       }
   
       public String getParameter(String name)
       {
           String[] matches = params.get(name);
           if (matches == null || matches.length == 0) return null;
           return matches[0];
       }
   
       // TODO *many* methods to implement here
   };
   

2. Use jMock, Mockito, or some other general-purpose mocking framework:

   HttpServletRequest mock = context.mock(HttpServletRequest.class); // jMock
   HttpServletRequest mock2 = Mockito.mock(HttpServletRequest.class); // Mockito
   

3. Use HttpUnit's ServletUnit and don't mock the request at all.