Merge "CCSDK-1603:Changes in 'Config via netconf' BP to pull data from AAI"
[ccsdk/cds.git] / ms / blueprintsprocessor / functions / resource-resolution / src / main / kotlin / org / onap / ccsdk / cds / blueprintsprocessor / functions / resource / resolution / processor / RestResourceResolutionProcessor.kt
1 /*
2  *  Copyright © 2018 IBM.
3  *  Modifications Copyright © 2017-2019 AT&T, Bell Canada
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  */
17
18 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
19
20 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR
21 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.RestResourceSource
22 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
23 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BluePrintRestLibPropertyService
24 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService
25 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
26 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
27 import org.onap.ccsdk.cds.controllerblueprints.core.isNotEmpty
28 import org.onap.ccsdk.cds.controllerblueprints.core.nullToEmpty
29 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
30 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
31 import org.slf4j.LoggerFactory
32 import org.springframework.beans.factory.config.ConfigurableBeanFactory
33 import org.springframework.context.annotation.Scope
34 import org.springframework.stereotype.Service
35
36 /**
37  * RestResourceResolutionProcessor
38  *
39  * @author Kapil Singal
40  */
41 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
42 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
43 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
44     ResourceAssignmentProcessor() {
45
46     private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
47
48     override fun getName(): String {
49         return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
50     }
51
52     override suspend fun processNB(resourceAssignment: ResourceAssignment) {
53         try {
54             validate(resourceAssignment)
55
56             // Check if It has Input
57             if (!setFromInput(resourceAssignment)) {
58                 val dName = resourceAssignment.dictionaryName!!
59                 val dSource = resourceAssignment.dictionarySource!!
60                 val resourceDefinition = resourceDefinition(dName)
61
62                 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
63                 val resourceSource = resourceAssignment.dictionarySourceDefinition
64                     ?: resourceDefinition?.sources?.get(dSource)
65                     ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
66
67                 val resourceSourceProperties =
68                     checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
69
70                 val sourceProperties =
71                     JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
72
73                 val path = nullToEmpty(sourceProperties.path)
74                 val inputKeyMapping =
75                     checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
76                 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
77
78                 // Resolving content Variables
79                 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
80                 val urlPath =
81                     resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
82                 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
83
84                 logger.info("RestResource ($dSource) dictionary information: " +
85                         "URL:($urlPath), input-key-mapping:($inputKeyMapping), output-key-mapping:(${sourceProperties.outputKeyMapping})")
86                 val requestHeaders = sourceProperties.headers
87                 logger.info("$dSource dictionary information : ($urlPath), ($inputKeyMapping), (${sourceProperties.outputKeyMapping})")
88                 // Get the Rest Client Service
89                 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
90
91                 val response = restClientService.exchangeResource(verb, urlPath, payload, requestHeaders.toMap())
92                 val responseStatusCode = response.status
93                 val responseBody = response.body
94                 val outputKeyMapping = sourceProperties.outputKeyMapping
95                 if (responseStatusCode in 200..299 && outputKeyMapping.isNullOrEmpty()) {
96                     logger.info("AS>> outputKeyMapping==null, will not populateResource")
97                 } else if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
98                     populateResource(resourceAssignment, sourceProperties, responseBody, path)
99                 } else {
100                     val errMsg =
101                         "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
102                     logger.warn(errMsg)
103                     throw BluePrintProcessorException(errMsg)
104                 }
105             }
106             // Check the value has populated for mandatory case
107             ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
108         } catch (e: Exception) {
109             ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
110             throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
111         }
112     }
113
114     fun blueprintWebClientService(
115         resourceAssignment: ResourceAssignment,
116         restResourceSource: RestResourceSource
117     ): BlueprintWebClientService {
118         return if (isNotEmpty(restResourceSource.endpointSelector)) {
119             val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
120             blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
121         } else {
122             blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
123         }
124     }
125
126     @Throws(BluePrintProcessorException::class)
127     private fun populateResource(
128         resourceAssignment: ResourceAssignment, sourceProperties: RestResourceSource,
129         restResponse: String, path: String
130     ) {
131         val dName = resourceAssignment.dictionaryName
132         val dSource = resourceAssignment.dictionarySource
133         val type = nullToEmpty(resourceAssignment.property?.type)
134         val metadata = resourceAssignment.property!!.metadata
135
136         val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) {
137             "failed to get output-key-mappings for $dName under $dSource properties"
138         }
139         logger.info("Response processing type ($type)")
140
141         val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
142             "Failed to find path ($path) in response ($restResponse)"
143         }
144
145         val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
146         logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
147
148         val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
149             responseNode, resourceAssignment,
150             raRuntimeService, outputKeyMapping
151         )
152
153         // Set the List of Complex Values
154         ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
155     }
156
157     @Throws(BluePrintProcessorException::class)
158     private fun validate(resourceAssignment: ResourceAssignment) {
159         checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
160         checkNotEmpty(resourceAssignment.dictionaryName) {
161             "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
162         }
163         checkNotEmpty(resourceAssignment.dictionarySource) {
164             "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
165         }
166     }
167
168     override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
169         raRuntimeService.getBluePrintError().addError(runtimeException.message!!)
170     }
171
172 }