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.common.api.EventType\r
  27 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintConstants\r
  28 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintProcessorException\r
  29 import org.onap.ccsdk.apps.controllerblueprints.core.asObjectNode\r
  30 import org.onap.ccsdk.apps.controllerblueprints.core.getAsString\r
  31 import org.onap.ccsdk.apps.controllerblueprints.core.interfaces.BlueprintFunctionNode\r
  32 import org.onap.ccsdk.apps.controllerblueprints.core.service.BluePrintRuntimeService\r
  33 import org.slf4j.LoggerFactory\r
  34 \r
  35 /**\r
  36  * AbstractComponentFunction\r
  37  * @author Brinda Santh\r
  38  */\r
  39 abstract class AbstractComponentFunction : BlueprintFunctionNode<ExecutionServiceInput, ExecutionServiceOutput> {\r
  40     @Transient\r
  41     private val log = LoggerFactory.getLogger(AbstractComponentFunction::class.java)\r
  42 \r
  43     lateinit var executionServiceInput: ExecutionServiceInput\r
  44     var executionServiceOutput = ExecutionServiceOutput()\r
  45     lateinit var bluePrintRuntimeService: BluePrintRuntimeService<*>\r
  46     lateinit var processId: String\r
  47     lateinit var workflowName: String\r
  48     lateinit var stepName: String\r
  49     lateinit var interfaceName: String\r
  50     lateinit var operationName: String\r
  51     lateinit var nodeTemplateName: String\r
  52     var operationInputs: MutableMap<String, JsonNode> = hashMapOf()\r
  53 \r
  54     //FIXME("Move to Script abstract class")\r
  55     /**\r
  56      * Store Dynamic Script Dependency Instances, Objects present inside won't be persisted or state maintained.\r
  57      * Later it will be moved to ScriptComponentFunction class, sub class for abstract class\r
  58      */\r
  59     var functionDependencyInstances: MutableMap<String, Any> = hashMapOf()\r
  60 \r
  61     override fun getName(): String {\r
  62         return stepName\r
  63     }\r
  64 \r
  65     override fun prepareRequest(executionRequest: ExecutionServiceInput): ExecutionServiceInput {\r
  66         checkNotNull(bluePrintRuntimeService) { "failed to prepare blueprint runtime" }\r
  67 \r
  68         check(stepName.isNotEmpty()) { "failed to assign step name" }\r
  69 \r
  70         this.executionServiceInput = executionRequest\r
  71 \r
  72         processId = executionRequest.commonHeader.requestId\r
  73         check(processId.isNotEmpty()) { "couldn't get process id for step($stepName)" }\r
  74 \r
  75         workflowName = executionRequest.actionIdentifiers.actionName\r
  76         check(workflowName.isNotEmpty()) { "couldn't get action name for step($stepName)" }\r
  77 \r
  78         log.info("preparing request id($processId) for workflow($workflowName) step($stepName)")\r
  79 \r
  80         val operationInputs = bluePrintRuntimeService.get("$stepName-step-inputs")\r
  81                 ?: JsonNodeFactory.instance.objectNode()\r
  82 \r
  83         operationInputs.fields().forEach {\r
  84             this.operationInputs[it.key] = it.value\r
  85         }\r
  86 \r
  87         nodeTemplateName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_NODE_TEMPLATE)\r
  88         check(nodeTemplateName.isNotEmpty()) { "couldn't get NodeTemplate name for step($stepName)" }\r
  89 \r
  90         interfaceName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_INTERFACE)\r
  91         check(interfaceName.isNotEmpty()) { "couldn't get Interface name for step($stepName)" }\r
  92 \r
  93         operationName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_OPERATION)\r
  94         check(operationName.isNotEmpty()) { "couldn't get Operation name for step($stepName)" }\r
  95 \r
  96         val operationResolvedProperties = bluePrintRuntimeService\r
  97                 .resolveNodeTemplateInterfaceOperationInputs(nodeTemplateName, interfaceName, operationName)\r
  98 \r
  99         this.operationInputs.putAll(operationResolvedProperties)\r
 100 \r
 101         return executionRequest\r
 102     }\r
 103 \r
 104     override fun prepareResponse(): ExecutionServiceOutput {\r
 105         log.info("Preparing Response...")\r
 106         executionServiceOutput.commonHeader = executionServiceInput.commonHeader\r
 107         executionServiceOutput.actionIdentifiers = executionServiceInput.actionIdentifiers\r
 108 \r
 109         // Resolve the Output Expression\r
 110         val stepOutputs = bluePrintRuntimeService\r
 111                 .resolveNodeTemplateInterfaceOperationOutputs(nodeTemplateName, interfaceName, operationName)\r
 112 \r
 113         // FIXME("Not the right place to populate the response payload")\r
 114         executionServiceOutput.payload = stepOutputs.asObjectNode()\r
 115 \r
 116         bluePrintRuntimeService.put("$stepName-step-outputs", executionServiceOutput.payload)\r
 117 \r
 118         // FIXME("Not the right place to populate the status")\r
 119         // Populate Status\r
 120         val status = Status()\r
 121         status.eventType = EventType.EVENT_COMPONENT_EXECUTED.name\r
 122         status.code = 200\r
 123         status.message = BluePrintConstants.STATUS_SUCCESS\r
 124         executionServiceOutput.status = status\r
 125         return this.executionServiceOutput\r
 126     }\r
 127 \r
 128     override fun apply(executionServiceInput: ExecutionServiceInput): ExecutionServiceOutput {\r
 129         try {\r
 130             prepareRequest(executionServiceInput)\r
 131             process(executionServiceInput)\r
 132         } catch (runtimeException: RuntimeException) {\r
 133             recover(runtimeException, executionServiceInput)\r
 134         }\r
 135         return prepareResponse()\r
 136     }\r
 137 \r
 138     fun getOperationInput(key: String): JsonNode {\r
 139         return operationInputs[key]\r
 140                 ?: throw BluePrintProcessorException("couldn't get the operation input($key) value.")\r
 141     }\r
 142 \r
 143     fun setAttribute(key: String, value: JsonNode) {\r
 144         bluePrintRuntimeService.setNodeTemplateAttributeValue(nodeTemplateName, key, value)\r
 145     }\r
 146 \r
 147     //FIXME("Move to Script abstract class")\r
 148     /**\r
 149      * This will be called from the scripts to serve instance from runtime to scripts.\r
 150      */\r
 151     open fun <T> functionDependencyInstanceAsType(name: String): T {\r
 152         return functionDependencyInstances[name] as? T\r
 153                 ?: throw BluePrintProcessorException("couldn't get script property instance ($name)")\r
 154     }\r
 155 }