Address NullPointerException with apih healthcheck endpoint

Facing NullPointerException with apih healthcheck endpoint
with elalto branch. Brittany has addressed this issue
with master branch and this change brings in those
changes with elalto branch
This is a squashed commit cherry picked commits from master
commit 4e79baed423434b42d75f0d5c26757cd6792ce79
commit b341d9cd027b0f7bec125d51b8298c3e31d7f685
commit 02b85383a1f2a7c9677db2929b30fc283ad9a00c
commit 8e3e32d4c7a10ddd8ee97576e030185e273bd2c0
commit 8a1bade3296510df340d11f7c22353994cbdfa83
commit ef6d7e225d8601489f8559483e1414dc62a62e8b
commit 84a201f889f635c9405ea737d814fc43d274afd7

Issue-ID: SO-3046
Signed-off-by: Ramesh Parthasarathy(rp6768)<ramesh.parthasarathy@att.com>
Change-Id: Ic7579f84746dad4002a5291edd54237eaaa602cf

6 files changed, 192 insertions, 6 deletions

diff --git a/common/src/main/java/org/onap/so/db/connections/ScheduledDnsLookup.java b/common/src/main/java/org/onap/so/db/connections/ScheduledDnsLookup.java
index 14f2f5e9b7..40acac57aa 100644
--- a/common/src/main/java/org/onap/so/db/connections/ScheduledDnsLookup.java
+++ b/common/src/main/java/org/onap/so/db/connections/ScheduledDnsLookup.java
@@ -8,6 +8,11 @@ import javax.management.JMX;
 import javax.management.MBeanServer;
 import javax.management.ObjectInstance;
 import javax.management.ObjectName;
+import org.jboss.logging.MDC;
+import org.onap.logging.filter.base.ONAPComponents;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.onap.so.logger.ErrorCode;
+import org.onap.so.logger.ScheduledTasksMDCSetup;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -27,16 +32,22 @@ public class ScheduledDnsLookup {
     @Autowired
     private DbDnsIpAddress dnsIpAddress;
 
+    @Autowired
+    private ScheduledTasksMDCSetup scheduledMDCSetup;
+
     private static Logger logger = LoggerFactory.getLogger(ScheduledDnsLookup.class);
 
     @Scheduled(fixedRate = 15000)
     public void performDnsLookup() {
-
+        scheduledMDCSetup.mdcSetup(ONAPComponents.SO, "performDnsLookup");
         String dnsUrl = System.getenv(DB_HOST);
 
         try {
             if (dnsUrl == null) {
+                scheduledMDCSetup.errorMDCSetup(ErrorCode.DataError, "Database DNS is not provided.");
                 logger.error("Database DNS is not provided. Please verify the configuration");
+                MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.ERROR.toString());
+                scheduledMDCSetup.exitAndClearMDC();
                 return;
             }
 
@@ -46,6 +57,7 @@ public class ScheduledDnsLookup {
             /* This is in initial state */
             if (currentIpAddress == null) {
                 dnsIpAddress.setIpAddress(ipAddress);
+                scheduledMDCSetup.exitAndClearMDC();
                 return;
             }
 
@@ -57,7 +69,7 @@ public class ScheduledDnsLookup {
         } catch (UnknownHostException e) {
             logger.warn("Database DNS %s is not resolvable to an IP Address", dnsUrl);
         }
-
+        scheduledMDCSetup.exitAndClearMDC();
     }
 
     private void softEvictConnectionPool() {
diff --git a/common/src/main/java/org/onap/so/logger/ErrorCode.java b/common/src/main/java/org/onap/so/logger/ErrorCode.java
index 7fb9522b7c..a57ed99f2b 100644
--- a/common/src/main/java/org/onap/so/logger/ErrorCode.java
+++ b/common/src/main/java/org/onap/so/logger/ErrorCode.java
@@ -25,7 +25,7 @@ public enum ErrorCode {
     AvailabilityError(200),
     DataError(300),
     SchemaError(400),
-    BusinessProcesssError(500),
+    BusinessProcessError(500),
     UnknownError(900);
 
     private int value;
diff --git a/common/src/main/java/org/onap/so/logger/ScheduledTasksMDCSetup.java b/common/src/main/java/org/onap/so/logger/ScheduledTasksMDCSetup.java
new file mode 100644
index 0000000000..41c4b4bfae
--- /dev/null
+++ b/common/src/main/java/org/onap/so/logger/ScheduledTasksMDCSetup.java
@@ -0,0 +1,75 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * 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.so.logger;
+
+import java.util.UUID;
+import org.onap.logging.filter.base.Constants;
+import org.onap.logging.filter.base.MDCSetup;
+import org.onap.logging.filter.base.ONAPComponentsList;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.MDC;
+import org.springframework.stereotype.Component;
+
+@Component
+public class ScheduledTasksMDCSetup extends MDCSetup {
+
+    public void mdcSetup(ONAPComponentsList targetEntity, String serviceName) {
+        try {
+            setEntryTimeStamp();
+            setServerFQDN();
+            MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
+            MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, UUID.randomUUID().toString());
+            MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, targetEntity.toString());
+            MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, Constants.DefaultValues.UNKNOWN);
+            MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, serviceName);
+            setLogTimestamp();
+            setElapsedTime();
+            MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, getProperty(Constants.Property.PARTNER_NAME));
+            logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
+        } catch (Exception e) {
+            logger.warn("Error in ScheduledTasksMDCSetup mdcSetup: {}", e.getMessage());
+        }
+    }
+
+    public void errorMDCSetup(ErrorCode errorCode, String errorDescription) {
+        MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, String.valueOf(errorCode.getValue()));
+        MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, errorDescription);
+    }
+
+    public void exitAndClearMDC() {
+        try {
+            setStatusCode();
+            setLogTimestamp();
+            setElapsedTime();
+            logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
+        } catch (Exception e) {
+            logger.warn("Error in ScheduledTasksMDCSetup clear MDC: {}", e.getMessage());
+        }
+        MDC.clear();
+    }
+
+    public void setStatusCode() {
+        String currentStatusCode = MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE);
+        if (currentStatusCode == null || !currentStatusCode.equals(ONAPLogConstants.ResponseStatus.ERROR.toString())) {
+            MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.COMPLETE.toString());
+        }
+    }
+}
diff --git a/common/src/main/java/org/onap/so/utils/Components.java b/common/src/main/java/org/onap/so/utils/Components.java
index 0713723264..5af8c5aa56 100644
--- a/common/src/main/java/org/onap/so/utils/Components.java
+++ b/common/src/main/java/org/onap/so/utils/Components.java
@@ -1,7 +1,23 @@
 package org.onap.so.utils;
 
+import java.util.EnumSet;
+import java.util.Set;
+import org.onap.logging.filter.base.ONAPComponents;
 import org.onap.logging.filter.base.ONAPComponentsList;
 
 public enum Components implements ONAPComponentsList {
-    OPENSTACK, UNKNOWN;
+    OPENSTACK, UNKNOWN, ASDC_CONTROLLER, APIH, SDNC_ADAPTER;
+
+
+    public static Set<Components> getSOInternalComponents() {
+        return EnumSet.of(ASDC_CONTROLLER, APIH, SDNC_ADAPTER);
+    }
+
+    @Override
+    public String toString() {
+        if (getSOInternalComponents().contains(this))
+            return ONAPComponents.SO + "." + this.name();
+        else
+            return this.name();
+    }
 }
diff --git a/common/src/main/java/org/onap/so/utils/CryptoUtils.java b/common/src/main/java/org/onap/so/utils/CryptoUtils.java
index 640660e97c..ff69e3e4b1 100644
--- a/common/src/main/java/org/onap/so/utils/CryptoUtils.java
+++ b/common/src/main/java/org/onap/so/utils/CryptoUtils.java
@@ -91,7 +91,7 @@ public final class CryptoUtils {
             return CryptoUtils.encrypt(message, CLOUD_KEY);
         } catch (GeneralSecurityException e) {
             logger.error(LoggingAnchor.THREE, MessageEnum.RA_GENERAL_EXCEPTION.toString(),
-                    ErrorCode.BusinessProcesssError.getValue(), "Exception in encryptPassword ", e);
+                    ErrorCode.BusinessProcessError.getValue(), "Exception in encryptPassword ", e);
             return null;
         }
     }
@@ -101,7 +101,7 @@ public final class CryptoUtils {
             return CryptoUtils.decrypt(message, CLOUD_KEY);
         } catch (GeneralSecurityException e) {
             logger.error(LoggingAnchor.THREE, MessageEnum.RA_GENERAL_EXCEPTION.toString(),
-                    ErrorCode.BusinessProcesssError.getValue(), "Exception in encryptPassword ", e);
+                    ErrorCode.BusinessProcessError.getValue(), "Exception in encryptPassword ", e);
             return null;
         }
     }
diff --git a/common/src/test/java/org/onap/so/logger/ScheduledTasksMDCSetupTest.java b/common/src/test/java/org/onap/so/logger/ScheduledTasksMDCSetupTest.java
new file mode 100644
index 0000000000..f232781871
--- /dev/null
+++ b/common/src/test/java/org/onap/so/logger/ScheduledTasksMDCSetupTest.java
@@ -0,0 +1,83 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * 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.so.logger;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import org.junit.After;
+import org.junit.Test;
+import org.onap.logging.filter.base.Constants;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.onap.so.utils.Components;
+import org.onap.so.utils.UUIDChecker;
+import org.slf4j.MDC;
+
+public class ScheduledTasksMDCSetupTest {
+    private ScheduledTasksMDCSetup tasksMDCSetup = new ScheduledTasksMDCSetup();
+
+    @After
+    public void tearDown() {
+        MDC.clear();
+        System.clearProperty("partnerName");
+    }
+
+    @Test
+    public void mdcSetupTest() {
+        System.setProperty("partnerName", Components.APIH.toString());
+        tasksMDCSetup.mdcSetup(Components.APIH, "mdcSetupTest");
+
+        assertTrue(UUIDChecker.isValidUUID(MDC.get(ONAPLogConstants.MDCs.REQUEST_ID)));
+        assertEquals(Components.APIH.toString(), MDC.get(ONAPLogConstants.MDCs.TARGET_ENTITY));
+        assertEquals(Components.APIH.toString(), MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME));
+        assertEquals("mdcSetupTest", MDC.get(ONAPLogConstants.MDCs.SERVICE_NAME));
+        assertEquals(Constants.DefaultValues.UNKNOWN, MDC.get(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME));
+        assertNotNull(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP));
+        assertNotNull(MDC.get(ONAPLogConstants.MDCs.ELAPSED_TIME));
+        assertNotNull(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP));
+        assertNotNull(MDC.get(ONAPLogConstants.MDCs.SERVER_FQDN));
+    }
+
+    @Test
+    public void errorMDCSetupTest() {
+        tasksMDCSetup.errorMDCSetup(ErrorCode.UnknownError, "Error");
+
+        assertEquals("900", MDC.get(ONAPLogConstants.MDCs.ERROR_CODE));
+        assertEquals("Error", MDC.get(ONAPLogConstants.MDCs.ERROR_DESC));
+    }
+
+    @Test
+    public void setStatusCodeTest() {
+        tasksMDCSetup.setStatusCode();
+
+        assertEquals(ONAPLogConstants.ResponseStatus.COMPLETE.toString(),
+                MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
+    }
+
+    @Test
+    public void setStatusCodeErrorTest() {
+        MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.ERROR.toString());
+        tasksMDCSetup.setStatusCode();
+
+        assertEquals(ONAPLogConstants.ResponseStatus.ERROR.toString(),
+                MDC.get(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE));
+    }
+}