Merge pull request #19 from SAP/remoteIP

altenhof · web-flow · commit d9e0e012a6f1 · 2018-02-01T14:59:28.000+01:00
Version 2.1.2
diff --git a/README.md b/README.md
@@ -27,11 +27,11 @@ All in all, you should do the following:
 * adjust your logging configuration accordingly.
 
 
-Say, you want to make use of the *servlet filter* feature, then you need to add the following dependency to your POM with property `cf-logging-version` referring to the latest nexus version (currently `2.1.1`):
+Say, you want to make use of the *servlet filter* feature, then you need to add the following dependency to your POM with property `cf-logging-version` referring to the latest nexus version (currently `2.1.2`):
 
 ```xml
 <properties>
-	<cf-logging-version>2.1.1</cf-logging-version>
+	<cf-logging-version>2.1.2</cf-logging-version>
 </properties>
 ```
 
diff --git a/cf-java-logging-support-core/pom.xml b/cf-java-logging-support-core/pom.xml
@@ -32,7 +32,7 @@
     <parent>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
     <build>
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultMessageConverter.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultMessageConverter.java
@@ -48,7 +48,10 @@ public void convert(String message, StringBuilder appendTo) {
             } else {
                 appendTo.append(result);
             }
+        } else {
+            appendTo.append("null");
         }
+
     }
 
     private String flattenMsg(String msg) {
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/helper/Environment.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/helper/Environment.java
@@ -0,0 +1,10 @@
+package com.sap.hcp.cf.logging.common.helper;
+
+public class Environment {
+
+    public static final String LOG_REMOTE_IP = "LOG_REMOTE_IP";
+
+    public String getVariable(String name) {
+        return System.getenv(name);
+    }
+}
diff --git a/cf-java-logging-support-core/src/test/java/com/sap/hcp/cf/logging/common/converter/TestJsonMessageConverter.java b/cf-java-logging-support-core/src/test/java/com/sap/hcp/cf/logging/common/converter/TestJsonMessageConverter.java
@@ -114,4 +114,11 @@ public void testObjNestedBrackets() {
         assertThat(formatMsg(jmc, logMsg), is(nestedBracketsMsg));
     }
 
+    @Test
+    public void testNullMessage() {
+        String logMsg = null;
+        DefaultMessageConverter jmc = new DefaultMessageConverter();
+        assertThat(formatMsg(jmc, logMsg), is("null"));
+    }
+
 }
diff --git a/cf-java-logging-support-jersey/pom.xml b/cf-java-logging-support-jersey/pom.xml
@@ -9,7 +9,7 @@
         <relativePath>../pom.xml</relativePath>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
     </parent>
 
     <name>cf-java-logging-support-jersey</name>
diff --git a/cf-java-logging-support-log4j2/pom.xml b/cf-java-logging-support-log4j2/pom.xml
@@ -11,7 +11,7 @@
         <relativePath>../pom.xml</relativePath>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
     </parent>
 
     <dependencies>
diff --git a/cf-java-logging-support-logback/pom.xml b/cf-java-logging-support-logback/pom.xml
@@ -10,7 +10,7 @@
         <relativePath>../pom.xml</relativePath>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
     </parent>
 
     <dependencies>
diff --git a/cf-java-logging-support-servlet/pom.xml b/cf-java-logging-support-servlet/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -47,7 +47,7 @@
         <dependency>
             <groupId>com.auth0</groupId>
             <artifactId>java-jwt</artifactId>
-            <version>3.2.0</version>
+            <version>3.3.0</version>
         </dependency>
     </dependencies>
 </project>
diff --git a/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/DynLogEnvironment.java b/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/DynLogEnvironment.java
@@ -8,6 +8,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.sap.hcp.cf.logging.common.helper.Environment;
+
 public class DynLogEnvironment {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(DynLogEnvironment.class);
diff --git a/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/Environment.java b/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/Environment.java
diff --git a/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/PublicKeyReader.java b/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/dynlog/PublicKeyReader.java
@@ -12,6 +12,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.sap.hcp.cf.logging.common.helper.Environment;
+
 public class PublicKeyReader {
 
     private final static Logger LOGGER = LoggerFactory.getLogger(PublicKeyReader.class);
@@ -22,7 +24,7 @@ public RSAPublicKey readPublicKey(Environment environment) throws IOException, N
         String pemKey = environment.getVariable("DYN_LOG_LEVEL_KEY");
 
         if (pemKey == null) {
-            LOGGER.error("DYN_LOG_LEVEL_KEY not found in environment");
+            LOGGER.info("DYN_LOG_LEVEL_KEY not found in environment");
             return null;
         } else {
             pemKey = pemKey.replace("-----BEGIN PUBLIC KEY-----", "");
diff --git a/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/filter/LogRemoteIPSettings.java b/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/filter/LogRemoteIPSettings.java
@@ -0,0 +1,44 @@
+package com.sap.hcp.cf.logging.servlet.filter;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.sap.hcp.cf.logging.common.helper.Environment;
+
+public class LogRemoteIPSettings {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(LogRemoteIPSettings.class);
+
+    private final boolean logRemoteIPSetting;
+
+    public LogRemoteIPSettings() {
+        this(new Environment());
+    }
+
+    LogRemoteIPSettings(Environment environment) {
+        String tempLogRemoteIP = environment.getVariable(Environment.LOG_REMOTE_IP);
+
+        if (tempLogRemoteIP != null) {
+            if (tempLogRemoteIP.equals("true") || tempLogRemoteIP.equals("True") || tempLogRemoteIP.equals("TRUE")) {
+                logRemoteIPSetting = true;
+                LOGGER.info("Logging remote IPs has been ACTIVATED via environment variable");
+            } else if (tempLogRemoteIP.equals("false") || tempLogRemoteIP.equals("False") || tempLogRemoteIP.equals(
+                                                                                                                    "FALSE")) {
+                logRemoteIPSetting = false;
+                LOGGER.info("Logging remote IPs has been DEACTIVATED via environment variable");
+            } else {
+                LOGGER.error("Logging remote IPs is DEACTIVATED by default. Environment variable \"LogRemoteIP = {}\" could not " +
+                             "be read. It should be set to true to activate Logging of remote IPs or to false to deactivate it",
+                             tempLogRemoteIP);
+                logRemoteIPSetting = false;
+            }
+        } else {
+            logRemoteIPSetting = false;
+            LOGGER.info("Logging remote IPs is DEACTIVATED by default.");
+        }
+    }
+
+    public boolean getLogRemoteIPSetting() {
+        return logRemoteIPSetting;
+    }
+}
diff --git a/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/filter/RequestLoggingFilter.java b/cf-java-logging-support-servlet/src/main/java/com/sap/hcp/cf/logging/servlet/filter/RequestLoggingFilter.java
@@ -40,8 +40,10 @@ public class RequestLoggingFilter implements Filter {
     private boolean wrapRequest = true;
     private DynLogEnvironment dynLogEnvironment;
     private DynamicLogLevelProcessor dynamicLogLevelProcessor;
+    protected LogRemoteIPSettings logRemoteIPSettings;
 
     public RequestLoggingFilter() {
+        logRemoteIPSettings = new LogRemoteIPSettings();
         dynLogEnvironment = new DynLogEnvironment();
         if (dynLogEnvironment.getRsaPublicKey() != null) {
             dynamicLogLevelProcessor = new DynamicLogLevelProcessor(dynLogEnvironment);
@@ -168,9 +170,11 @@ private void addHeaders(HttpServletRequest request, RequestRecord lrec) {
                                                                      : request.getRequestURI());
         lrec.addTag(Fields.METHOD, request.getMethod());
         lrec.addTag(Fields.PROTOCOL, getValue(request.getProtocol()));
-        lrec.addTag(Fields.REMOTE_IP, getValue(request.getRemoteAddr()));
-        lrec.addTag(Fields.REMOTE_HOST, getValue(request.getRemoteHost()));
-        lrec.addTag(Fields.REMOTE_PORT, Integer.toString(request.getRemotePort()));
+        if (logRemoteIPSettings.getLogRemoteIPSetting()) {
+            lrec.addTag(Fields.REMOTE_IP, getValue(request.getRemoteAddr()));
+            lrec.addTag(Fields.REMOTE_HOST, getValue(request.getRemoteHost()));
+            lrec.addTag(Fields.REMOTE_PORT, Integer.toString(request.getRemotePort()));
+        }
         lrec.addTag(Fields.REMOTE_USER, getValue(request.getRemoteUser()));
         lrec.addTag(Fields.REFERER, getHeader(request, HttpHeaders.REFERER));
         lrec.addTag(Fields.X_FORWARDED_FOR, getHeader(request, HttpHeaders.X_FORWARDED_FOR));
diff --git a/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/dynlog/DynamicLogLevelProcessorTest.java b/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/dynlog/DynamicLogLevelProcessorTest.java
@@ -21,6 +21,7 @@
 import org.slf4j.MDC;
 
 import com.sap.hcp.cf.logging.common.helper.DynamicLogLevelHelper;
+import com.sap.hcp.cf.logging.common.helper.Environment;
 
 @RunWith(MockitoJUnitRunner.class)
 public class DynamicLogLevelProcessorTest extends Mockito {
diff --git a/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/filter/LogRemoteIPSettingsTest.java b/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/filter/LogRemoteIPSettingsTest.java
@@ -0,0 +1,68 @@
+package com.sap.hcp.cf.logging.servlet.filter;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.junit.Test;
+
+import com.sap.hcp.cf.logging.common.helper.Environment;
+
+public class LogRemoteIPSettingsTest {
+
+    @Test
+    public void testLogRemoteIPSettingsTrue() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("true");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), true);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsTrueWithCapitalT() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("True");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), true);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsTRUE() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("TRUE");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), true);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsFalse() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("false");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), false);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsFalseWithCapitalF() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("False");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), false);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsFALSE() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("FALSE");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), false);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsInvalidEnvVariable() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn("someInvalidString");
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), false);
+    }
+
+    @Test
+    public void testLogRemoteIPSettingsEmptyEnvVariable() {
+        Environment mockEnvironment = mock(Environment.class);
+        when(mockEnvironment.getVariable(Environment.LOG_REMOTE_IP)).thenReturn(null);
+        assertEquals(new LogRemoteIPSettings(mockEnvironment).getLogRemoteIPSetting(), false);
+    }
+}
diff --git a/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/filter/RequestLoggingFilterTest.java b/cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/filter/RequestLoggingFilterTest.java
@@ -136,6 +136,8 @@ public void doFilter(ServletRequest request, ServletResponse response) throws IO
 
     @Test
     public void testWithSettings() throws IOException, ServletException {
+        LogRemoteIPSettings mockLogRemoteIPSettings = mock(LogRemoteIPSettings.class);
+        when(mockLogRemoteIPSettings.getLogRemoteIPSetting()).thenReturn(true);
         HttpServletRequest mockReq = mock(HttpServletRequest.class);
         HttpServletResponse mockResp = mock(HttpServletResponse.class);
         PrintWriter mockWriter = mock(PrintWriter.class);
@@ -147,7 +149,9 @@ public void testWithSettings() throws IOException, ServletException {
         when(mockReq.getHeader(HttpHeaders.X_VCAP_REQUEST_ID)).thenReturn(REQUEST_ID);
         when(mockReq.getHeader(HttpHeaders.REFERER)).thenReturn(REFERER);
         FilterChain mockFilterChain = mock(FilterChain.class);
-        new RequestLoggingFilter().doFilter(mockReq, mockResp, mockFilterChain);
+        RequestLoggingFilter requestLoggingFilter = new RequestLoggingFilter();
+        requestLoggingFilter.logRemoteIPSettings = mockLogRemoteIPSettings;
+        requestLoggingFilter.doFilter(mockReq, mockResp, mockFilterChain);
         assertThat(getField(Fields.REQUEST), is(FULL_REQUEST));
         assertThat(getField(Fields.CORRELATION_ID), is(REQUEST_ID));
         assertThat(getField(Fields.REQUEST_ID), is(REQUEST_ID));
@@ -157,6 +161,33 @@ public void testWithSettings() throws IOException, ServletException {
         assertThat(getField(Fields.REFERER), is(REFERER));
     }
 
+    @Test
+    public void testWithSettingsWithoutRemoteIP() throws IOException, ServletException {
+        LogRemoteIPSettings mockLogRemoteIPSettings = mock(LogRemoteIPSettings.class);
+        when(mockLogRemoteIPSettings.getLogRemoteIPSetting()).thenReturn(false);
+        HttpServletRequest mockReq = mock(HttpServletRequest.class);
+        HttpServletResponse mockResp = mock(HttpServletResponse.class);
+        PrintWriter mockWriter = mock(PrintWriter.class);
+        when(mockResp.getWriter()).thenReturn(mockWriter);
+        when(mockReq.getRequestURI()).thenReturn(REQUEST);
+        when(mockReq.getQueryString()).thenReturn(QUERY_STRING);
+        when(mockReq.getRemoteHost()).thenReturn(REMOTE_HOST);
+        // will also set correlation id
+        when(mockReq.getHeader(HttpHeaders.X_VCAP_REQUEST_ID)).thenReturn(REQUEST_ID);
+        when(mockReq.getHeader(HttpHeaders.REFERER)).thenReturn(REFERER);
+        FilterChain mockFilterChain = mock(FilterChain.class);
+        RequestLoggingFilter requestLoggingFilter = new RequestLoggingFilter();
+        requestLoggingFilter.logRemoteIPSettings = mockLogRemoteIPSettings;
+        requestLoggingFilter.doFilter(mockReq, mockResp, mockFilterChain);
+        assertThat(getField(Fields.REQUEST), is(FULL_REQUEST));
+        assertThat(getField(Fields.CORRELATION_ID), is(REQUEST_ID));
+        assertThat(getField(Fields.REQUEST_ID), is(REQUEST_ID));
+        assertThat(getField(Fields.REMOTE_HOST), is(Defaults.UNKNOWN));
+        assertThat(getField(Fields.COMPONENT_ID), is(Defaults.UNKNOWN));
+        assertThat(getField(Fields.CONTAINER_ID), is(Defaults.UNKNOWN));
+        assertThat(getField(Fields.REFERER), is(REFERER));
+    }
+
     @Test
     public void testExplicitCorrelationId() throws IOException, ServletException {
         HttpServletRequest mockReq = mock(HttpServletRequest.class);
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>com.sap.hcp.cf.logging</groupId>
     <artifactId>cf-java-logging-support-parent</artifactId>
-    <version>2.1.1</version>
+    <version>2.1.2</version>
     <packaging>pom</packaging>
 
     <name>Cloud Foundry Java logging support components</name>
diff --git a/sample/manifest.yml b/sample/manifest.yml
@@ -6,6 +6,8 @@ applications:
 - name: logging-sample-app
   host: logging-sample-app
   instances: 1
-  path: target/logging-sample-app-2.1.1.war
+  path: target/logging-sample-app-2.1.2.war
   env:
     RANDOM_SLEEP: true
+# Set LOG_REMOTE_IP: true to activate logging of remote IPs
+    LOG_REMOTE_IP: false
diff --git a/sample/pom.xml b/sample/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.sap.hcp.cf.logging</groupId>
         <artifactId>cf-java-logging-support-parent</artifactId>
-        <version>2.1.1</version>
+        <version>2.1.2</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -18,7 +18,7 @@
         <slf4j.version>1.7.12</slf4j.version>
         <jersey.version>2.22.2</jersey.version>
         <javax.ws.version>2.0.1</javax.ws.version>
-        <cf-logging.version>2.1.1</cf-logging.version>
+        <cf-logging.version>2.1.2</cf-logging.version>
     </properties>
     <dependencies>
         <dependency>

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,10 @@ public void convert(String message, StringBuilder appendTo) {`
`48`	`48`	`} else {`
`49`	`49`	`appendTo.append(result);`
`50`	`50`	`}`
	`51`	`+ } else {`
	`52`	`+ appendTo.append("null");`
`51`	`53`	`}`
	`54`	`+`
`52`	`55`	`}`
`53`	`56`
`54`	`57`	`private String flattenMsg(String msg) {`
Original file line number	Diff line number	Diff line change
`@@ -114,4 +114,11 @@ public void testObjNestedBrackets() {`
`114`	`114`	`assertThat(formatMsg(jmc, logMsg), is(nestedBracketsMsg));`
`115`	`115`	`}`
`116`	`116`
	`117`	`+ @Test`
	`118`	`+ public void testNullMessage() {`
	`119`	`+ String logMsg = null;`
	`120`	`+ DefaultMessageConverter jmc = new DefaultMessageConverter();`
	`121`	`+ assertThat(formatMsg(jmc, logMsg), is("null"));`
	`122`	`+ }`
	`123`	`+`
`117`	`124`	`}`