unit test for getClientAddress

K0zka · K0zka · commit fa52ffad6511 · 2014-11-23T19:48:57.000+01:00
Signed-off-by: Laszlo Hornyak &lt;laszlo.hornyak@gmail.com&gt;
diff --git a/server/src/com/cloud/api/ApiServlet.java b/server/src/com/cloud/api/ApiServlet.java
@@ -309,7 +309,7 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
     }
 
     //This method will try to get login IP of user even if servlet is behind reverseProxy or loadBalancer
-    private String getClientAddress(HttpServletRequest request) {
+    static String getClientAddress(HttpServletRequest request) {
         String ip = null;
         ip = request.getHeader("X-Forwarded-For");
         ip = getCorrectIPAddress(ip);
@@ -339,7 +339,7 @@ private String getClientAddress(HttpServletRequest request) {
         return ip;
     }
 
-    private String getCorrectIPAddress(String ip) {
+    private static String getCorrectIPAddress(String ip) {
         if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
             return null;
         }
diff --git a/server/test/com/cloud/api/ApiServletTest.java b/server/test/com/cloud/api/ApiServletTest.java
@@ -19,10 +19,12 @@
 import org.apache.cloudstack.api.auth.APIAuthenticationManager;
 import org.apache.cloudstack.api.auth.APIAuthenticationType;
 import org.apache.cloudstack.api.auth.APIAuthenticator;
+
 import com.cloud.server.ManagementServer;
 import com.cloud.user.Account;
 import com.cloud.user.AccountService;
 import com.cloud.user.User;
+
 import org.apache.cloudstack.api.ApiConstants;
 import org.junit.After;
 import org.junit.Assert;
@@ -36,6 +38,7 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpSession;
+
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.StringWriter;
@@ -81,6 +84,7 @@ public class ApiServletTest {
 
     ApiServlet servlet;
 
+    @SuppressWarnings("unchecked")
     @Before
     public void setup() throws SecurityException, NoSuchFieldException,
             IllegalArgumentException, IllegalAccessException, IOException {
@@ -192,6 +196,7 @@ public void processRequestInContextAuthorizedGet() {
                 Mockito.any(StringBuilder.class));
     }
 
+    @SuppressWarnings("unchecked")
     @Test
     public void processRequestInContextLogout() {
         Mockito.when(request.getMethod()).thenReturn("GET");
@@ -234,4 +239,35 @@ public void processRequestInContextLogin() {
         Mockito.verify(authenticator).authenticate(Mockito.anyString(), Mockito.anyMap(), Mockito.isA(HttpSession.class),
                 Mockito.anyString(), Mockito.anyString(), Mockito.isA(StringBuilder.class), Mockito.isA(HttpServletResponse.class));
     }
+
+    @Test
+    public void getClientAddressWithXForwardedFor() {
+        Mockito.when(request.getHeader(Mockito.eq("X-Forwarded-For"))).thenReturn("192.168.1.1");
+        Assert.assertEquals("192.168.1.1", ApiServlet.getClientAddress(request));
+    }
+
+    @Test
+    public void getClientAddressWithHttpXForwardedFor() {
+        Mockito.when(request.getHeader(Mockito.eq("HTTP_X_FORWARDED_FOR"))).thenReturn("192.168.1.1");
+        Assert.assertEquals("192.168.1.1", ApiServlet.getClientAddress(request));
+    }
+
+    @Test
+    public void getClientAddressWithXRemoteAddr() {
+        Mockito.when(request.getHeader(Mockito.eq("Remote_Addr"))).thenReturn("192.168.1.1");
+        Assert.assertEquals("192.168.1.1", ApiServlet.getClientAddress(request));
+    }
+
+    @Test
+    public void getClientAddressWithHttpClientIp() {
+        Mockito.when(request.getHeader(Mockito.eq("HTTP_CLIENT_IP"))).thenReturn("192.168.1.1");
+        Assert.assertEquals("192.168.1.1", ApiServlet.getClientAddress(request));
+    }
+
+    @Test
+    public void getClientAddressDefault() {
+        Mockito.when(request.getRemoteAddr()).thenReturn("127.0.0.1");
+        Assert.assertEquals("127.0.0.1", ApiServlet.getClientAddress(request));
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -309,7 +309,7 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp`
`309`	`309`	`}`
`310`	`310`
`311`	`311`	`//This method will try to get login IP of user even if servlet is behind reverseProxy or loadBalancer`
`312`		`- private String getClientAddress(HttpServletRequest request) {`
	`312`	`+ static String getClientAddress(HttpServletRequest request) {`
`313`	`313`	`String ip = null;`
`314`	`314`	`ip = request.getHeader("X-Forwarded-For");`
`315`	`315`	`ip = getCorrectIPAddress(ip);`
`@@ -339,7 +339,7 @@ private String getClientAddress(HttpServletRequest request) {`
`339`	`339`	`return ip;`
`340`	`340`	`}`
`341`	`341`
`342`		`- private String getCorrectIPAddress(String ip) {`
	`342`	`+ private static String getCorrectIPAddress(String ip) {`
`343`	`343`	`if(ip == null \|\| ip.length() == 0 \|\| "unknown".equalsIgnoreCase(ip)) {`
`344`	`344`	`return null;`
`345`	`345`	`}`