BAEL-5524: Mock HttpServletRequest + tests (#12242)

* BAEL-5524: Mock HttpServletRequest + tests

* BAEL-5524: Fixed JUnit tests + dependency

* BAEL-5524: Updated test parameters

javax-servlets-2/pom.xml

@@ -39,6 +39,18 @@
             <artifactId>jstl</artifactId>
             <version>${jstl.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.jmockit</groupId>
+            <artifactId>jmockit</artifactId>
+            <version>${jmockit.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-test</artifactId>
+            <version>${spring-test.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
@@ -53,9 +65,26 @@
         </dependency>
     </dependencies>
 
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-surefire-plugin</artifactId>
+				<version>${maven-surefire-plugin.version}</version>
+				<configuration>
+					<argLine>
+          			  -javaagent:"${settings.localRepository}"/org/jmockit/jmockit/${jmockit.version}/jmockit-${jmockit.version}.jar
+         			</argLine>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
     <properties>
         <org.apache.httpcomponents.version>4.5.13</org.apache.httpcomponents.version>
         <javax.servlet-api.version>4.0.1</javax.servlet-api.version>
+        <jmockit.version>1.49</jmockit.version>
+        <spring-test.version>5.3.20</spring-test.version>
+        <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
     </properties>
 
 </project>

javax-servlets-2/src/main/java/com/baeldung/servlets/UserServlet.java

@@ -0,0 +1,24 @@
+package com.baeldung.servlets;
+
+import java.io.IOException;
+
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+@WebServlet(name = "UserServlet", urlPatterns = "/user")
+public class UserServlet extends HttpServlet {
+
+    private static final long serialVersionUID = 2923732283720972121L;
+
+    @Override
+    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
+        String firstName = request.getParameter("firstName");
+        String lastName = request.getParameter("lastName");
+
+        response.getWriter()
+            .append("Full Name: " + firstName + " " + lastName);
+    }
+
+}

javax-servlets-2/src/test/java/com/baeldung/servlets/TestUtil.java

@@ -0,0 +1,678 @@
+package com.baeldung.servlets;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.io.UnsupportedEncodingException;
+import java.security.Principal;
+import java.util.Collection;
+import java.util.Enumeration;
+import java.util.Locale;
+import java.util.Map;
+
+import javax.servlet.AsyncContext;
+import javax.servlet.DispatcherType;
+import javax.servlet.RequestDispatcher;
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletInputStream;
+import javax.servlet.ServletOutputStream;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+import javax.servlet.http.HttpUpgradeHandler;
+import javax.servlet.http.Part;
+
+public class TestUtil {
+
+    public static HttpServletRequest getRequest(Map<String, String[]> params) {
+        return new HttpServletRequest() {
+
+            @Override
+            public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws IllegalStateException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public AsyncContext startAsync() throws IllegalStateException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public void setCharacterEncoding(String env) throws UnsupportedEncodingException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setAttribute(String name, Object o) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void removeAttribute(String name) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public boolean isSecure() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isAsyncSupported() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isAsyncStarted() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public ServletContext getServletContext() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public int getServerPort() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public String getServerName() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getScheme() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public RequestDispatcher getRequestDispatcher(String path) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public int getRemotePort() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public String getRemoteHost() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getRemoteAddr() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getRealPath(String path) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public BufferedReader getReader() throws IOException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getProtocol() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String[] getParameterValues(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Enumeration<String> getParameterNames() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Map<String, String[]> getParameterMap() {
+                return params;
+            }
+
+            @Override
+            public String getParameter(String name) {
+                String[] values = params.get(name);
+                if (values == null || values.length == 0)
+                    return null;
+                return values[0];
+            }
+
+            @Override
+            public Enumeration<Locale> getLocales() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Locale getLocale() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public int getLocalPort() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public String getLocalName() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getLocalAddr() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public ServletInputStream getInputStream() throws IOException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public DispatcherType getDispatcherType() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getContentType() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public long getContentLengthLong() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public int getContentLength() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public String getCharacterEncoding() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Enumeration<String> getAttributeNames() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Object getAttribute(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public AsyncContext getAsyncContext() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public void logout() throws ServletException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void login(String username, String password) throws ServletException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public boolean isUserInRole(String role) {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isRequestedSessionIdValid() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isRequestedSessionIdFromUrl() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isRequestedSessionIdFromURL() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public boolean isRequestedSessionIdFromCookie() {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public Principal getUserPrincipal() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public HttpSession getSession(boolean create) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public HttpSession getSession() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getServletPath() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getRequestedSessionId() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public StringBuffer getRequestURL() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getRequestURI() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getRemoteUser() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getQueryString() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getPathTranslated() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getPathInfo() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Collection<Part> getParts() throws IOException, ServletException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Part getPart(String name) throws IOException, ServletException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getMethod() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public int getIntHeader(String name) {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public Enumeration<String> getHeaders(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Enumeration<String> getHeaderNames() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getHeader(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public long getDateHeader(String name) {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public Cookie[] getCookies() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getContextPath() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getAuthType() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String changeSessionId() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public boolean authenticate(HttpServletResponse response) throws IOException, ServletException {
+                // TODO Auto-generated method stub
+                return false;
+            }
+        };
+    }
+
+    public static HttpServletResponse getResponse(StringWriter writer) {
+
+        return new HttpServletResponse() {
+
+            @Override
+            public void setLocale(Locale loc) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setContentType(String type) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setContentLengthLong(long len) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setContentLength(int len) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setCharacterEncoding(String charset) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setBufferSize(int size) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void resetBuffer() {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void reset() {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public boolean isCommitted() {
+                return true;
+            }
+
+            @Override
+            public PrintWriter getWriter() throws IOException {
+                return new PrintWriter(writer, isCommitted());
+            }
+
+            @Override
+            public ServletOutputStream getOutputStream() throws IOException {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Locale getLocale() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getContentType() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getCharacterEncoding() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public int getBufferSize() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public void flushBuffer() throws IOException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setStatus(int sc, String sm) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setStatus(int sc) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setIntHeader(String name, int value) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setHeader(String name, String value) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void setDateHeader(String name, long date) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void sendRedirect(String location) throws IOException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void sendError(int sc, String msg) throws IOException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void sendError(int sc) throws IOException {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public int getStatus() {
+                // TODO Auto-generated method stub
+                return 0;
+            }
+
+            @Override
+            public Collection<String> getHeaders(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public Collection<String> getHeaderNames() {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String getHeader(String name) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String encodeUrl(String url) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String encodeURL(String url) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String encodeRedirectUrl(String url) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public String encodeRedirectURL(String url) {
+                // TODO Auto-generated method stub
+                return null;
+            }
+
+            @Override
+            public boolean containsHeader(String name) {
+                // TODO Auto-generated method stub
+                return false;
+            }
+
+            @Override
+            public void addIntHeader(String name, int value) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void addHeader(String name, String value) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void addDateHeader(String name, long date) {
+                // TODO Auto-generated method stub
+
+            }
+
+            @Override
+            public void addCookie(Cookie cookie) {
+                // TODO Auto-generated method stub
+
+            }
+        };
+
+    }
+}

javax-servlets-2/src/test/java/com/baeldung/servlets/UserServletUnitTest.java

@@ -0,0 +1,93 @@
+package com.baeldung.servlets;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.mock.web.MockHttpServletResponse;
+
+import mockit.Expectations;
+import mockit.Mocked;
+
+class UserServletUnitTest {
+
+    private UserServlet servlet;
+    private StringWriter writer;
+    
+    @Mocked
+    HttpServletRequest mockRequest;
+    @Mocked
+    HttpServletResponse mockResponse;
+
+    @BeforeEach
+    public void setUp() throws IOException {
+        servlet = new UserServlet();
+        writer = new StringWriter();
+    }
+
+    @Test
+    void givenHttpServletRequest_whenUsingAnonymousClass_thenReturnsParameterValues() throws IOException {
+        final Map<String, String[]> params = new HashMap<>();
+        params.put("firstName", new String[] { "Anonymous Class" });
+        params.put("lastName", new String[] { "Test" });
+
+        servlet.doGet(TestUtil.getRequest(params), TestUtil.getResponse(writer));
+
+        assertThat(writer.toString()).isEqualTo("Full Name: Anonymous Class Test");
+    }
+
+    @Test
+    void givenHttpServletRequest_whenMockedWithMockito_thenReturnsParameterValues() throws IOException {
+        // mock HttpServletRequest & HttpServletResponse
+        HttpServletRequest request = mock(HttpServletRequest.class);
+        HttpServletResponse response = mock(HttpServletResponse.class);
+
+        // mock the returned value of request.getParameterMap()
+        when(request.getParameter("firstName")).thenReturn("Mockito");
+        when(request.getParameter("lastName")).thenReturn("Test");
+        when(response.getWriter()).thenReturn(new PrintWriter(writer));
+
+        servlet.doGet(request, response);
+
+        assertThat(writer.toString()).isEqualTo("Full Name: Mockito Test");
+    }
+
+    @Test
+    void givenHttpServletRequest_whenMockedWithJMockit_thenReturnsParameterValues() throws IOException {
+        
+        new Expectations() {{
+            mockRequest.getParameter("firstName"); result = "JMockit";
+            mockRequest.getParameter("lastName"); result = "Test";
+            mockResponse.getWriter(); result = new PrintWriter(writer);
+         }};
+        
+        servlet.doGet(mockRequest, mockResponse);
+        
+        assertThat(writer.toString()).isEqualTo("Full Name: JMockit Test");
+    }
+
+    @Test
+    void givenHttpServletRequest_whenUsingMockHttpServletRequest_thenReturnsParameterValues() throws IOException {
+        MockHttpServletRequest request = new MockHttpServletRequest();
+        request.setParameter("firstName", "Spring");
+        request.setParameter("lastName", "Test");
+        MockHttpServletResponse response = new MockHttpServletResponse();
+
+        servlet.doGet(request, response);
+
+        assertThat(response.getContentAsString()).isEqualTo("Full Name: Spring Test");
+    }
+
+}