Client Logging

Update Client Logging to use interceptor
Move CXF to own project due to dependency hell

Issue-ID: SO-947

Change-Id: I2597ff6d32231b8625b04ef63ab5e8f589e2545c
Signed-off-by: Smokowski, Steve (ss835w) <ss835w@us.att.com>

2 files changed, 40 insertions, 409 deletions

diff --git a/common/src/test/java/org/onap/so/adapter_utils/tests/MsoLoggerTest.java b/common/src/test/java/org/onap/so/adapter_utils/tests/MsoLoggerTest.java
deleted file mode 100644
index 29ac91c864..0000000000
--- a/common/src/test/java/org/onap/so/adapter_utils/tests/MsoLoggerTest.java
+++ /dev/null
@@ -1,331 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP - SO
- * ================================================================================
- * Copyright (C) 2017 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.so.adapter_utils.tests;
-
-import org.onap.so.entity.MsoRequest;
-import org.onap.so.logger.MessageEnum;
-import org.onap.so.logger.MsoLogger;
-import org.onap.so.logger.MsoLogger.ErrorCode;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.BeforeClass;
-import org.junit.Ignore;
-import org.junit.Test;
-import org.slf4j.MDC;
-
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.PrintWriter;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.net.URL;
-import java.nio.charset.Charset;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.List;
-
-/**
- * This class implements all test methods of the MsoLogger features.
- *
- *
- */
-public class MsoLoggerTest {
-
-	static MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.GENERAL, MsoLoggerTest.class);
-
-	/**
-	 * This method is called before any test occurs. It creates a fake tree from
-	 * scratch
-	 */
-	@BeforeClass
-	public static final void prepare() {
-
-	}
-
-	@Before
-	public final void cleanErrorLogFile() throws FileNotFoundException {
-		URL url = this.getClass().getClassLoader().getResource("logback-test.xml");
-		String logFile = url.getFile().substring(0, url.getFile().indexOf("test-classes"))
-				+ "/MSO/Test/errorjboss.server.name_IS_UNDEFINED.log";
-		PrintWriter asdcConfigFileWriter = new PrintWriter(logFile);
-		asdcConfigFileWriter.print("");
-		asdcConfigFileWriter.flush();
-		asdcConfigFileWriter.close();
-	}
-
-	@Before
-	public final void cleanMetricLogFile() throws FileNotFoundException {
-		URL url = this.getClass().getClassLoader().getResource("logback-test.xml");
-		String logFile = url.getFile().substring(0, url.getFile().indexOf("test-classes"))
-				+ "/MSO/Test/metricsjboss.server.name_IS_UNDEFINED.log";
-		PrintWriter asdcConfigFileWriter = new PrintWriter(logFile);
-		asdcConfigFileWriter.print("");
-		asdcConfigFileWriter.flush();
-		asdcConfigFileWriter.close();
-	}
-
-	@Before
-	public final void cleanAuditLogFile() throws FileNotFoundException {
-		URL url = this.getClass().getClassLoader().getResource("logback-test.xml");
-		String logFile = url.getFile().substring(0, url.getFile().indexOf("test-classes"))
-				+ "/MSO/Test/auditjbo.server.name_IS_UNDEFINED.log";
-		PrintWriter asdcConfigFileWriter = new PrintWriter(logFile);
-		asdcConfigFileWriter.print("");
-		asdcConfigFileWriter.flush();
-		asdcConfigFileWriter.close();
-	}
-
-	/**
-	 * This method implements a test of getSeverifyLevel method.
-	 */
-	@Test
-	public final void testGetSeverityLevel() {
-
-		try {
-			String levelInfo = (String) invokePriveMethod("getSeverityLevel", "INFO");
-			Assert.assertEquals(levelInfo, "0");
-
-			String levelWarn = (String) invokePriveMethod("getSeverityLevel", "WARN");
-			Assert.assertEquals(levelWarn, "1");
-
-			String levelERROR = (String) invokePriveMethod("getSeverityLevel", "ERROR");
-			Assert.assertEquals(levelERROR, "2");
-
-			String levelDEBUG = (String) invokePriveMethod("getSeverityLevel", "DEBUG");
-			Assert.assertEquals(levelDEBUG, "0");
-
-			String levelFATAL = (String) invokePriveMethod("getSeverityLevel", "FATAL");
-			Assert.assertEquals(levelFATAL, "3");
-		} catch (Exception e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-	}
-
-	/**
-	 * This method implements a test of getFinalServiceName method.
-	 */
-	@Test
-	public final void testGetFinalServiceName() {
-		try {
-			String serviceName1 = (String) invokePriveMethod("getFinalServiceName", "testServiceName1");
-			Assert.assertEquals(serviceName1, "testServiceName1");
-
-			MsoLogger.setServiceName("testServiceName2");
-			String serviceName2 = (String) invokePriveMethod("getFinalServiceName", "testServiceName1");
-			Assert.assertEquals(serviceName2, "testServiceName1");
-
-			String msgNull = null;
-			String serviceName3 = (String) invokePriveMethod("getFinalServiceName", msgNull);
-			Assert.assertEquals(serviceName3, "testServiceName2");
-
-			MsoLogger.resetServiceName();
-			String serviceName4 = (String) invokePriveMethod("getFinalServiceName", msgNull);
-			Assert.assertEquals(serviceName4, "invoke0");
-		} catch (Exception e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-	}
-
-	@Test
-	public final void testPrepareMsg() {
-		try {
-			String msgNull = null;
-			MDC.clear();
-			invokePrepareMsg("INFO", null, null);
-
-			Assert.assertTrue(MDC.get(MsoLogger.REQUEST_ID).equals("trace-#")
-					&& MDC.get(MsoLogger.SERVICE_INSTANCE_ID).equals("trace-#")
-					&& MDC.get(MsoLogger.SERVICE_NAME).equals("invoke0") && MDC.get(MsoLogger.TIMER) == null
-					&& MDC.get(MsoLogger.ALERT_SEVERITY).equals("0"));
-
-			MsoLogger.setLoggerParameters("testRemoteIp", "testUser");
-			MsoLogger.setLogContext("testReqId", "testSvcId");
-			invokePrepareMsg("ERROR", "testServiceName3", null);
-			Assert.assertTrue(MDC.get(MsoLogger.REQUEST_ID).equals("testReqId")
-					&& MDC.get(MsoLogger.SERVICE_INSTANCE_ID).equals("testSvcId")
-					&& MDC.get(MsoLogger.SERVICE_NAME).equals("testServiceName3") && MDC.get(MsoLogger.TIMER) == null
-					&& MDC.get(MsoLogger.ALERT_SEVERITY).equals("2"));
-
-			MsoLogger.setServiceName("testServiceName2");
-			invokePrepareMsg("WARN", msgNull, msgNull);
-			Assert.assertTrue(MDC.get(MsoLogger.REQUEST_ID).equals("testReqId")
-					&& MDC.get(MsoLogger.SERVICE_INSTANCE_ID).equals("testSvcId")
-					&& MDC.get(MsoLogger.SERVICE_NAME).equals("testServiceName2") && MDC.get(MsoLogger.TIMER) == null
-					&& MDC.get(MsoLogger.ALERT_SEVERITY).equals("1"));
-
-			MDC.clear();
-			MsoRequest msoRequest = new MsoRequest();
-			msoRequest.setRequestId("reqId2");
-			msoRequest.setServiceInstanceId("servId2");
-			MsoLogger.setLogContext(msoRequest);
-			invokePrepareMsg("FATAL", null, "123");
-			Assert.assertTrue(MDC.get(MsoLogger.REQUEST_ID).equals("reqId2")
-					&& MDC.get(MsoLogger.SERVICE_INSTANCE_ID).equals("servId2")
-					&& MDC.get(MsoLogger.TIMER).equals("123") && MDC.get(MsoLogger.ALERT_SEVERITY).equals("3"));
-
-		} catch (Exception e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-	}
-
-	/**
-	 * This method implements a test of log methods
-	 */
-	@Test
-	@Ignore
-	public final void testLogMethods() {
-		try {
-			MDC.clear();
-			MsoLogger.setLogContext("reqId2", "servId2");
-			MsoLogger.setServiceName("MSO.testServiceName");
-			msoLogger.info(MessageEnum.LOGGER_UPDATE_SUC, "testLogger", "INFO", "DEBUG", "target entity",
-					"target service");
-			msoLogger.warn(MessageEnum.GENERAL_WARNING, "warning test", "", "", MsoLogger.ErrorCode.UnknownError,
-					"warning test");
-			msoLogger.error(MessageEnum.GENERAL_EXCEPTION, "target entity", "target service",
-					MsoLogger.ErrorCode.UnknownError, "error test");
-
-			// Fetch from the error log
-			URL url = this.getClass().getClassLoader().getResource("logback-test.xml");
-			String logFile = url.getFile().substring(0, url.getFile().indexOf("test-classes"))
-					+ "/MSO/Test/errorjboss.server.name_IS_UNDEFINED.log";
-
-			Path filePath = new File(logFile).toPath();
-			Charset charset = Charset.defaultCharset();
-			List<String> stringList = Files.readAllLines(filePath, charset);
-			String[] stringArray = stringList.toArray(new String[] {});
-			int size = stringArray.length;
-
-			Assert.assertTrue(stringArray[size - 3]
-					.contains("|reqId2|main|MSO.testServiceName||target entity|target service|INFO|null||")
-					&& stringArray[size - 3].contains(
-							"||MSO-GENERAL-5408I Successfully update Logger: testLogger from level INFO to level DEBUG"));
-			Assert.assertTrue(stringArray[size - 2]
-					.contains("|reqId2|main|MSO.testServiceName||||WARN|UnknownError|warning test|")
-					&& stringArray[size - 2].contains("|MSO-GENERAL-5401W WARNING: warning test"));
-			Assert.assertTrue(stringArray[size - 1].contains(
-					"|reqId2|main|MSO.testServiceName||target entity|target service|ERROR|UnknownError|error test|")
-					&& stringArray[size - 1].contains("|MSO-GENERAL-9401E Exception encountered"));
-
-		} catch (Exception e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-	}
-
-	/**
-	 * This method implements a test of recordMetricEvent method.
-	 * 
-	 * @throws IOException
-	 */
-	@Test
-	@Ignore
-	public final void testRecordMetricEvent() throws IOException {
-		MDC.clear();
-		MsoLogger.setLogContext("reqId", "servId");
-		msoLogger.recordMetricEvent(123456789L, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, "Successful",
-				"VNF", "createVNF", null);
-		MDC.put(MsoLogger.REMOTE_HOST, "127.0.0.1");
-		MDC.put(MsoLogger.PARTNERNAME, "testUser");
-		msoLogger.recordMetricEvent(123456789L, MsoLogger.StatusCode.ERROR, MsoLogger.ResponseCode.ServiceNotAvailable,
-				"Exception", "SDNC", "removeSDNC", "testVNF");
-
-		// Fetch from the metric log
-		URL url = this.getClass().getClassLoader().getResource("logback-test.xml");
-		String logFile = url.getFile().substring(0, url.getFile().indexOf("test-classes"))
-				+ "/MSO/Test/metricsjboss.server.name_IS_UNDEFINED.log";
-
-		Path filePath = new File(logFile).toPath();
-		Charset charset = Charset.defaultCharset();
-		List<String> stringList = Files.readAllLines(filePath, charset);
-		String[] stringArray = stringList.toArray(new String[] {});
-		msoLogger.error(MessageEnum.GENERAL_EXCEPTION, "", "", MsoLogger.ErrorCode.UnknownError, "test error msg");
-
-		Assert.assertTrue(stringArray[0]
-				.contains("|reqId|servId|main||testRecordMetricEvent||VNF|createVNF|COMPLETE|0|Successful|"));
-		// count the occurance of symbol "|"
-		Assert.assertTrue((stringArray[0].length() - stringArray[0].replace("|", "").length()) == 28);
-		Assert.assertTrue(stringArray[1]
-				.contains("|reqId|servId|main||testRecordMetricEvent|testUser|SDNC|removeSDNC|ERROR|501|Exception|")
-				&& stringArray[1].contains("|127.0.0.1||||testVNF|||||"));
-		Assert.assertTrue((stringArray[1].length() - stringArray[1].replace("|", "").length()) == 28);
-	}
-
-	/**
-	 * This method implements a test of testRecordAuditEvent method.
-	 */
-
-	// User reflection to invoke to avoid change the publicity of the method
-	private static String invokePrepareMsg(String arg1, String arg2, String arg3) {
-		Method method;
-		try {
-			method = MsoLogger.class.getDeclaredMethod("prepareMsg", String.class, String.class, String.class);
-			method.setAccessible(true);
-			return (String) method.invoke(msoLogger, arg1, arg2, arg3);
-		} catch (NoSuchMethodException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (SecurityException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (IllegalAccessException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (IllegalArgumentException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (InvocationTargetException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-		return null;
-	}
-
-	// User reflection to invoke to avoid change the publicity of the method
-	private static Object invokePriveMethod(String methodName, String arg) {
-		Method method;
-		try {
-			method = MsoLogger.class.getDeclaredMethod(methodName, String.class);
-			method.setAccessible(true);
-			return method.invoke(msoLogger, arg);
-		} catch (NoSuchMethodException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (SecurityException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (IllegalAccessException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (IllegalArgumentException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		} catch (InvocationTargetException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-		}
-		return null;
-	}
-}
diff --git a/common/src/test/java/org/onap/so/client/grm/GRMClientTest.java b/common/src/test/java/org/onap/so/client/grm/GRMClientTest.java
index 3cce6a626b..7b783762fa 100644
--- a/common/src/test/java/org/onap/so/client/grm/GRMClientTest.java
+++ b/common/src/test/java/org/onap/so/client/grm/GRMClientTest.java
@@ -24,9 +24,11 @@ import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.post;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+import static com.github.tomakehurst.wiremock.client.WireMock.*;
+
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
-
+import static org.junit.Assert.fail;
 import java.io.File;
 import java.nio.file.Files;
 import java.util.ArrayList;
@@ -43,6 +45,7 @@ import org.junit.Ignore;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
 import org.onap.so.client.grm.beans.OperationalInfo;
 import org.onap.so.client.grm.beans.Property;
 import org.onap.so.client.grm.beans.ServiceEndPoint;
@@ -54,8 +57,7 @@ import org.onap.so.client.grm.exceptions.GRMClientCallFailed;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.github.tomakehurst.wiremock.junit.WireMockRule;
-import org.onap.so.logger.MsoLogger;
-import org.onap.so.logger.MsoLogger.Catalog;
+
 import org.onap.so.utils.TestAppender;
 
 public class GRMClientTest {
@@ -66,6 +68,8 @@ public class GRMClientTest {
 	@Rule
 	public ExpectedException thrown = ExpectedException.none();
 	
+	private static final String uuidRegex = "(?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-5][0-9a-f]{3}-?[089ab][0-9a-f]{3}-?[0-9a-f]{12}$";
+	
 	@BeforeClass
 	public static void setUp() throws Exception {
 		System.setProperty("mso.config.path", "src/test/resources");
@@ -81,25 +85,45 @@ public class GRMClientTest {
 			.willReturn(aResponse()
 				.withStatus(200)
 				.withHeader("Content-Type", MediaType.APPLICATION_JSON)
-				.withHeader("X-FromAppId", "GRM")
 				.withBody(endpoints)));
 
-		MDC.put(MsoLogger.SERVICE_NAME, "my-value");
+		MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, "/test");
 		GRMClient client = new GRMClient();
 		ServiceEndPointList sel = client.findRunningServices("TEST.ECOMP_PSL.*", 1, "TEST");
 		List<ServiceEndPoint> list = sel.getServiceEndPointList();
 		assertEquals(3, list.size());
-        ILoggingEvent logEvent = TestAppender.events.get(0);
-        Map<String,String> mdc = logEvent.getMDCPropertyMap();
-        assertNotNull(mdc.get(MsoLogger.METRIC_BEGIN_TIME));
-         assertNotNull(mdc.get(MsoLogger.METRIC_END_TIME));
-        assertNotNull(mdc.get(MsoLogger.REQUEST_ID));
-        assertNotNull(mdc.get(MsoLogger.METRIC_TIMER));
-        assertEquals("200",mdc.get(MsoLogger.RESPONSECODE));
-        assertEquals("GRM",mdc.get(MsoLogger.PARTNERNAME));
-        assertEquals("expect value to not be overwritten by jax rs client interceptor", "my-value",mdc.get(MsoLogger.SERVICE_NAME));
-        assertEquals("COMPLETE",mdc.get(MsoLogger.STATUSCODE));
-        assertNotNull(mdc.get(MsoLogger.RESPONSEDESC));
+		
+		boolean foundInvoke = false;
+		boolean foundInvokeReturn = false;
+        for(ILoggingEvent logEvent : TestAppender.events)
+            if(logEvent.getLoggerName().equals("org.onap.so.logging.jaxrs.filter.JaxRsClientLogging") &&
+                    logEvent.getMarker().getName().equals("INVOKE")
+                    ){
+                Map<String,String> mdc = logEvent.getMDCPropertyMap();
+                assertNotNull(mdc.get(ONAPLogConstants.MDCs.INVOCATION_ID));
+                assertEquals("GRM",mdc.get("TargetEntity"));
+                assertEquals("INPROGRESS",mdc.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
+                foundInvoke=true;
+            }else if(logEvent.getLoggerName().equals("org.onap.so.logging.jaxrs.filter.JaxRsClientLogging") &&
+                    logEvent.getMarker()!= null && logEvent.getMarker().getName().equals("INVOKE_RETURN")){
+                Map<String,String> mdc = logEvent.getMDCPropertyMap();
+                assertNotNull(mdc.get(ONAPLogConstants.MDCs.INVOCATION_ID));
+                assertEquals("200",mdc.get(ONAPLogConstants.MDCs.RESPONSE_CODE));
+                assertEquals("COMPLETED",mdc.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
+                foundInvokeReturn=true;
+            }
+        
+        if(!foundInvoke)
+            fail("INVOKE Marker not found");
+        
+        if(!foundInvokeReturn)
+            fail("INVOKE RETURN Marker not found");
+        
+        verify(postRequestedFor(urlEqualTo("/GRMLWPService/v1/serviceEndPoint/findRunning"))
+                .withHeader(ONAPLogConstants.Headers.INVOCATION_ID.toString(), matching(uuidRegex))
+                        .withHeader(ONAPLogConstants.Headers.REQUEST_ID.toString(), matching(uuidRegex))
+                                .withHeader(ONAPLogConstants.Headers.PARTNER_NAME.toString(), equalTo("SO")));
+        TestAppender.events.clear();
 	}
 	
 	@Test 
@@ -116,68 +140,6 @@ public class GRMClientTest {
 		client.findRunningServices("TEST.ECOMP_PSL.*", 1, "TEST");
 	}
 	
-	@Ignore
-	@Test
-	public void testAdd() throws Exception {
-
-		wireMockRule.stubFor(post(urlPathEqualTo("/GRMLWPService/v1/serviceEndPoint/add"))
-			.willReturn(aResponse()
-				.withStatus(202)
-				.withHeader("Content-Type", MediaType.APPLICATION_JSON)
-				.withBody("test")));
-		wireMockRule.addMockServiceRequestListener((request, response) -> {
-			System.out.println("URL Requested => " + request.getAbsoluteUrl());
-			System.out.println("Request Body => " + request.getBodyAsString());
-			System.out.println("Request Headers => " + request.getHeaders().toString());
-			System.out.println("Response Status => " + response.getStatus());
-			System.out.println("Response Body => " + response.getBodyAsString());
-		});	
-		
-		Version ver = new Version();
-		ver.setMajor(1);
-		ver.setMinor(0);
-		ver.setPatch("0");
-
-		ServiceEndPoint sep = new ServiceEndPoint();
-		sep.setName("TEST.ECOMP_PSL.Inventory");
-		sep.setVersion(ver);
-		sep.setHostAddress("127.0.0.1");
-		sep.setListenPort("8080");
-		sep.setLatitude("37.7022");
-		sep.setLongitude("121.9358");
-		sep.setContextPath("/");
-		sep.setRouteOffer("TEST");
-		
-		OperationalInfo operInfo = new OperationalInfo();
-		operInfo.setCreatedBy("edge");
-		operInfo.setUpdatedBy("edge");
-		
-		sep.setOperationalInfo(operInfo);
-		
-		Property prop1 = new Property();
-		prop1.setName("Environment");
-		prop1.setValue("TEST");
-		
-		Property prop2 = new Property();
-		prop2.setName("cpfrun_cluster_name");
-		prop2.setValue("testcase_cluster_no_cluster");
-		
-		List<Property> props = new ArrayList<Property>();
-		props.add(prop1);
-		props.add(prop2);
-		
-		sep.setProperties(props);
-
-		ServiceEndPointRequest request = new ServiceEndPointRequest();
-		request.setEnv("DEV");
-		request.setServiceEndPoint(sep);
-		
-		System.out.println("Request in JSON: " + mapper.writeValueAsString(request));
-		
-		GRMClient client = new GRMClient();
-		client.addServiceEndPoint(request);
-	}
-	
 	@Test
 	public void testAddFail() throws Exception {
 		wireMockRule.stubFor(post(urlPathEqualTo("/GRMLWPService/v1/serviceEndPoint/add"))