gerrit.onap Code Review - ccsdk/cds.git/blob

   1 /*\r
   2  *  Copyright © 2017-2018 AT&T Intellectual Property.\r
   3  *  Modifications Copyright © 2019 IBM.\r
   4  *\r
   5  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   6  *  you may not use this file except in compliance with the License.\r
   7  *  You may obtain a copy of the License at\r
   8  *\r
   9  *      http://www.apache.org/licenses/LICENSE-2.0\r
  10  *\r
  11  *  Unless required by applicable law or agreed to in writing, software\r
  12  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14  *  See the License for the specific language governing permissions and\r
  15  *  limitations under the License.\r
  16  */\r
  17 \r
  18 package org.onap.ccsdk.apps.blueprintsprocessor.services.execution\r
  19 \r
  20 \r
  21 import com.fasterxml.jackson.databind.JsonNode\r
  22 import com.fasterxml.jackson.databind.node.JsonNodeFactory\r
  23 import org.onap.ccsdk.apps.blueprintsprocessor.core.api.data.ExecutionServiceInput\r
  24 import org.onap.ccsdk.apps.blueprintsprocessor.core.api.data.ExecutionServiceOutput\r
  25 import org.onap.ccsdk.apps.blueprintsprocessor.core.api.data.Status\r
  26 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintConstants\r
  27 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintProcessorException\r
  28 import org.onap.ccsdk.apps.controllerblueprints.core.asJsonNode\r
  29 import org.onap.ccsdk.apps.controllerblueprints.core.getAsString\r
  30 import org.onap.ccsdk.apps.controllerblueprints.core.interfaces.BlueprintFunctionNode\r
  31 import org.onap.ccsdk.apps.controllerblueprints.core.service.BluePrintRuntimeService\r
  32 import org.slf4j.LoggerFactory\r
  33 \r
  34 /**\r
  35  * AbstractComponentFunction\r
  36  * @author Brinda Santh\r
  37  */\r
  38 abstract class AbstractComponentFunction : BlueprintFunctionNode<ExecutionServiceInput, ExecutionServiceOutput> {\r
  39     @Transient\r
  40     private val log = LoggerFactory.getLogger(AbstractComponentFunction::class.java)\r
  41 \r
  42     lateinit var executionServiceInput: ExecutionServiceInput\r
  43     var executionServiceOutput = ExecutionServiceOutput()\r
  44     lateinit var bluePrintRuntimeService: BluePrintRuntimeService<*>\r
  45     lateinit var processId: String\r
  46     lateinit var workflowName: String\r
  47     lateinit var stepName: String\r
  48     lateinit var interfaceName: String\r
  49     lateinit var operationName: String\r
  50     lateinit var nodeTemplateName: String\r
  51     var operationInputs: MutableMap<String, JsonNode> = hashMapOf()\r
  52     /**\r
  53      * Store Dynamic Dependency Instances\r
  54      */\r
  55     var functionDependencyInstances: MutableMap<String, Any> = hashMapOf()\r
  56 \r
  57     override fun getName(): String {\r
  58         return stepName\r
  59     }\r
  60 \r
  61     override fun prepareRequest(executionRequest: ExecutionServiceInput): ExecutionServiceInput {\r
  62         checkNotNull(bluePrintRuntimeService) { "failed to prepare blueprint runtime" }\r
  63 \r
  64         check(stepName.isNotEmpty()) { "failed to assign step name" }\r
  65 \r
  66         this.executionServiceInput = executionRequest\r
  67 \r
  68         processId = executionRequest.commonHeader.requestId\r
  69         check(processId.isNotEmpty()) { "couldn't get process id for step($stepName)" }\r
  70 \r
  71         workflowName = executionRequest.actionIdentifiers.actionName\r
  72         check(workflowName.isNotEmpty()) { "couldn't get action name for step($stepName)" }\r
  73 \r
  74         log.info("preparing request id($processId) for workflow($workflowName) step($stepName)")\r
  75 \r
  76         val operationInputs = bluePrintRuntimeService.get("$stepName-step-inputs")\r
  77                 ?: JsonNodeFactory.instance.objectNode()\r
  78 \r
  79         operationInputs.fields().forEach {\r
  80             this.operationInputs[it.key] = it.value\r
  81         }\r
  82 \r
  83         nodeTemplateName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_NODE_TEMPLATE)\r
  84         check(nodeTemplateName.isNotEmpty()) { "couldn't get NodeTemplate name for step($stepName)" }\r
  85 \r
  86         interfaceName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_INTERFACE)\r
  87         check(interfaceName.isNotEmpty()) { "couldn't get Interface name for step($stepName)" }\r
  88 \r
  89         operationName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_OPERATION)\r
  90         check(operationName.isNotEmpty()) { "couldn't get Operation name for step($stepName)" }\r
  91 \r
  92         val operationResolvedProperties = bluePrintRuntimeService.resolveNodeTemplateInterfaceOperationInputs(nodeTemplateName, interfaceName, operationName)\r
  93 \r
  94         this.operationInputs.putAll(operationResolvedProperties)\r
  95 \r
  96         return executionRequest\r
  97     }\r
  98 \r
  99     override fun prepareResponse(): ExecutionServiceOutput {\r
 100         log.info("Preparing Response...")\r
 101         executionServiceOutput.commonHeader = executionServiceInput.commonHeader\r
 102         executionServiceOutput.actionIdentifiers = executionServiceInput.actionIdentifiers\r
 103         executionServiceOutput.payload = executionServiceInput.payload\r
 104 \r
 105         // Resolve the Output Expression\r
 106         val stepOutputs = bluePrintRuntimeService\r
 107                 .resolveNodeTemplateInterfaceOperationOutputs(nodeTemplateName, interfaceName, operationName)\r
 108 \r
 109         bluePrintRuntimeService.put("$stepName-step-outputs", stepOutputs.asJsonNode())\r
 110 \r
 111         // Populate Status\r
 112         val status = Status()\r
 113         status.eventType = "EVENT-COMPONENT-EXECUTED"\r
 114         status.code = 200\r
 115         status.message = BluePrintConstants.STATUS_SUCCESS\r
 116         executionServiceOutput.status = status\r
 117         return this.executionServiceOutput\r
 118     }\r
 119 \r
 120     override fun apply(executionServiceInput: ExecutionServiceInput): ExecutionServiceOutput {\r
 121         prepareRequest(executionServiceInput)\r
 122         process(executionServiceInput)\r
 123         return prepareResponse()\r
 124     }\r
 125 \r
 126     fun getOperationInput(key: String): JsonNode {\r
 127         return operationInputs[key]\r
 128                 ?: throw BluePrintProcessorException("couldn't get the operation input($key) value.")\r
 129     }\r
 130 \r
 131     fun setAttribute(key: String, value: JsonNode) {\r
 132         bluePrintRuntimeService.setNodeTemplateAttributeValue(nodeTemplateName, key, value)\r
 133     }\r
 134 \r
 135     /**\r
 136      * This will be called from the scripts to serve instance from runtime to scripts.\r
 137      */\r
 138     open fun <T> functionDependencyInstanceAsType(name: String): T {\r
 139         return functionDependencyInstances[name] as? T\r
 140                 ?: throw BluePrintProcessorException("couldn't get script property instance ($name)")\r
 141     }\r
 142 }