2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modification Copyright (C) 2021-2022 Nordix Foundation
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.rest.exceptions
24 import groovy.json.JsonSlurper
25 import org.mapstruct.factory.Mappers
26 import org.onap.cps.TestUtils
27 import org.onap.cps.ncmp.api.NetworkCmProxyDataService
28 import org.onap.cps.ncmp.api.impl.exception.DmiRequestException
29 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException
30 import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException
31 import org.onap.cps.ncmp.rest.controller.NcmpRestInputMapper
32 import org.onap.cps.spi.exceptions.CpsException
33 import org.onap.cps.spi.exceptions.DataNodeNotFoundException
34 import org.onap.cps.spi.exceptions.DataValidationException
35 import org.onap.cps.utils.JsonObjectMapper
36 import org.spockframework.spring.SpringBean
37 import org.springframework.beans.factory.annotation.Autowired
38 import org.springframework.beans.factory.annotation.Value
39 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
40 import org.springframework.http.HttpStatus
41 import org.springframework.http.MediaType
42 import org.springframework.test.web.servlet.MockMvc
43 import spock.lang.Shared
44 import spock.lang.Specification
46 import static org.onap.cps.ncmp.rest.exceptions.NetworkCmProxyRestExceptionHandlerSpec.ApiType.NCMP
47 import static org.onap.cps.ncmp.rest.exceptions.NetworkCmProxyRestExceptionHandlerSpec.ApiType.NCMPINVENTORY
48 import static org.springframework.http.HttpStatus.BAD_REQUEST
49 import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR
50 import static org.springframework.http.HttpStatus.NOT_FOUND
51 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
52 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
55 class NetworkCmProxyRestExceptionHandlerSpec extends Specification {
61 NetworkCmProxyDataService mockNetworkCmProxyDataService = Mock()
64 JsonObjectMapper jsonObjectMapper = Stub()
67 NcmpRestInputMapper ncmpRestInputMapper = Mappers.getMapper(NcmpRestInputMapper)
69 @Value('${rest.api.ncmp-base-path}')
72 @Value('${rest.api.ncmp-inventory-base-path}')
73 def basePathNcmpInventory
75 def dataNodeBaseEndpointNcmp
76 def dataNodeBaseEndpointNcmpInventory
79 def sampleErrorMessage = 'some error message'
81 def sampleErrorDetails = 'some error details'
84 dataNodeBaseEndpointNcmp = "$basePathNcmp/v1"
85 dataNodeBaseEndpointNcmpInventory = "$basePathNcmpInventory/v1"
88 def 'Get request with generic #scenario exception returns correct HTTP Status with #scenario'() {
89 when: 'an exception is thrown by the service'
90 setupTestException(exception, NCMP)
91 def response = performTestRequest(NCMP)
92 then: 'an HTTP response is returned with correct message and details'
93 assertTestResponse(response, expectedErrorCode, expectedErrorMessage, expectedErrorDetails)
95 scenario | exception || expectedErrorDetails | expectedErrorMessage | expectedErrorCode
96 'CPS' | new CpsException(sampleErrorMessage, sampleErrorDetails) || sampleErrorDetails | sampleErrorMessage | INTERNAL_SERVER_ERROR
97 'NCMP-server' | new ServerNcmpException(sampleErrorMessage, sampleErrorDetails) || null | sampleErrorMessage | INTERNAL_SERVER_ERROR
98 'NCMP-client' | new DmiRequestException(sampleErrorMessage, sampleErrorDetails) || null | sampleErrorMessage | BAD_REQUEST
99 'DataNode Validation' | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName') || null | 'DataNode not found' | NOT_FOUND
100 'other' | new IllegalStateException(sampleErrorMessage) || null | sampleErrorMessage | INTERNAL_SERVER_ERROR
101 'Data Node Not Found' | new DataNodeNotFoundException('myDataspaceName', 'myAnchorName') || 'DataNode not found' | 'DataNode not found' | NOT_FOUND
104 def 'Post request with exception returns correct HTTP Status.'() {
105 given: 'the service throws data validation exception'
106 def exception = new DataValidationException(sampleErrorMessage, sampleErrorDetails)
107 setupTestException(exception, NCMPINVENTORY)
108 when: 'the HTTP request is made'
109 def response = performTestRequest(NCMPINVENTORY)
110 then: 'an HTTP response is returned with correct message and details'
111 assertTestResponse(response, BAD_REQUEST, sampleErrorMessage, sampleErrorDetails)
114 def 'Failing DMI Request - passthrough scenario'() {
115 given: 'failing DMI request'
116 mockNetworkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(*_) >> { throw new HttpClientRequestException('Error Message Details NCMP', 'Bad Request from DMI', 400) }
117 when: 'the DMI request is executed'
118 def response = mvc.perform(get("$dataNodeBaseEndpointNcmp/ch/testCmHandle/data/ds/ncmp-datastore:passthrough-running?resourceIdentifier=stores:bookstore/categories=100"))
119 .andReturn().response
120 then: 'NCMP service responds with 502 Bad Gateway status'
121 response.status == HttpStatus.BAD_GATEWAY.value()
122 and: 'the NCMP response also contains the original DMI response details'
123 response.contentAsString.contains('400')
124 response.contentAsString.contains('Bad Request from DMI')
127 def setupTestException(exception, apiType) {
128 if (NCMP == apiType) {
129 mockNetworkCmProxyDataService.getYangResourcesModuleReferences(*_) >> { throw exception }
131 mockNetworkCmProxyDataService.updateDmiRegistrationAndSyncModule(*_) >> { throw exception }
134 def performTestRequest(apiType) {
135 if (NCMP == apiType) {
136 return mvc.perform(get("$dataNodeBaseEndpointNcmp/ch/testCmHandle/modules")).andReturn().response
138 def jsonData = TestUtils.getResourceFileContent('dmi_registration_all_singing_and_dancing.json')
139 return mvc.perform(post("$dataNodeBaseEndpointNcmpInventory/ch").contentType(MediaType.APPLICATION_JSON).content(jsonData)).andReturn().response
142 static void assertTestResponse(response, expectedStatus , expectedErrorMessage , expectedErrorDetails) {
143 assert response.status == expectedStatus.value()
144 def content = new JsonSlurper().parseText(response.contentAsString)
145 assert content['status'].toString().contains(expectedStatus.toString())
146 assert content['message'].toString().contains(expectedErrorMessage)
147 assert expectedErrorDetails == null || content['details'].toString().contains(expectedErrorDetails)