ms/blueprintsprocessor/functions/python-executor/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/python/executor/ComponentRemotePythonExecutor.kt

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.functions.python.executor
  18
  19 import com.fasterxml.jackson.databind.JsonNode
  20 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.*
  21 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractComponentFunction
  22 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.ExecutionServiceConstant
  23 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.RemoteScriptExecutionService
  24 import org.onap.ccsdk.cds.controllerblueprints.core.*
  25 import org.onap.ccsdk.cds.controllerblueprints.core.data.OperationAssignment
  26 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  27 import org.slf4j.LoggerFactory
  28 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  29 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean
  30 import org.springframework.context.annotation.Scope
  31 import org.springframework.stereotype.Component
  32
  33 @ConditionalOnBean(name = [ExecutionServiceConstant.SERVICE_GRPC_REMOTE_SCRIPT_EXECUTION])
  34 @Component("component-remote-python-executor")
  35 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  36 open class ComponentRemotePythonExecutor(private val remoteScriptExecutionService: RemoteScriptExecutionService)
  37     : AbstractComponentFunction() {
  38
  39     private val log = LoggerFactory.getLogger(ComponentRemotePythonExecutor::class.java)!!
  40
  41     companion object {
  42         const val INPUT_ENDPOINT_SELECTOR = "endpoint-selector"
  43         const val INPUT_DYNAMIC_PROPERTIES = "dynamic-properties"
  44         const val INPUT_ARGUMENT_PROPERTIES = "argument-properties"
  45         const val INPUT_COMMAND = "command"
  46         const val INPUT_PACKAGES = "packages"
  47         const val DEFAULT_SELECTOR = "remote-python"
  48
  49         const val ATTRIBUTE_PREPARE_ENV_LOG = "prepare-environment-logs"
  50         const val ATTRIBUTE_EXEC_CMD_LOG = "execute-command-logs"
  51         const val ATTRIBUTE_RESPONSE_DATA = "response-data"
  52     }
  53
  54     override suspend fun processNB(executionRequest: ExecutionServiceInput) {
  55
  56         log.info("Processing : $operationInputs")
  57
  58         val bluePrintContext = bluePrintRuntimeService.bluePrintContext()
  59         val blueprintName = bluePrintContext.name()
  60         val blueprintVersion = bluePrintContext.version()
  61
  62         val operationAssignment: OperationAssignment = bluePrintContext
  63             .nodeTemplateInterfaceOperation(nodeTemplateName, interfaceName, operationName)
  64
  65         val artifactName: String = operationAssignment.implementation?.primary
  66             ?: throw BluePrintProcessorException("missing primary field to get artifact name for node template ($nodeTemplateName)")
  67
  68         val artifactDefinition =
  69             bluePrintRuntimeService.resolveNodeTemplateArtifactDefinition(nodeTemplateName, artifactName)
  70
  71         checkNotBlank(artifactDefinition.file) { "couldn't get python script path($artifactName)" }
  72
  73         val pythonScript = normalizedFile(bluePrintContext.rootPath, artifactDefinition.file)
  74
  75         checkFileExists(pythonScript) { "python script(${pythonScript.absolutePath}) doesn't exists" }
  76
  77         val endPointSelector = getOperationInput(INPUT_ENDPOINT_SELECTOR)
  78         val dynamicProperties = getOptionalOperationInput(INPUT_DYNAMIC_PROPERTIES)
  79         val packages = getOptionalOperationInput(INPUT_PACKAGES)?.returnNullIfMissing()
  80
  81         val argsNode = getOptionalOperationInput(INPUT_ARGUMENT_PROPERTIES)?.returnNullIfMissing()
  82
  83         // This prevents unescaping values, as well as quoting the each parameter, in order to allow for spaces in values
  84         val args = getOptionalOperationInput(INPUT_ARGUMENT_PROPERTIES)?.returnNullIfMissing()
  85             ?.rootFieldsToMap()?.toSortedMap()?.values?.joinToString(" ") { formatNestedJsonNode(it) }
  86
  87         val command = getOperationInput(INPUT_COMMAND).asText()
  88         var scriptCommand = command.replace(pythonScript.name, pythonScript.absolutePath)
  89         if (args != null && args.isNotEmpty()) {
  90             scriptCommand = scriptCommand.plus(" ").plus(args)
  91         }
  92
  93         try {
  94             // Open GRPC Connection
  95             if (DEFAULT_SELECTOR == endPointSelector.asText()) {
  96                 remoteScriptExecutionService.init(endPointSelector.asText())
  97             } else {
  98                 // Get endpoint from DSL
  99                 val endPointSelectorJson = bluePrintRuntimeService.resolveDSLExpression(endPointSelector.asText())
 100                 remoteScriptExecutionService.init(endPointSelectorJson)
 101             }
 102
 103             // If packages are defined, then install in remote server
 104             if (packages != null) {
 105                 val prepareEnvInput = PrepareRemoteEnvInput(requestId = processId,
 106                     remoteIdentifier = RemoteIdentifier(blueprintName = blueprintName,
 107                         blueprintVersion = blueprintVersion),
 108                     packages = packages
 109                 )
 110                 val prepareEnvOutput = remoteScriptExecutionService.prepareEnv(prepareEnvInput)
 111                 log.info("$ATTRIBUTE_PREPARE_ENV_LOG - ${prepareEnvOutput.response}")
 112                 setAttribute(ATTRIBUTE_PREPARE_ENV_LOG, JacksonUtils.jsonNodeFromObject(prepareEnvOutput.response))
 113                 setAttribute(ATTRIBUTE_EXEC_CMD_LOG, "N/A".asJsonPrimitive())
 114                 check(prepareEnvOutput.status == StatusType.SUCCESS) {
 115                     "failed to get prepare remote env response status for requestId(${prepareEnvInput.requestId})"
 116                 }
 117             }
 118             // Populate command execution properties and pass it to the remote server
 119             val properties = dynamicProperties?.returnNullIfMissing()?.rootFieldsToMap() ?: hashMapOf()
 120
 121             val remoteExecutionInput = RemoteScriptExecutionInput(
 122                 requestId = processId,
 123                 remoteIdentifier = RemoteIdentifier(blueprintName = blueprintName, blueprintVersion = blueprintVersion),
 124                 command = scriptCommand,
 125                 properties = properties)
 126             val remoteExecutionOutput = remoteScriptExecutionService.executeCommand(remoteExecutionInput)
 127             log.info("$ATTRIBUTE_EXEC_CMD_LOG  - ${remoteExecutionOutput.response}")
 128             setAttribute(ATTRIBUTE_EXEC_CMD_LOG, JacksonUtils.jsonNodeFromObject(remoteExecutionOutput.response))
 129             check(remoteExecutionOutput.status == StatusType.SUCCESS) {
 130                 "failed to get prepare remote command response status for requestId(${remoteExecutionOutput.requestId})"
 131             }
 132
 133         } catch (e: Exception) {
 134             log.error("Failed to process on remote executor", e)
 135         } finally {
 136             remoteScriptExecutionService.close()
 137         }
 138     }
 139
 140     override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) {
 141         bluePrintRuntimeService.getBluePrintError()
 142             .addError("Failed in ComponentJythonExecutor : ${runtimeException.message}")
 143     }
 144
 145     private fun formatNestedJsonNode(node: JsonNode): String {
 146         val sb = StringBuilder()
 147         if (node.isValueNode) {
 148             sb.append(" $node")
 149         } else {
 150             node.forEach { sb.append(" $it") }
 151         }
 152         return sb.toString()
 153     }
 154 }