Add sap-passport HTTP Header Support

Author: KarstenSchnitter

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/HttpHeaders.java

@@ -12,67 +12,72 @@
 import com.sap.hcp.cf.logging.common.LogContext;
 
 public enum HttpHeaders implements HttpHeader {
-
-	CONTENT_LENGTH("content-length"), CONTENT_TYPE("content-type"), REFERER("referer"), X_FORWARDED_FOR(
-			"x-forwarded-for"), X_VCAP_REQUEST_ID("x-vcap-request-id", Fields.REQUEST_ID, true), CORRELATION_ID("X-CorrelationID",
-					Fields.CORRELATION_ID, true, X_VCAP_REQUEST_ID), TENANT_ID("tenantid", Fields.TENANT_ID, true);
-
-	private HttpHeaders(String name) {
-		this(name, null, false);
-	}
-
-	private HttpHeaders(String name, String field, boolean isPropagated, HttpHeaders... aliases) {
-		this.name = name;
-		this.field = field;
-		this.isPropagated = isPropagated;
-		this.aliases = unmodifiableList(asList(aliases));
-	}
-
-	private String name;
-	private String field;
-	private boolean isPropagated;
-	private List<HttpHeader> aliases;
-
-	@Override
-	public boolean isPropagated() {
-		return isPropagated;
-	}
-
-	@Override
-	public String getName() {
-		return name;
-	}
-
-	@Override
-	public String getField() {
-		return field;
-	}
-
-	@Override
-	public String getFieldValue() {
-		return field != null ? LogContext.get(field) : Defaults.UNKNOWN;
-	}
-
-	@Override
-	public List<HttpHeader> getAliases() {
-		return aliases;
-	}
-
-	public static List<HttpHeaders> propagated() {
-		return LazyPropagatedHeaderHolder.PROPAGATED;
-	}
-
-	private static class LazyPropagatedHeaderHolder {
-		public static final List<HttpHeaders> PROPAGATED = createPropagated();
-
-		private static List<HttpHeaders> createPropagated() {
-			List<HttpHeaders> propagated = new ArrayList<>();
-			for (HttpHeaders current : values()) {
-				if (current.isPropagated()) {
-					propagated.add(current);
-				}
-			}
-			return Collections.unmodifiableList(propagated);
-		}
-	}
+                                               CONTENT_LENGTH("content-length"), //
+                                               CONTENT_TYPE("content-type"), //
+                                               REFERER("referer"), //
+                                               X_FORWARDED_FOR("x-forwarded-for"), //
+                                               X_VCAP_REQUEST_ID("x-vcap-request-id", Fields.REQUEST_ID, true), //
+                                               CORRELATION_ID("X-CorrelationID", Fields.CORRELATION_ID, true,
+                                                              X_VCAP_REQUEST_ID), //
+                                               SAP_PASSPORT("sap-passport", Fields.SAP_PASSPORT, true), //
+                                               TENANT_ID("tenantid", Fields.TENANT_ID, true); //
+
+    private HttpHeaders(String name) {
+        this(name, null, false);
+    }
+
+    private HttpHeaders(String name, String field, boolean isPropagated, HttpHeaders... aliases) {
+        this.name = name;
+        this.field = field;
+        this.isPropagated = isPropagated;
+        this.aliases = unmodifiableList(asList(aliases));
+    }
+
+    private String name;
+    private String field;
+    private boolean isPropagated;
+    private List<HttpHeader> aliases;
+
+    @Override
+    public boolean isPropagated() {
+        return isPropagated;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public String getField() {
+        return field;
+    }
+
+    @Override
+    public String getFieldValue() {
+        return field != null ? LogContext.get(field) : Defaults.UNKNOWN;
+    }
+
+    @Override
+    public List<HttpHeader> getAliases() {
+        return aliases;
+    }
+
+    public static List<HttpHeaders> propagated() {
+        return LazyPropagatedHeaderHolder.PROPAGATED;
+    }
+
+    private static class LazyPropagatedHeaderHolder {
+        public static final List<HttpHeaders> PROPAGATED = createPropagated();
+
+        private static List<HttpHeaders> createPropagated() {
+            List<HttpHeaders> propagated = new ArrayList<>();
+            for (HttpHeaders current: values()) {
+                if (current.isPropagated()) {
+                    propagated.add(current);
+                }
+            }
+            return Collections.unmodifiableList(propagated);
+        }
+    }
 }

cf-java-logging-support-core/src/test/java/com/sap/hcp/cf/logging/common/request/HttpHeadersTest.java

@@ -24,7 +24,7 @@ public void resetLogContext() {
 
     @Test
     public void hasCorrectNumberOfTypes() throws Exception {
-        assertThat(HttpHeaders.values().length, is(equalTo(7)));
+        assertThat(HttpHeaders.values().length, is(equalTo(8)));
     }
 
     @Test
@@ -78,7 +78,8 @@ public void hasCorrectAliases() throws Exception {
 
     @Test
     public void propagatesCorrectHeaders() throws Exception {
-        assertThat(HttpHeaders.propagated(), containsInAnyOrder(HttpHeaders.CORRELATION_ID, HttpHeaders.TENANT_ID, HttpHeaders.X_VCAP_REQUEST_ID));
+        assertThat(HttpHeaders.propagated(), containsInAnyOrder(HttpHeaders.CORRELATION_ID, HttpHeaders.SAP_PASSPORT,
+                                                                HttpHeaders.TENANT_ID, HttpHeaders.X_VCAP_REQUEST_ID));
     }
 
 }

cf-java-logging-support-servlet/src/test/java/com/sap/hcp/cf/logging/servlet/filter/RequestLogTest.java

@@ -135,6 +135,18 @@ public void logsTenantIdFromRequestHeader() throws Exception {
 		}
 	}
 
+    @Test
+    public void logsSapPassportFromRequestHeader() throws Exception {
+        String passport =
+                        "2a54482a0300e60000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a54482a";
+        HttpGet get = createRequestWithHeader(HttpHeaders.SAP_PASSPORT.getName(), passport);
+        try (CloseableHttpResponse response = client.execute(get)) {
+            assertThat("Application log without passport.", getRequestMessage(), hasEntry(Fields.SAP_PASSPORT,
+                                                                                           passport));
+            assertThat("Request log without passport.", getRequestLog(), hasEntry(Fields.SAP_PASSPORT, passport));
+        }
+    }
+
 	@Test
 	public void writesCorrelationIdFromHeadersAsResponseHeader() throws Exception {
 		String correlationId = UUID.randomUUID().toString();