diff options
6 files changed, 146 insertions, 9 deletions
diff --git a/cps-application/src/main/resources/application.yml b/cps-application/src/main/resources/application.yml index 1411f31a6..d615e995c 100644 --- a/cps-application/src/main/resources/application.yml +++ b/cps-application/src/main/resources/application.yml @@ -1,7 +1,7 @@ # ============LICENSE_START=======================================================
# Copyright (C) 2021 Pantheon.tech
# Modifications Copyright (C) 2021 Bell Canada
-# Modifications Copyright (C) 2021 Nordix Foundation
+# Modifications Copyright (C) 2021-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.
@@ -30,6 +30,8 @@ rest: spring:
main:
banner-mode: "off"
+ application:
+ name: "cps-application"
jpa:
ddl-auto: create
open-in-view: false
@@ -125,6 +127,8 @@ logging: level:
org:
springframework: INFO
+ onap:
+ cps: INFO
dmi:
auth:
diff --git a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandler.java b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandler.java index 672932977..ce9dd5a02 100755 --- a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandler.java +++ b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandler.java @@ -1,7 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 Pantheon.tech - * Modifications Copyright (C) 2021 Nordix Foundation + * Modifications Copyright (C) 2021-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. @@ -20,8 +20,6 @@ package org.onap.cps.ncmp.rest.exceptions; -import lombok.AccessLevel; -import lombok.NoArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.ncmp.api.impl.exception.NcmpException; import org.onap.cps.ncmp.rest.controller.NetworkCmProxyController; @@ -36,7 +34,6 @@ import org.springframework.web.bind.annotation.RestControllerAdvice; * Exception handler with error message return. */ @Slf4j -@NoArgsConstructor(access = AccessLevel.PRIVATE) @RestControllerAdvice(assignableTypes = {NetworkCmProxyController.class}) public class NetworkCmProxyRestExceptionHandler { diff --git a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java index d790e0802..52af81cea 100755 --- a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java +++ b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java @@ -1,7 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2020 Pantheon.tech - * Modifications Copyright (C) 2021 Nordix Foundation + * Modifications Copyright (C) 2021-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. @@ -48,9 +48,6 @@ import org.springframework.web.bind.annotation.RestControllerAdvice; QueryRestController.class}) public class CpsRestExceptionHandler { - private CpsRestExceptionHandler() { - } - /** * Default exception handler. * diff --git a/cps-service/pom.xml b/cps-service/pom.xml index 0c7556407..bfc3931bc 100644 --- a/cps-service/pom.xml +++ b/cps-service/pom.xml @@ -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>
@@ -144,5 +148,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 000000000..20c6af6c3 --- /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 000000000..b15af490e --- /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) + } +} |