Improve logging in NCMP

Issue-ID: CPS-855

Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
Change-Id: I5d8a6a711d1c6b13d5d8eeba52a1dcd689dbdae2

3 files changed, 140 insertions, 1 deletions

diff --git a/cps-service/pom.xml b/cps-service/pom.xml
index 6cef985f89..b875bbb894 100644
--- a/cps-service/pom.xml
+++ b/cps-service/pom.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>

 <!--

   ============LICENSE_START=======================================================

-  Copyright (C) 2021 Nordix Foundation

+  Copyright (C) 2021-2022 Nordix Foundation

   Modifications Copyright (C) 2021 Bell Canada.

   Modifications Copyright (C) 2021 Pantheon.tech

   ================================================================================

@@ -103,6 +103,10 @@
       <groupId>com.google.code.gson</groupId>

       <artifactId>gson</artifactId>

     </dependency>

+    <dependency>

+      <groupId>org.springframework.boot</groupId>

+      <artifactId>spring-boot-starter-aop</artifactId>

+    </dependency>

     <!-- T E S T   D E P E N D E N C I E S -->

     <dependency>

       <groupId>org.codehaus.groovy</groupId>

@@ -139,5 +143,10 @@
       <artifactId>spring-kafka-test</artifactId>

       <scope>test</scope>

     </dependency>

+    <dependency>

+      <groupId>org.aspectj</groupId>

+      <artifactId>aspectjrt</artifactId>

+      <scope>test</scope>

+    </dependency>

   </dependencies>

 </project>

diff --git a/cps-service/src/main/java/org/onap/cps/aop/CpsLoggingAspectService.java b/cps-service/src/main/java/org/onap/cps/aop/CpsLoggingAspectService.java
new file mode 100644
index 0000000000..20c6af6c3f
--- /dev/null
+++ b/cps-service/src/main/java/org/onap/cps/aop/CpsLoggingAspectService.java
@@ -0,0 +1,69 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 Nordix Foundation
+ *  ================================================================================
+ *  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.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.aop;
+
+import java.util.Arrays;
+import java.util.Optional;
+import lombok.SneakyThrows;
+import lombok.extern.slf4j.Slf4j;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.reflect.MethodSignature;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+import org.springframework.stereotype.Component;
+import org.springframework.util.StopWatch;
+
+@Aspect
+@Component
+@Slf4j
+@ConditionalOnExpression(
+        "'${logging.level.org.onap.cps}'.equalsIgnoreCase('DEBUG')"
+)
+public class CpsLoggingAspectService {
+
+    private static final String ALL_CPS_METHODS = "execution(* org.onap.cps..*(..)))";
+
+    /**
+     * To measure method execution time as a logging.
+     * @param proceedingJoinPoint exposes the proceed(..) method in order to support around advice.
+     * @return empty in case of void otherwise an object of return type
+     */
+    @Around(ALL_CPS_METHODS)
+    @SneakyThrows
+    public Object logMethodExecutionTime(final ProceedingJoinPoint proceedingJoinPoint) {
+        final StopWatch stopWatch = new StopWatch();
+
+        //Calculate method execution time
+        stopWatch.start();
+        final Object logObject = Optional.ofNullable(proceedingJoinPoint.proceed()).orElse("");
+        stopWatch.stop();
+        final MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();
+        //Log method execution time
+        log.debug("Execution time of : {}.{}() with argument[s] = {} having result = {} :: {} ms",
+                methodSignature.getDeclaringType().getSimpleName(),
+                methodSignature.getName(), Arrays.toString(proceedingJoinPoint.getArgs()), logObject,
+                stopWatch.getTotalTimeMillis());
+
+        return logObject;
+    }
+
+}
diff --git a/cps-service/src/test/groovy/org/onap/cps/aop/CpsLoggingAspectServiceSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/aop/CpsLoggingAspectServiceSpec.groovy
new file mode 100644
index 0000000000..b15af490e7
--- /dev/null
+++ b/cps-service/src/test/groovy/org/onap/cps/aop/CpsLoggingAspectServiceSpec.groovy
@@ -0,0 +1,61 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 Nordix Foundation
+ *  ================================================================================
+ *  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.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.aop
+
+import org.aspectj.lang.ProceedingJoinPoint
+import org.aspectj.lang.reflect.MethodSignature
+import org.onap.cps.spi.exceptions.DataValidationException
+import spock.lang.Specification
+
+class CpsLoggingAspectServiceSpec extends Specification {
+
+    def mockProceedingJoinPoint = Mock(ProceedingJoinPoint)
+    def mockMethodSignature = Mock(MethodSignature);
+    def objectUnderTest = new CpsLoggingAspectService()
+
+    def setup() {
+        mockMethodSignature.getDeclaringType() >> this.getClass()
+        mockMethodSignature.getDeclaringType().getSimpleName() >> 'CpsLoggingAspectServiceSpec'
+        mockMethodSignature.getName() >> 'logMethodExecutionTime'
+        mockProceedingJoinPoint.getSignature() >> mockMethodSignature
+    }
+
+    def 'Log method execution time.'() {
+        given: 'mock valid arguments'
+            mockProceedingJoinPoint.getArgs() >> 'dataspace-name'
+        when: 'aop intercepts cps method and start calculation of time'
+            objectUnderTest.logMethodExecutionTime(mockProceedingJoinPoint)
+        then: 'process successfully and log details of executed method'
+            1 * mockProceedingJoinPoint.proceed()
+    }
+
+    def 'Creating a data validation exception for invalid args.'() {
+        given: 'a data validation exception is created'
+            mockProceedingJoinPoint.getArgs() >> {
+                throw new DataValidationException('invalid args',
+                        'invalid method arg(s) is passed', new Throwable())
+            }
+        when: 'aop intercepts cps method and start calculation of time'
+            objectUnderTest.logMethodExecutionTime(mockProceedingJoinPoint)
+        then: 'data validation exception is thrown'
+            thrown(DataValidationException.class)
+    }
+}