How to Mock a javax.servlet.ServletInputStream

Question

I am creating some unit testing and trying to Mock out some calls. Here is what I have in my working code:

String soapRequest = (SimUtil.readInputStream(request.getInputStream())).toString();
if (soapRequest.equals("My String")) { ... }

and SimUtil.readInputSteam looks like this:

StringBuffer sb = new StringBuffer();
BufferedReader reader = null;
try  {
    reader = new BufferedReader(new InputStreamReader(inputStream));
    final int buffSize = 1024;
    char[] buf = new char[buffSize];
    int numRead = 0;
    while ((numRead = reader.read(buf)) != -1) {
        String readData = String.valueOf(buf, 0, numRead);
        sb.append(readData);
        buf = new char[buffSize];
    }
} catch (IOException e) {
    LOG.error(e.getMessage(), e);
} finally {
    try {
        if (reader != null) {
            reader.close();
        }
    } catch (IOException e) {
        LOG.error(e.getMessage(), e);
    }
}

What I am trying to do is the request.getInputStream(), the stream returns certain String.

HttpServletRequest request = mock(HttpServletRequest.class);
ServletInputStream inputStream = mock(ServletInputStream.class);
when(request.getInputStream()).thenReturn(inputStream);

So This is the code I want to condition

when(inputStream.read()).thenReturn("My String".toInt());

Any Help would be greatly appreciated.

I would replace `SimUtil.readInputSteam` by [`CharStreams.html#toString(java.lang.Readable)`](http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/io/CharStreams.html#toString(java.lang.Readable)) and let the guava team take care of the testing. — , Jan 08 '14 at 13:03

Luciano · Accepted Answer · 2014-01-08T13:35:06.077

20

Don't mock the InputStream. Instead, transform the String to an array of bytes using the getBytes() method. Then create a ByteArrayInputStream with the array as input, so that it returns the String when consumed, each byte at a time. Next, create a ServletInputStream that wraps a regular InputStream like the one from Spring:

public class DelegatingServletInputStream extends ServletInputStream {

    private final InputStream sourceStream;


    /**
     * Create a DelegatingServletInputStream for the given source stream.
     * @param sourceStream the source stream (never <code>null</code>)
     */
    public DelegatingServletInputStream(InputStream sourceStream) {
        Assert.notNull(sourceStream, "Source InputStream must not be null");
        this.sourceStream = sourceStream;
    }

    /**
     * Return the underlying source stream (never <code>null</code>).
     */
    public final InputStream getSourceStream() {
        return this.sourceStream;
    }


    public int read() throws IOException {
        return this.sourceStream.read();
    }

    public void close() throws IOException {
        super.close();
        this.sourceStream.close();
    }

}

and finally, the HttpServletRequest mock would return this DelegatingServletInputStream object.

edited Jan 08 '14 at 13:35

answered Jan 08 '14 at 12:59

Luciano

8,552
5
32
56

2

There is also a `MockHttpServletRequest` in spring-test if I remember well – Jan 08 '14 at 13:05
Thank you Luciano, this works well. I was going down the path of ByteArrayInputStream already but couldn't cast it to servletInputStream, and it just didn't occurred to me to wrap it the way you did. @RC yes there is a MockHttpServletRequest, but in the example above I wanted to have as less package dependency as possible because thats not my question so I kept it to using Mockito only. – Churk Jan 08 '14 at 13:19
3

If you're using spring-test, the DelegatingServletInputStream class is already available from the framework (org.springframework.mock.web.DelegatingServletInputStream). – RMorrisey Sep 03 '14 at 19:21
Nice... i have pinched your work and cited it in my code :) – Nick Weedon Dec 31 '15 at 01:21
1

Most elegant solution with mockito framework IMHO is http://blog.timmattison.com/archives/2014/12/16/mockito-and-servletinputstreams/ - Thanks Tim Mattison! – dev_doctor Dec 20 '17 at 10:38

How to Mock a javax.servlet.ServletInputStream

1 Answers1