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

   1 /*
   2  * Copyright © 2017-2018 AT&T Intellectual Property.
   3  * Modifications Copyright © 2019 IBM.
   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
  19
  20 import com.fasterxml.jackson.databind.JsonNode
  21 import com.fasterxml.jackson.databind.node.JsonNodeFactory
  22 import com.fasterxml.jackson.databind.node.ObjectNode
  23 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
  24 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractComponentFunction
  25 import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintProcessorException
  26 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
  27 import org.onap.ccsdk.cds.controllerblueprints.core.asObjectNode
  28 import org.onap.ccsdk.cds.controllerblueprints.core.returnNullIfMissing
  29 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  30 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  31 import org.springframework.context.annotation.Scope
  32 import org.springframework.stereotype.Component
  33
  34 @Component("component-resource-resolution")
  35 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  36 open class ResourceResolutionComponent(private val resourceResolutionService: ResourceResolutionService) :
  37     AbstractComponentFunction() {
  38
  39     companion object {
  40
  41         const val INPUT_REQUEST_ID = "request-id"
  42         const val INPUT_RESOURCE_ID = "resource-id"
  43         const val INPUT_ACTION_NAME = "action-name"
  44         const val INPUT_DYNAMIC_PROPERTIES = "dynamic-properties"
  45         const val INPUT_RESOURCE_TYPE = "resource-type"
  46         const val INPUT_ARTIFACT_PREFIX_NAMES = "artifact-prefix-names"
  47         const val INPUT_RESOLUTION_KEY = "resolution-key"
  48         const val INPUT_RESOLUTION_SUMMARY = "resolution-summary"
  49         const val INPUT_STORE_RESULT = "store-result"
  50         const val INPUT_OCCURRENCE = "occurrence"
  51
  52         const val ATTRIBUTE_ASSIGNMENT_PARAM = "assignment-params"
  53         const val ATTRIBUTE_STATUS = "status"
  54
  55         const val OUTPUT_RESOURCE_ASSIGNMENT_PARAMS = "resource-assignment-params"
  56         const val OUTPUT_RESOURCE_ASSIGNMENT_MAP = "resource-assignment-map"
  57         const val OUTPUT_STATUS = "status"
  58     }
  59
  60     override suspend fun processNB(executionRequest: ExecutionServiceInput) {
  61
  62         val occurrence = getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE)?.asInt() ?: 1
  63         val resolutionKey =
  64             getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_KEY)?.returnNullIfMissing()?.textValue() ?: ""
  65         val storeResult = getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT)?.asBoolean() ?: false
  66         val resourceId =
  67             getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_ID)?.returnNullIfMissing()?.textValue() ?: ""
  68
  69         val resourceType =
  70             getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_TYPE)?.returnNullIfMissing()?.textValue() ?: ""
  71         val resolutionSummary =
  72             getOptionalOperationInput(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_SUMMARY)?.asBoolean() ?: false
  73
  74         val properties: MutableMap<String, Any> = mutableMapOf()
  75         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT] = storeResult
  76         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_KEY] = resolutionKey
  77         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_ID] = resourceId
  78         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_TYPE] = resourceType
  79         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE] = occurrence
  80         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_SUMMARY] = resolutionSummary
  81
  82         val jsonResponse = JsonNodeFactory.instance.objectNode()
  83         val assignmentMap = JsonNodeFactory.instance.objectNode()
  84         // Initialize Output Attributes to empty JSON
  85         bluePrintRuntimeService.setNodeTemplateAttributeValue(
  86             nodeTemplateName,
  87             ResourceResolutionConstants.OUTPUT_ASSIGNMENT_PARAMS, jsonResponse
  88         )
  89         bluePrintRuntimeService.setNodeTemplateAttributeValue(
  90             nodeTemplateName,
  91             ResourceResolutionConstants.OUTPUT_ASSIGNMENT_MAP, assignmentMap
  92         )
  93
  94         // validate inputs if we need to store the resource and template resolution.
  95         if (storeResult) {
  96             if (resolutionKey.isNotEmpty() && (resourceId.isNotEmpty() || resourceType.isNotEmpty())) {
  97                 throw BlueprintProcessorException("Can't proceed with the resolution: either provide resolution-key OR combination of resource-id and resource-type.")
  98             } else if ((resourceType.isNotEmpty() && resourceId.isEmpty()) || (resourceType.isEmpty() && resourceId.isNotEmpty())) {
  99                 throw BlueprintProcessorException("Can't proceed with the resolution: both resource-id and resource-type should be provided, one of them is missing.")
 100             } else if (resourceType.isEmpty() && resourceId.isEmpty() && resolutionKey.isEmpty()) {
 101                 throw BlueprintProcessorException(
 102                     "Can't proceed with the resolution: can't persist resolution without a correlation key. " +
 103                         "Either provide a resolution-key OR combination of resource-id and resource-type OR set `storeResult` to false."
 104                 )
 105             }
 106         }
 107
 108         val artifactPrefixNamesNode = getOperationInput(ResourceResolutionConstants.INPUT_ARTIFACT_PREFIX_NAMES)
 109         val artifactPrefixNames = JacksonUtils.getListFromJsonNode(artifactPrefixNamesNode, String::class.java)
 110
 111         for (j in 1..occurrence) {
 112             properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE] = j
 113
 114             val result = resourceResolutionService.resolveResources(
 115                 bluePrintRuntimeService,
 116                 nodeTemplateName,
 117                 artifactPrefixNames,
 118                 properties
 119             )
 120
 121             // provide indexed result in output if we have multiple resolution
 122             if (occurrence != 1) {
 123                 jsonResponse.set<JsonNode>(j.toString(), result.templateMap.asJsonNode())
 124                 assignmentMap.set<JsonNode>(j.toString(), result.assignmentMap.asJsonNode())
 125             } else {
 126                 jsonResponse.setAll<ObjectNode>(result.templateMap.asObjectNode())
 127                 assignmentMap.setAll<ObjectNode>(result.assignmentMap.asObjectNode())
 128             }
 129         }
 130
 131         // Set Output Attributes with resolved value
 132         bluePrintRuntimeService.setNodeTemplateAttributeValue(
 133             nodeTemplateName,
 134             ResourceResolutionConstants.OUTPUT_ASSIGNMENT_PARAMS, jsonResponse
 135         )
 136         bluePrintRuntimeService.setNodeTemplateAttributeValue(
 137             nodeTemplateName,
 138             ResourceResolutionConstants.OUTPUT_ASSIGNMENT_MAP, assignmentMap
 139         )
 140     }
 141
 142     override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) {
 143         bluePrintRuntimeService.getBlueprintError().addError(runtimeException.message!!)
 144     }
 145 }