ms/blueprintsprocessor/modules/services/execution-service/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/services/execution/AbstractComponentFunction.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.services.execution
  19
  20
  21 import com.fasterxml.jackson.databind.JsonNode
  22 import kotlinx.coroutines.withTimeout
  23 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
  24 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceOutput
  25 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.Status
  26 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.StepData
  27 import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType
  28 import org.onap.ccsdk.cds.controllerblueprints.core.*
  29 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BlueprintFunctionNode
  30 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
  31 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintVelocityTemplateService
  32 import org.slf4j.LoggerFactory
  33
  34 /**
  35  * AbstractComponentFunction
  36  * @author Brinda Santh
  37  */
  38 abstract class AbstractComponentFunction : BlueprintFunctionNode<ExecutionServiceInput, ExecutionServiceOutput> {
  39     @Transient
  40     private val log = LoggerFactory.getLogger(AbstractComponentFunction::class.java)
  41
  42     lateinit var executionServiceInput: ExecutionServiceInput
  43     var executionServiceOutput = ExecutionServiceOutput()
  44     lateinit var bluePrintRuntimeService: BluePrintRuntimeService<*>
  45     lateinit var processId: String
  46     lateinit var workflowName: String
  47     lateinit var stepName: String
  48     lateinit var interfaceName: String
  49     lateinit var operationName: String
  50     lateinit var nodeTemplateName: String
  51     var timeout: Int = 180
  52     var operationInputs: MutableMap<String, JsonNode> = hashMapOf()
  53
  54     override fun getName(): String {
  55         return stepName
  56     }
  57
  58     override suspend fun prepareRequestNB(executionRequest: ExecutionServiceInput): ExecutionServiceInput {
  59         checkNotNull(bluePrintRuntimeService) { "failed to prepare blueprint runtime" }
  60         checkNotNull(executionRequest.stepData) { "failed to get step info" }
  61
  62         // Get the Step Name and Step Inputs
  63         this.stepName = executionRequest.stepData!!.name
  64         this.operationInputs = executionRequest.stepData!!.properties
  65
  66         checkNotEmpty(stepName) { "failed to get step name from step data" }
  67
  68         this.executionServiceInput = executionRequest
  69
  70         processId = executionRequest.commonHeader.requestId
  71         check(processId.isNotEmpty()) { "couldn't get process id for step($stepName)" }
  72
  73         workflowName = executionRequest.actionIdentifiers.actionName
  74         check(workflowName.isNotEmpty()) { "couldn't get action name for step($stepName)" }
  75
  76         log.info("preparing request id($processId) for workflow($workflowName) step($stepName)")
  77
  78         nodeTemplateName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_NODE_TEMPLATE)
  79         check(nodeTemplateName.isNotEmpty()) { "couldn't get NodeTemplate name for step($stepName)" }
  80
  81         interfaceName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_INTERFACE)
  82         check(interfaceName.isNotEmpty()) { "couldn't get Interface name for step($stepName)" }
  83
  84         operationName = this.operationInputs.getAsString(BluePrintConstants.PROPERTY_CURRENT_OPERATION)
  85         check(operationName.isNotEmpty()) { "couldn't get Operation name for step($stepName)" }
  86
  87         val operationResolvedProperties = bluePrintRuntimeService
  88                 .resolveNodeTemplateInterfaceOperationInputs(nodeTemplateName, interfaceName, operationName)
  89
  90         this.operationInputs.putAll(operationResolvedProperties)
  91
  92         val timeout = this.operationInputs.getOptionalAsInt(BluePrintConstants.PROPERTY_CURRENT_TIMEOUT)
  93         timeout?.let { this.timeout = timeout }
  94
  95         return executionRequest
  96     }
  97
  98     override suspend fun prepareResponseNB(): ExecutionServiceOutput {
  99         log.info("Preparing Response...")
 100         executionServiceOutput.commonHeader = executionServiceInput.commonHeader
 101         executionServiceOutput.actionIdentifiers = executionServiceInput.actionIdentifiers
 102         var status = Status()
 103         try {
 104             // Resolve the Output Expression
 105             val stepOutputs = bluePrintRuntimeService
 106                     .resolveNodeTemplateInterfaceOperationOutputs(nodeTemplateName, interfaceName, operationName)
 107
 108             val stepOutputData = StepData().apply {
 109                 name = stepName
 110                 properties = stepOutputs
 111             }
 112             executionServiceOutput.stepData = stepOutputData
 113             // Set the Default Step Status
 114             status.eventType = EventType.EVENT_COMPONENT_EXECUTED.name
 115         } catch (e: Exception) {
 116             status.message = BluePrintConstants.STATUS_FAILURE
 117             status.eventType = EventType.EVENT_COMPONENT_FAILURE.name
 118         }
 119         executionServiceOutput.status = status
 120         return this.executionServiceOutput
 121     }
 122
 123     override suspend fun applyNB(executionServiceInput: ExecutionServiceInput): ExecutionServiceOutput {
 124         try {
 125             prepareRequestNB(executionServiceInput)
 126             withTimeout((timeout * 1000).toLong()) {
 127                 processNB(executionServiceInput)
 128             }
 129         } catch (runtimeException: RuntimeException) {
 130             log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
 131             recoverNB(runtimeException, executionServiceInput)
 132         }
 133         return prepareResponseNB()
 134     }
 135
 136     fun getOperationInput(key: String): JsonNode {
 137         return operationInputs[key]
 138                 ?: throw BluePrintProcessorException("couldn't get the operation input($key) value.")
 139     }
 140
 141     fun getOptionalOperationInput(key: String): JsonNode? {
 142         return operationInputs[key]
 143     }
 144
 145     fun setAttribute(key: String, value: JsonNode) {
 146         bluePrintRuntimeService.setNodeTemplateAttributeValue(nodeTemplateName, key, value)
 147     }
 148
 149     fun addError(type: String, name: String, error: String) {
 150         bluePrintRuntimeService.getBluePrintError().addError(type, name, error)
 151     }
 152
 153     fun addError(error: String) {
 154         bluePrintRuntimeService.getBluePrintError().addError(error)
 155     }
 156
 157     fun artifactContent(artifactName: String): String {
 158         return bluePrintRuntimeService.resolveNodeTemplateArtifact(nodeTemplateName, artifactName)
 159     }
 160
 161     suspend fun mashTemplateNData(artifactName: String, json: String): String {
 162         val content = artifactContent(artifactName)
 163         return BluePrintVelocityTemplateService.generateContent(content, json)
 164     }
 165
 166     suspend fun readLinesFromArtifact(artifactName: String): List<String> {
 167         val artifactDefinition = bluePrintRuntimeService.resolveNodeTemplateArtifactDefinition(nodeTemplateName, artifactName)
 168         val file = normalizedFile(bluePrintRuntimeService.bluePrintContext().rootPath, artifactDefinition.file)
 169         return file.readNBLines()
 170     }
 171
 172 }