From 93afc1eb95f38939ec0c60cce466d76d449e7faf Mon Sep 17 00:00:00 2001 From: mpriyank Date: Mon, 28 Mar 2022 15:47:47 +0530 Subject: Structured Exception details for DMI - Introduced DmiErrorMessage in API docs with 502 Bad Gateway - HttpClientRequestException will be thrown which will be exposed as 502 BAD Gateway for the client from NCMP Issue-ID: CPS-917 Change-Id: Iba8f159e8216bc1f63a9ab86208e5c802437e2e8 Signed-off-by: mpriyank --- .../NetworkCmProxyRestExceptionHandler.java | 24 ++++++++++++++++++++-- .../NetworkCmProxyRestExceptionHandlerSpec.groovy | 17 +++++++++++++-- 2 files changed, 37 insertions(+), 4 deletions(-) (limited to 'cps-ncmp-rest/src') 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 0843e9741..c72373344 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 @@ -24,11 +24,14 @@ import lombok.AccessLevel; import lombok.NoArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.ncmp.api.impl.exception.DmiRequestException; +import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException; import org.onap.cps.ncmp.api.impl.exception.InvalidTopicException; import org.onap.cps.ncmp.api.impl.exception.NcmpException; import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException; import org.onap.cps.ncmp.rest.controller.NetworkCmProxyController; import org.onap.cps.ncmp.rest.controller.NetworkCmProxyInventoryController; +import org.onap.cps.ncmp.rest.model.DmiErrorMessage; +import org.onap.cps.ncmp.rest.model.DmiErrorMessageDmiresponse; import org.onap.cps.ncmp.rest.model.ErrorMessage; import org.onap.cps.spi.exceptions.CpsException; import org.onap.cps.spi.exceptions.DataNodeNotFoundException; @@ -66,6 +69,12 @@ public class NetworkCmProxyRestExceptionHandler { return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception); } + @ExceptionHandler({HttpClientRequestException.class}) + public static ResponseEntity handleClientRequestExceptions( + final HttpClientRequestException httpClientRequestException) { + return wrapDmiErrorResponse(HttpStatus.BAD_GATEWAY, httpClientRequestException); + } + @ExceptionHandler({DmiRequestException.class, DataValidationException.class, HttpMessageNotReadableException.class, InvalidTopicException.class}) public static ResponseEntity handleDmiRequestExceptions(final Exception exception) { @@ -91,8 +100,19 @@ public class NetworkCmProxyRestExceptionHandler { } else { errorMessage.setDetails(CHECK_LOGS_FOR_DETAILS); } - errorMessage.setDetails(exception instanceof CpsException ? ((CpsException) exception).getDetails() : - CHECK_LOGS_FOR_DETAILS); + errorMessage.setDetails( + exception instanceof CpsException ? ((CpsException) exception).getDetails() : CHECK_LOGS_FOR_DETAILS); return new ResponseEntity<>(errorMessage, status); } + + private static ResponseEntity wrapDmiErrorResponse(final HttpStatus httpStatus, + final HttpClientRequestException httpClientRequestException) { + final var dmiErrorMessage = new DmiErrorMessage(); + final var dmiErrorResponse = new DmiErrorMessageDmiresponse(); + dmiErrorResponse.setHttpCode(httpClientRequestException.getHttpStatus()); + dmiErrorResponse.setBody(httpClientRequestException.getDetails()); + dmiErrorMessage.setMessage(httpClientRequestException.getMessage()); + dmiErrorMessage.setDmiResponse(dmiErrorResponse); + return new ResponseEntity<>(dmiErrorMessage, httpStatus); + } } diff --git a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandlerSpec.groovy b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandlerSpec.groovy index b64237015..1f6c38428 100644 --- a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandlerSpec.groovy +++ b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandlerSpec.groovy @@ -21,14 +21,13 @@ package org.onap.cps.ncmp.rest.exceptions -import com.fasterxml.jackson.databind.ObjectMapper import groovy.json.JsonSlurper import org.mapstruct.factory.Mappers import org.onap.cps.TestUtils import org.onap.cps.ncmp.api.NetworkCmProxyDataService import org.onap.cps.ncmp.api.impl.exception.DmiRequestException +import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException -import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle import org.onap.cps.ncmp.rest.controller.NcmpRestInputMapper import org.onap.cps.spi.exceptions.CpsException import org.onap.cps.spi.exceptions.DataNodeNotFoundException @@ -38,6 +37,7 @@ import org.spockframework.spring.SpringBean import org.springframework.beans.factory.annotation.Autowired import org.springframework.beans.factory.annotation.Value import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest +import org.springframework.http.HttpStatus import org.springframework.http.MediaType import org.springframework.test.web.servlet.MockMvc import spock.lang.Shared @@ -111,6 +111,19 @@ class NetworkCmProxyRestExceptionHandlerSpec extends Specification { assertTestResponse(response, BAD_REQUEST, sampleErrorMessage, sampleErrorDetails) } + def 'Failing DMI Request - passthrough scenario'() { + given: 'failing DMI request' + mockNetworkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(*_) >> { throw new HttpClientRequestException('Error Message Details NCMP', 'Bad Request from DMI', 400) } + when: 'the DMI request is executed' + def response = mvc.perform(get("$dataNodeBaseEndpointNcmp/ch/testCmHandle/data/ds/ncmp-datastore:passthrough-running?resourceIdentifier=stores:bookstore/categories=100")) + .andReturn().response + then: 'NCMP service responds with 502 Bad Gateway status' + response.status == HttpStatus.BAD_GATEWAY.value() + and: 'the NCMP response also contains the original DMI response details' + response.contentAsString.contains('400') + response.contentAsString.contains('Bad Request from DMI') + } + def setupTestException(exception, apiType) { if (NCMP == apiType) { mockNetworkCmProxyDataService.getYangResourcesModuleReferences(*_) >> { throw exception } -- cgit 1.2.3-korg