aboutsummaryrefslogtreecommitdiffstats
path: root/reference/logging-filter/logging-filter-spring
diff options
context:
space:
mode:
authorBrittany Plummer (bp896r) <bp896r@att.com>2019-08-27 15:36:44 -0400
committerKevin Smokowski <kevin.smokowski@att.com>2019-08-29 20:37:00 +0000
commit5104a66d12a2ada0819d1cbcaf935785748f2b87 (patch)
tree1a48cbc173ff46060bbcf679f83a75a23d194df9 /reference/logging-filter/logging-filter-spring
parented4107f4ff0aa1ad65a96371bf69242847daedaa (diff)
Add JAX-RS and Spring filters for setting up MDC
Issue-ID: LOG-1113 Change-Id: I7167943384e3983c7eced1c969ed51fcd8130c88 Signed-off-by: Brittany Plummer (bp896r) <bp896r@att.com>
Diffstat (limited to 'reference/logging-filter/logging-filter-spring')
-rw-r--r--reference/logging-filter/logging-filter-spring/pom.xml71
-rw-r--r--reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/LoggingInterceptor.java96
-rw-r--r--reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/MDCTaskDecorator.java43
-rw-r--r--reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/SpringClientFilter.java157
-rw-r--r--reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/LoggingInterceptorTest.java65
-rw-r--r--reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/SpringClientFilterTest.java166
6 files changed, 598 insertions, 0 deletions
diff --git a/reference/logging-filter/logging-filter-spring/pom.xml b/reference/logging-filter/logging-filter-spring/pom.xml
new file mode 100644
index 0000000..42f5fe8
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/pom.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.onap.logging-analytics</groupId>
+ <artifactId>logging-filter-parent</artifactId>
+ <version>1.5.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>logging-filter-spring</artifactId>
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-dependencies</artifactId>
+ <version>2.0.5.RELEASE</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-webmvc</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.logging-analytics</groupId>
+ <artifactId>logging-filter-base</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.logging-analytics</groupId>
+ <artifactId>logging-slf4j</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>javax.servlet-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>javax.ws.rs</groupId>
+ <artifactId>javax.ws.rs-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-slf4j-impl</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.glassfish.jersey.core</groupId>
+ <artifactId>jersey-client</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/LoggingInterceptor.java b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/LoggingInterceptor.java
new file mode 100644
index 0000000..d8d6bf4
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/LoggingInterceptor.java
@@ -0,0 +1,96 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.spring;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.stream.Collectors;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.ext.Providers;
+import org.onap.logging.filter.base.MDCSetup;
+import org.onap.logging.filter.base.SimpleMap;
+import org.onap.logging.filter.base.SimpleServletHeadersMap;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+import org.springframework.stereotype.Component;
+import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
+
+@Component
+public class LoggingInterceptor extends HandlerInterceptorAdapter {
+
+ private static final Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);
+
+ private MDCSetup mdcSetup = new MDCSetup();
+
+ @Context
+ private Providers providers;
+
+ @Override
+ public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
+ throws Exception {
+ SimpleMap headers = new SimpleServletHeadersMap(request);
+ String requestId = mdcSetup.getRequestId(headers);
+ MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
+ mdcSetup.setInvocationId(headers);
+ mdcSetup.setServiceName(request);
+ mdcSetup.setMDCPartnerName(headers);
+ mdcSetup.setClientIPAddress(request);
+ mdcSetup.setEntryTimeStamp();
+ mdcSetup.setInstanceID();
+ mdcSetup.setServerFQDN();
+ MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
+ mdcSetup.setLogTimestamp();
+ mdcSetup.setElapsedTime();
+ logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
+ if (logger.isDebugEnabled())
+ logRequestInformation(request);
+ return true;
+ }
+
+ protected void logRequestInformation(HttpServletRequest request) {
+ Map<String, String> headers = Collections.list((request).getHeaderNames()).stream()
+ .collect(Collectors.toMap(h -> h, request::getHeader));
+
+ logger.debug("===========================request begin================================================");
+ logger.debug("URI : {}", request.getRequestURI());
+ logger.debug("Method : {}", request.getMethod());
+ logger.debug("Headers : {}", headers);
+ logger.debug("==========================request end================================================");
+
+ }
+
+ @Override
+ public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
+ ModelAndView modelAndView) throws Exception {
+ mdcSetup.setResponseStatusCode(response.getStatus());
+ mdcSetup.setLogTimestamp();
+ mdcSetup.setElapsedTime();
+ mdcSetup.setResponseDescription(response.getStatus());
+ MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(response.getStatus()));
+ logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
+ MDC.clear();
+ }
+}
diff --git a/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/MDCTaskDecorator.java b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/MDCTaskDecorator.java
new file mode 100644
index 0000000..b641b5f
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/MDCTaskDecorator.java
@@ -0,0 +1,43 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.spring;
+
+import java.util.Map;
+import org.slf4j.MDC;
+import org.springframework.core.task.TaskDecorator;
+
+public class MDCTaskDecorator implements TaskDecorator {
+
+ @Override
+ public Runnable decorate(Runnable runnable) {
+ Map<String, String> contextMap = MDC.getCopyOfContextMap();
+ return () -> {
+ try {
+ if (contextMap != null) {
+ MDC.setContextMap(contextMap);
+ runnable.run();
+ }
+ } finally {
+ MDC.clear();
+ }
+ };
+ }
+}
diff --git a/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/SpringClientFilter.java b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/SpringClientFilter.java
new file mode 100644
index 0000000..6eeee1a
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/SpringClientFilter.java
@@ -0,0 +1,157 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.spring;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.List;
+import java.util.UUID;
+import org.onap.logging.filter.base.Constants;
+import org.onap.logging.filter.base.MDCSetup;
+import org.onap.logging.filter.base.PropertyUtil;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+import org.slf4j.Marker;
+import org.slf4j.MarkerFactory;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpRequest;
+import org.springframework.http.client.ClientHttpRequestExecution;
+import org.springframework.http.client.ClientHttpRequestInterceptor;
+import org.springframework.http.client.ClientHttpResponse;
+import org.springframework.util.StreamUtils;
+
+public class SpringClientFilter implements ClientHttpRequestInterceptor {
+ private final Logger logger = LoggerFactory.getLogger(this.getClass());
+ private static final String TRACE = "trace-#";
+ private MDCSetup mdcSetup = new MDCSetup();
+ private final String partnerName;
+ private static final Marker INVOKE_RETURN = MarkerFactory.getMarker("INVOKE-RETURN");
+
+ public SpringClientFilter() {
+ this.partnerName = getPartnerName();
+ }
+
+ @Override
+ public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
+ throws IOException {
+ processRequest(request, body);
+ ClientHttpResponse response = execution.execute(request, body);
+ processResponse(response);
+ return response;
+ }
+
+ protected void processRequest(HttpRequest request, byte[] body) throws IOException {
+ mdcSetup.setInvocationIdFromMDC();
+ setupMDC(request);
+ setupHeaders(request);
+ if (logger.isDebugEnabled()) {
+ logger.debug("===========================request begin================================================");
+ logger.debug("URI : {}", request.getURI());
+ logger.debug("Method : {}", request.getMethod());
+ logger.debug("Headers : {}", request.getHeaders());
+ logger.debug("Request body: {}", new String(body, StandardCharsets.UTF_8));
+ logger.debug("==========================request end================================================");
+ }
+ }
+
+ protected void setupHeaders(HttpRequest clientRequest) {
+ HttpHeaders headers = clientRequest.getHeaders();
+ String requestId = extractRequestID(clientRequest);
+ headers.add(ONAPLogConstants.Headers.REQUEST_ID, requestId);
+ headers.add(Constants.HttpHeaders.HEADER_REQUEST_ID, requestId);
+ headers.add(Constants.HttpHeaders.TRANSACTION_ID, requestId);
+ headers.add(Constants.HttpHeaders.ECOMP_REQUEST_ID, requestId);
+ headers.add(ONAPLogConstants.Headers.INVOCATION_ID, MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
+ headers.add(ONAPLogConstants.Headers.PARTNER_NAME, partnerName);
+ }
+
+ protected String extractRequestID(HttpRequest clientRequest) {
+ String requestId = MDC.get(ONAPLogConstants.MDCs.REQUEST_ID);
+ if (requestId == null || requestId.isEmpty() || requestId.equals(TRACE)) {
+ requestId = UUID.randomUUID().toString();
+ mdcSetup.setLogTimestamp();
+ mdcSetup.setElapsedTimeInvokeTimestamp();
+ logger.warn("Could not Find Request ID Generating New One: {}", clientRequest.getURI());
+ MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
+ }
+ return requestId;
+ }
+
+ protected void setupMDC(HttpRequest clientRequest) {
+ MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP,
+ ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
+ MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, clientRequest.getURI().toString());
+ MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
+ MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, extractTargetEntity(clientRequest));
+ if (MDC.get(ONAPLogConstants.MDCs.SERVICE_NAME) == null) {
+ MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, clientRequest.getURI().getPath());
+ }
+ mdcSetup.setServerFQDN();
+ }
+
+ protected String extractTargetEntity(HttpRequest clientRequest) {
+ HttpHeaders headers = clientRequest.getHeaders();
+ String headerTargetEntity = null;
+ List<String> headerTargetEntityList = headers.get(Constants.HttpHeaders.TARGET_ENTITY_HEADER);
+ if (headerTargetEntityList != null && !headerTargetEntityList.isEmpty())
+ headerTargetEntity = headerTargetEntityList.get(0);
+ String targetEntity = MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY);
+ if (targetEntity != null && !targetEntity.isEmpty()) {
+ return targetEntity;
+ } else if (headerTargetEntity != null && !headerTargetEntity.isEmpty()) {
+ targetEntity = headerTargetEntity;
+ } else {
+ targetEntity = Constants.DefaultValues.UNKNOWN_TARGET_ENTITY;
+ logger.warn("Could not Target Entity: {}", clientRequest.getURI());
+ }
+ return targetEntity;
+ }
+
+ protected void processResponse(ClientHttpResponse response) throws IOException {
+ if (logger.isDebugEnabled()) {
+ logger.debug("============================response begin==========================================");
+ logger.debug("Status code : {}", response.getStatusCode());
+ logger.debug("Status text : {}", response.getStatusText());
+ logger.debug("Headers : {}", response.getHeaders());
+ logger.debug("Response body: {}", StreamUtils.copyToString(response.getBody(), Charset.defaultCharset()));
+ logger.debug("=======================response end=================================================");
+ }
+ mdcSetup.setLogTimestamp();
+ mdcSetup.setElapsedTimeInvokeTimestamp();
+ mdcSetup.setResponseStatusCode(response.getRawStatusCode());
+ int statusCode = response.getRawStatusCode();
+ MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(statusCode));
+ mdcSetup.setResponseDescription(statusCode);
+ logger.info(INVOKE_RETURN, "InvokeReturn");
+ mdcSetup.clearClientMDCs();
+ }
+
+ protected String getPartnerName() {
+ PropertyUtil p = new PropertyUtil();
+ return p.getProperty(Constants.Property.PARTNER_NAME);
+ }
+}
diff --git a/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/LoggingInterceptorTest.java b/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/LoggingInterceptorTest.java
new file mode 100644
index 0000000..1a6d701
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/LoggingInterceptorTest.java
@@ -0,0 +1,65 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.spring;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Spy;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.onap.logging.filter.base.MDCSetup;
+import org.onap.logging.filter.base.SimpleMap;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.MDC;
+
+@RunWith(MockitoJUnitRunner.class)
+public class LoggingInterceptorTest {
+
+ @Mock
+ private HttpServletRequest request;
+
+ @Mock
+ private HttpServletResponse response;
+
+ @Mock
+ private Object handler;
+
+ @Mock
+ private MDCSetup mdcSetup;
+
+ @Spy
+ @InjectMocks
+ private LoggingInterceptor loggingInterceptor;
+
+ @Test
+ public void preHandleTest() throws Exception {
+ when(mdcSetup.getRequestId(any(SimpleMap.class))).thenReturn("428443e6-eeb2-4e4a-9a8c-2ca9e2bc8067");
+ loggingInterceptor.preHandle(request, response, handler);
+ assertEquals(MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE), "INPROGRESS");
+ assertEquals("428443e6-eeb2-4e4a-9a8c-2ca9e2bc8067", MDC.get(ONAPLogConstants.MDCs.REQUEST_ID));
+ }
+}
diff --git a/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/SpringClientFilterTest.java b/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/SpringClientFilterTest.java
new file mode 100644
index 0000000..9de5d68
--- /dev/null
+++ b/reference/logging-filter/logging-filter-spring/src/test/java/org/onap/logging/filter/spring/SpringClientFilterTest.java
@@ -0,0 +1,166 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.spring;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.when;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import org.junit.After;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Spy;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.onap.logging.filter.base.Constants;
+import org.onap.logging.filter.base.MDCSetup;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.MDC;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpRequest;
+import org.springframework.http.client.ClientHttpRequestExecution;
+import org.springframework.http.client.ClientHttpResponse;
+
+@RunWith(MockitoJUnitRunner.class)
+public class SpringClientFilterTest {
+
+ @Mock
+ private MDCSetup mdcSetup;
+
+ @Mock
+ private ClientHttpResponse response;
+
+ @Mock
+ private HttpRequest clientRequest;
+
+ @Mock
+ private ClientHttpRequestExecution execution;
+
+ @Spy
+ @InjectMocks
+ private SpringClientFilter springClientFilter;
+
+ @After
+ public void tearDown() {
+ MDC.clear();
+ }
+
+ @Test
+ public void processResponseTest() throws IOException {
+ String partnerName = springClientFilter.getPartnerName();
+
+ assertEquals("UNKNOWN", partnerName);
+ }
+
+ @Test
+ public void extractTargetEntityTest() {
+ HttpHeaders headers = new HttpHeaders();
+ headers.add(Constants.HttpHeaders.TARGET_ENTITY_HEADER, "SO");
+ when(clientRequest.getHeaders()).thenReturn(headers);
+
+ String targetEntity = springClientFilter.extractTargetEntity(clientRequest);
+ assertEquals("SO", targetEntity);
+ }
+
+ @Test
+ public void extractTargetEntityMDCTest() {
+ MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, "SO");
+ HttpHeaders headers = new HttpHeaders();
+ when(clientRequest.getHeaders()).thenReturn(headers);
+
+ String targetEntity = springClientFilter.extractTargetEntity(clientRequest);
+ assertEquals("SO", targetEntity);
+ }
+
+ @Test
+ public void extractTargetEntityNoHeaderTest() {
+ HttpHeaders headers = new HttpHeaders();
+ when(clientRequest.getHeaders()).thenReturn(headers);
+
+ String targetEntity = springClientFilter.extractTargetEntity(clientRequest);
+ assertEquals("Unknown-Target-Entity", targetEntity);
+ }
+
+ @Test
+ public void setupMDCTest() throws URISyntaxException {
+ doReturn("SO").when(springClientFilter).extractTargetEntity(clientRequest);
+ URI uri = new URI("onap/so/serviceInstances");
+ when(clientRequest.getURI()).thenReturn(uri);
+
+ springClientFilter.setupMDC(clientRequest);
+
+ assertEquals("onap/so/serviceInstances", MDC.get(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME));
+ assertEquals("SO", MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
+ assertEquals("INPROGRESS", MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
+ assertNotNull(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE);
+ assertNotNull(ONAPLogConstants.MDCs.SERVICE_NAME);
+ assertNotNull(ONAPLogConstants.MDCs.SERVER_FQDN);
+ }
+
+ @Test
+ public void setupHeadersTest() {
+ MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, "8819bfb4-69d2-43fc-b0d6-81d2690533ea");
+ HttpHeaders headers = new HttpHeaders();
+ when(clientRequest.getHeaders()).thenReturn(headers);
+ doReturn("0a908a5d-e774-4558-96ff-6edcbba65483").when(springClientFilter).extractRequestID(clientRequest);
+
+ springClientFilter.setupHeaders(clientRequest);
+
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", headers.getFirst(ONAPLogConstants.Headers.REQUEST_ID));
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", headers.getFirst(Constants.HttpHeaders.HEADER_REQUEST_ID));
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", headers.getFirst(Constants.HttpHeaders.TRANSACTION_ID));
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", headers.getFirst(Constants.HttpHeaders.TRANSACTION_ID));
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", headers.getFirst(Constants.HttpHeaders.ECOMP_REQUEST_ID));
+ assertEquals("8819bfb4-69d2-43fc-b0d6-81d2690533ea", headers.getFirst(ONAPLogConstants.Headers.INVOCATION_ID));
+ assertEquals("UNKNOWN", headers.getFirst(ONAPLogConstants.Headers.PARTNER_NAME));
+ }
+
+ @Test
+ public void extractRequestIDTest() {
+ MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, "0a908a5d-e774-4558-96ff-6edcbba65483");
+ String requestId = springClientFilter.extractRequestID(clientRequest);
+ assertEquals("0a908a5d-e774-4558-96ff-6edcbba65483", requestId);
+ }
+
+ @Test
+ public void extractRequestIDNullTest() {
+ String requestId = springClientFilter.extractRequestID(clientRequest);
+ assertNotNull(requestId);
+ assertNotNull(ONAPLogConstants.MDCs.LOG_TIMESTAMP);
+ assertNotNull(ONAPLogConstants.MDCs.ELAPSED_TIME);
+ }
+
+ @Test
+ public void interceptTest() throws IOException {
+ byte[] body = new byte[3];
+ doNothing().when(springClientFilter).processRequest(clientRequest, body);
+ doReturn(response).when(execution).execute(clientRequest, body);
+ doNothing().when(springClientFilter).processResponse(response);
+
+ ClientHttpResponse httpResponse = springClientFilter.intercept(clientRequest, body, execution);
+ assertEquals(response, httpResponse);
+ }
+}