ms/blueprintsprocessor/functions/resource-resolution/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/resource/resolution/processor/RestResourceResolutionProcessor.kt

   1 /*
   2  *  Copyright © 2018 - 2020 IBM.
   3  *  Modifications Copyright © 2017-2020 AT&T, Bell Canada
   4  *  Modifications Copyright © 2022 Deutche Telekom AG
   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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
  20
  21 import com.fasterxml.jackson.databind.JsonNode
  22 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
  23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR
  24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.RestResourceSource
  25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
  26 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BluePrintRestLibPropertyService
  27 import org.onap.ccsdk.cds.blueprintsprocessor.rest.service.BlueprintWebClientService
  28 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.ExecutionServiceDomains
  29 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  30 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  31 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
  32 import org.onap.ccsdk.cds.controllerblueprints.core.isNotEmpty
  33 import org.onap.ccsdk.cds.controllerblueprints.core.nullToEmpty
  34 import org.onap.ccsdk.cds.controllerblueprints.core.updateErrorMessage
  35 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  36 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.KeyIdentifier
  37 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
  38 import org.slf4j.LoggerFactory
  39 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  40 import org.springframework.context.annotation.Scope
  41 import org.springframework.stereotype.Service
  42 import java.util.HashMap
  43
  44 /**
  45  * RestResourceResolutionProcessor
  46  *
  47  * @author Kapil Singal
  48  */
  49 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
  50 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  51 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
  52     ResourceAssignmentProcessor() {
  53
  54     private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
  55
  56     override fun getName(): String {
  57         return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
  58     }
  59
  60     override suspend fun processNB(resourceAssignment: ResourceAssignment) {
  61         try {
  62             validate(resourceAssignment)
  63
  64             // Check if It has Input
  65             if (!setFromInput(resourceAssignment)) {
  66                 val dName = resourceAssignment.dictionaryName!!
  67                 val dSource = resourceAssignment.dictionarySource!!
  68                 val resourceDefinition = resourceDefinition(dName)
  69
  70                 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
  71                 val resourceSource = resourceAssignment.dictionarySourceDefinition
  72                     ?: resourceDefinition?.sources?.get(dSource)
  73                     ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
  74                 if ((resourceAssignment.property?.type).isNullOrEmpty())
  75                     throw BluePrintProcessorException("Couldn't get data dictionary type for dictionary name (${resourceAssignment.name})")
  76                 val resourceSourceProperties =
  77                     checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
  78
  79                 val sourceProperties =
  80                     JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
  81
  82                 val inputKeyMapping =
  83                     checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
  84                 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(
  85                     inputKeyMapping,
  86                     resourceAssignment.templatingConstants
  87                 ).toMutableMap()
  88                 logger.info("\nResolved Input Key mappings: \n$resolvedInputKeyMapping")
  89
  90                 resolvedInputKeyMapping.map { KeyIdentifier(it.key, it.value) }.let {
  91                     resourceAssignment.keyIdentifiers.addAll(it)
  92                 }
  93
  94                 // Resolving content Variables
  95                 val path = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.path), resolvedInputKeyMapping)
  96                 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
  97                 resourceSourceProperties["resolved-payload"] = JacksonUtils.jsonNode(payload)
  98                 val urlPath =
  99                     resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
 100                 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
 101                 var outputKeyMapping = sourceProperties.outputKeyMapping
 102                 if (!outputKeyMapping.isNullOrEmpty()) {
 103                     outputKeyMapping = outputKeyMapping.mapValues { (_, value) ->
 104                         resolveFromInputKeyMapping(value, resolvedInputKeyMapping)
 105                     }.toMutableMap()
 106                 }
 107                 logger.info(
 108                     "RestResource ($dSource) dictionary information: " +
 109                         "URL:($urlPath), path:($path), input-key-mapping:($inputKeyMapping), output-key-mapping:($outputKeyMapping)"
 110                 )
 111                 val requestHeaders = sourceProperties.headers.mapValues { (_, value) ->
 112                     resolveFromInputKeyMapping(value, resolvedInputKeyMapping)
 113                 }
 114                 logger.info("$dSource dictionary information : ($urlPath), path:($path), ($inputKeyMapping), ($outputKeyMapping)")
 115                 // Get the Rest Client Service
 116                 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
 117
 118                 val response = restClientService.exchangeResource(verb, urlPath, payload, requestHeaders.toMap())
 119                 val responseStatusCode = response.status
 120                 val responseBody = response.body
 121                 if (responseStatusCode in 200..299 && outputKeyMapping == null) {
 122                     resourceAssignment.status = BluePrintConstants.STATUS_SUCCESS
 123                     logger.info("AS>> outputKeyMapping==null, will not populateResource")
 124                 } else if (responseStatusCode in 200..299) {
 125                     populateResource(resourceAssignment, sourceProperties, responseBody, path, outputKeyMapping)
 126                 } else {
 127                     val errMsg =
 128                         "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
 129                     logger.warn(errMsg)
 130                     throw BluePrintProcessorException(errMsg)
 131                 }
 132             }
 133             // Check the value has populated for mandatory case
 134             ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
 135         } catch (e: BluePrintProcessorException) {
 136             val errorMsg = "Failed to process REST resource resolution in template key ($resourceAssignment) assignments."
 137             ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, errorMsg)
 138             throw e.updateErrorMessage(
 139                 ExecutionServiceDomains.RESOURCE_RESOLUTION, errorMsg,
 140                 "Wrong resource definition or resolution failed."
 141             )
 142         } catch (e: Exception) {
 143             ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
 144             throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
 145         }
 146     }
 147
 148     open fun blueprintWebClientService(
 149         resourceAssignment: ResourceAssignment,
 150         restResourceSource: RestResourceSource
 151     ): BlueprintWebClientService {
 152         return if (isNotEmpty(restResourceSource.endpointSelector)) {
 153             val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
 154             blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
 155         } else {
 156             blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
 157         }
 158     }
 159
 160     @Throws(BluePrintProcessorException::class)
 161     open fun populateResource(
 162         resourceAssignment: ResourceAssignment,
 163         sourceProperties: RestResourceSource,
 164         restResponse: String,
 165         path: String,
 166         outputKeyMapping: MutableMap<String, String>?
 167     ) {
 168         val dName = resourceAssignment.dictionaryName
 169         val dSource = resourceAssignment.dictionarySource
 170         val type = nullToEmpty(resourceAssignment.property?.type)
 171         val metadata = resourceAssignment.property!!.metadata
 172
 173         logger.info("Response processing type ($type)")
 174
 175         // we check null in processNB
 176         var outputKeyMapping = sourceProperties.outputKeyMapping!!
 177
 178         var responseNode: JsonNode? = if (outputKeyMapping.isEmpty()) {
 179             var tmpResponseNode = if (type == BluePrintConstants.DATA_TYPE_JSON || type == BluePrintConstants.DATA_TYPE_MAP)
 180                 JacksonUtils.jsonNode(restResponse).at(path)
 181             else
 182                 JacksonUtils.convertPrimitiveResourceValue(type, restResponse).at(path)
 183             if (type == BluePrintConstants.DATA_TYPE_JSON || type == BluePrintConstants.DATA_TYPE_MAP) {
 184                 if (tmpResponseNode.isObject) {
 185                     logger.info("Creating substitute outputKeyMapping for $type type")
 186                     outputKeyMapping = HashMap<String, String>()
 187                     tmpResponseNode.fieldNames().forEach {
 188                         outputKeyMapping[it] = it
 189                     }
 190                     tmpResponseNode
 191                 } else {
 192                     val errMsg =
 193                         "Failed to get $dSource result for dictionary name ($dName): response is not a JSON object"
 194                     logger.warn(errMsg)
 195                     throw BluePrintProcessorException(errMsg)
 196                 }
 197             } else {
 198                 logger.info("Wrapping output for the dictionary name (${resourceAssignment.name})")
 199                 val newNode = jacksonObjectMapper().createObjectNode()
 200                 newNode.replace(dName, tmpResponseNode)
 201                 outputKeyMapping[dName!!] = dName
 202                 newNode
 203             }
 204         } else
 205             JacksonUtils.jsonNode(restResponse).at(path)
 206         responseNode = checkNotNull(responseNode) {
 207             "Failed to find path ($path) in response ($responseNode)"
 208         }
 209
 210         val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
 211         logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
 212
 213         val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
 214             responseNode, resourceAssignment,
 215             raRuntimeService, outputKeyMapping
 216         )
 217
 218         // Set the List of Complex Values
 219         ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
 220     }
 221
 222     @Throws(BluePrintProcessorException::class)
 223     open fun validate(resourceAssignment: ResourceAssignment) {
 224         checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
 225         checkNotEmpty(resourceAssignment.dictionaryName) {
 226             "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
 227         }
 228         checkNotEmpty(resourceAssignment.dictionarySource) {
 229             "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
 230         }
 231     }
 232
 233     override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
 234         addError(runtimeException.message!!)
 235     }
 236 }