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  *
   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.blueprintsprocessor.services.execution.ExecutionServiceDomains
  26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  27 import org.onap.ccsdk.cds.controllerblueprints.core.isNotEmpty
  28 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
  29 import org.onap.ccsdk.cds.controllerblueprints.core.nullToEmpty
  30 import org.onap.ccsdk.cds.controllerblueprints.core.updateErrorMessage
  31 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  32 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.KeyIdentifier
  33 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
  34 import org.slf4j.LoggerFactory
  35 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  36 import org.springframework.context.annotation.Scope
  37 import org.springframework.stereotype.Service
  38
  39 /**
  40  * RestResourceResolutionProcessor
  41  *
  42  * @author Kapil Singal
  43  */
  44 @Service("${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest")
  45 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  46 open class RestResourceResolutionProcessor(private val blueprintRestLibPropertyService: BluePrintRestLibPropertyService) :
  47     ResourceAssignmentProcessor() {
  48
  49     private val logger = LoggerFactory.getLogger(RestResourceResolutionProcessor::class.java)
  50
  51     override fun getName(): String {
  52         return "${PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-rest"
  53     }
  54
  55     override suspend fun processNB(resourceAssignment: ResourceAssignment) {
  56         try {
  57             validate(resourceAssignment)
  58
  59             // Check if It has Input
  60             if (!setFromInput(resourceAssignment)) {
  61                 val dName = resourceAssignment.dictionaryName!!
  62                 val dSource = resourceAssignment.dictionarySource!!
  63                 val resourceDefinition = resourceDefinition(dName)
  64
  65                 /** Check Resource Assignment has the source definitions, If not get from Resource Definitions **/
  66                 val resourceSource = resourceAssignment.dictionarySourceDefinition
  67                     ?: resourceDefinition?.sources?.get(dSource)
  68                     ?: throw BluePrintProcessorException("couldn't get resource definition $dName source($dSource)")
  69
  70                 val resourceSourceProperties =
  71                     checkNotNull(resourceSource.properties) { "failed to get source properties for $dName " }
  72
  73                 val sourceProperties =
  74                     JacksonUtils.getInstanceFromMap(resourceSourceProperties, RestResourceSource::class.java)
  75
  76                 val path = nullToEmpty(sourceProperties.path)
  77                 val inputKeyMapping =
  78                     checkNotNull(sourceProperties.inputKeyMapping) { "failed to get input-key-mappings for $dName under $dSource properties" }
  79                 val resolvedInputKeyMapping = resolveInputKeyMappingVariables(inputKeyMapping).toMutableMap()
  80
  81                 sourceProperties.inputKeyMapping
  82                         ?.mapValues { raRuntimeService.getDictionaryStore(it.value) }
  83                         ?.map { KeyIdentifier(it.key, it.value) }
  84                         ?.let { resourceAssignment.keyIdentifiers.addAll(it) }
  85
  86                 // Resolving content Variables
  87                 val payload = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.payload), resolvedInputKeyMapping)
  88                 resourceSourceProperties["resolved-payload"] = JacksonUtils.jsonNode(payload)
  89                 val urlPath =
  90                     resolveFromInputKeyMapping(checkNotNull(sourceProperties.urlPath), resolvedInputKeyMapping)
  91                 val verb = resolveFromInputKeyMapping(nullToEmpty(sourceProperties.verb), resolvedInputKeyMapping)
  92
  93                 logger.info(
  94                     "RestResource ($dSource) dictionary information: " +
  95                             "URL:($urlPath), input-key-mapping:($inputKeyMapping), output-key-mapping:(${sourceProperties.outputKeyMapping})"
  96                 )
  97                 val requestHeaders = sourceProperties.headers
  98                 logger.info("$dSource dictionary information : ($urlPath), ($inputKeyMapping), (${sourceProperties.outputKeyMapping})")
  99                 // Get the Rest Client Service
 100                 val restClientService = blueprintWebClientService(resourceAssignment, sourceProperties)
 101
 102                 val response = restClientService.exchangeResource(verb, urlPath, payload, requestHeaders.toMap())
 103                 val responseStatusCode = response.status
 104                 val responseBody = response.body
 105                 val outputKeyMapping = sourceProperties.outputKeyMapping
 106                 if (responseStatusCode in 200..299 && outputKeyMapping.isNullOrEmpty()) {
 107                     logger.info("AS>> outputKeyMapping==null, will not populateResource")
 108                 } else if (responseStatusCode in 200..299 && !responseBody.isBlank()) {
 109                     populateResource(resourceAssignment, sourceProperties, responseBody, path)
 110                 } else {
 111                     val errMsg =
 112                         "Failed to get $dSource result for dictionary name ($dName) using urlPath ($urlPath) response_code: ($responseStatusCode)"
 113                     logger.warn(errMsg)
 114                     throw BluePrintProcessorException(errMsg)
 115                 }
 116             }
 117             // Check the value has populated for mandatory case
 118             ResourceAssignmentUtils.assertTemplateKeyValueNotNull(resourceAssignment)
 119         } catch (e: BluePrintProcessorException) {
 120             val errorMsg = "Failed to process REST resource resolution in template key ($resourceAssignment) assignments."
 121             throw e.updateErrorMessage(ExecutionServiceDomains.RESOURCE_RESOLUTION, errorMsg,
 122                     "Wrong resource definition or resolution failed.")
 123         } catch (e: Exception) {
 124             ResourceAssignmentUtils.setFailedResourceDataValue(resourceAssignment, e.message)
 125             throw BluePrintProcessorException("Failed in template key ($resourceAssignment) assignments with: ${e.message}", e)
 126         }
 127     }
 128
 129     fun blueprintWebClientService(
 130         resourceAssignment: ResourceAssignment,
 131         restResourceSource: RestResourceSource
 132     ): BlueprintWebClientService {
 133         return if (isNotEmpty(restResourceSource.endpointSelector)) {
 134             val restPropertiesJson = raRuntimeService.resolveDSLExpression(restResourceSource.endpointSelector!!)
 135             blueprintRestLibPropertyService.blueprintWebClientService(restPropertiesJson)
 136         } else {
 137             blueprintRestLibPropertyService.blueprintWebClientService(resourceAssignment.dictionarySource!!)
 138         }
 139     }
 140
 141     @Throws(BluePrintProcessorException::class)
 142     private fun populateResource(
 143         resourceAssignment: ResourceAssignment,
 144         sourceProperties: RestResourceSource,
 145         restResponse: String,
 146         path: String
 147     ) {
 148         val dName = resourceAssignment.dictionaryName
 149         val dSource = resourceAssignment.dictionarySource
 150         val type = nullToEmpty(resourceAssignment.property?.type)
 151         val metadata = resourceAssignment.property!!.metadata
 152
 153         val outputKeyMapping = checkNotNull(sourceProperties.outputKeyMapping) {
 154             "failed to get output-key-mappings for $dName under $dSource properties"
 155         }
 156         logger.info("Response processing type ($type)")
 157
 158         val responseNode = checkNotNull(JacksonUtils.jsonNode(restResponse).at(path)) {
 159             "Failed to find path ($path) in response ($restResponse)"
 160         }
 161
 162         val valueToPrint = ResourceAssignmentUtils.getValueToLog(metadata, responseNode)
 163         logger.info("populating value for output mapping ($outputKeyMapping), from json ($valueToPrint)")
 164
 165         val parsedResponseNode = ResourceAssignmentUtils.parseResponseNode(
 166             responseNode, resourceAssignment,
 167             raRuntimeService, outputKeyMapping
 168         )
 169
 170         // Set the List of Complex Values
 171         ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, parsedResponseNode)
 172     }
 173
 174     @Throws(BluePrintProcessorException::class)
 175     private fun validate(resourceAssignment: ResourceAssignment) {
 176         checkNotEmpty(resourceAssignment.name) { "resource assignment template key is not defined" }
 177         checkNotEmpty(resourceAssignment.dictionaryName) {
 178             "resource assignment dictionary name is not defined for template key (${resourceAssignment.name})"
 179         }
 180         checkNotEmpty(resourceAssignment.dictionarySource) {
 181             "resource assignment dictionary source is not defined for template key (${resourceAssignment.name})"
 182         }
 183     }
 184
 185     override suspend fun recoverNB(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
 186         raRuntimeService.getBluePrintError().addError(runtimeException.message!!)
 187     }
 188 }