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

   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 org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.*
  20 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.AbstractComponentFunction
  21 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.ExecutionServiceConstant
  22 import org.onap.ccsdk.cds.blueprintsprocessor.services.execution.RemoteScriptExecutionService
  23 import org.onap.ccsdk.cds.controllerblueprints.command.api.ResponseStatus
  24 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  25 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
  26 import org.onap.ccsdk.cds.controllerblueprints.core.checkFileExists
  27 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotBlank
  28 import org.onap.ccsdk.cds.controllerblueprints.core.data.OperationAssignment
  29 import org.onap.ccsdk.cds.controllerblueprints.core.normalizedFile
  30 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  31 import org.slf4j.LoggerFactory
  32 import org.springframework.beans.factory.config.ConfigurableBeanFactory
  33 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean
  34 import org.springframework.context.annotation.Scope
  35 import org.springframework.stereotype.Component
  36 import java.lang.Exception
  37
  38 @ConditionalOnBean(name = [ExecutionServiceConstant.SERVICE_GRPC_REMOTE_SCRIPT_EXECUTION])
  39 @Component("component-remote-python-executor")
  40 @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
  41 open class ComponentRemotePythonExecutor(private val remoteScriptExecutionService: RemoteScriptExecutionService)
  42     : AbstractComponentFunction() {
  43
  44     private val log = LoggerFactory.getLogger(ComponentRemotePythonExecutor::class.java)!!
  45
  46     companion object {
  47         const val INPUT_ENDPOINT_SELECTOR = "endpoint-selector"
  48         const val INPUT_DYNAMIC_PROPERTIES = "dynamic-properties"
  49     }
  50
  51     override suspend fun processNB(executionRequest: ExecutionServiceInput) {
  52
  53         log.info("Processing : $operationInputs")
  54
  55         val bluePrintContext = bluePrintRuntimeService.bluePrintContext()
  56         val blueprintName = bluePrintContext.name()
  57         val blueprintVersion = bluePrintContext.version()
  58
  59         val operationAssignment: OperationAssignment = bluePrintContext
  60             .nodeTemplateInterfaceOperation(nodeTemplateName, interfaceName, operationName)
  61
  62         val artifactName: String = operationAssignment.implementation?.primary
  63             ?: throw BluePrintProcessorException("missing primary field to get artifact name for node template ($nodeTemplateName)")
  64
  65         val artifactDefinition =
  66             bluePrintRuntimeService.resolveNodeTemplateArtifactDefinition(nodeTemplateName, artifactName)
  67
  68         checkNotBlank(artifactDefinition.file) { "couldn't get python script path($artifactName)" }
  69
  70         val pythonScript = normalizedFile(bluePrintContext.rootPath, artifactDefinition.file)
  71
  72         checkFileExists(pythonScript) { "python script(${pythonScript.absolutePath}) doesn't exists" }
  73
  74         val endPointSelector = getOperationInput(INPUT_ENDPOINT_SELECTOR)
  75         val dynamicProperties = getOperationInput(INPUT_DYNAMIC_PROPERTIES)
  76
  77         // TODO("Python execution command and Resolve some expressions with dynamic properties")
  78         val scriptCommand = pythonScript.absolutePath
  79
  80         val dependencies = operationAssignment.implementation?.dependencies
  81
  82         try {
  83             // Open GRPC Connection
  84             remoteScriptExecutionService.init(endPointSelector.asText())
  85
  86             var executionLogs = ""
  87
  88             // If dependencies are defined, then install in remote server
  89             if (dependencies != null && dependencies.isNotEmpty()) {
  90                 val prepareEnvInput = PrepareRemoteEnvInput(requestId = processId,
  91                     remoteIdentifier = RemoteIdentifier(blueprintName = blueprintName,
  92                         blueprintVersion = blueprintVersion),
  93                     remoteScriptType = RemoteScriptType.PYTHON,
  94                     packages = dependencies
  95                 )
  96                 val prepareEnvOutput = remoteScriptExecutionService.prepareEnv(prepareEnvInput)
  97                 executionLogs = prepareEnvOutput.response
  98                 setOutput(executionLogs)
  99                 check(prepareEnvOutput.status == StatusType.SUCCESS) {
 100                     "failed to get prepare remote env response status for requestId(${prepareEnvInput.requestId})"
 101                 }
 102             }
 103
 104             val remoteExecutionInput = RemoteScriptExecutionInput(
 105                 requestId = processId,
 106                 remoteIdentifier = RemoteIdentifier(blueprintName = blueprintName, blueprintVersion = blueprintVersion),
 107                 remoteScriptType = RemoteScriptType.PYTHON,
 108                 command = scriptCommand)
 109             val remoteExecutionOutput = remoteScriptExecutionService.executeCommand(remoteExecutionInput)
 110             executionLogs += remoteExecutionOutput.response
 111             setOutput(executionLogs)
 112             check(remoteExecutionOutput.status == StatusType.SUCCESS) {
 113                 "failed to get prepare remote command response status for requestId(${remoteExecutionOutput.requestId})"
 114             }
 115
 116         } catch (e: Exception) {
 117             log.error("", e)
 118         } finally {
 119             remoteScriptExecutionService.close()
 120         }
 121     }
 122
 123     private fun setOutput(executionLogs: String) {
 124         bluePrintRuntimeService.setNodeTemplateAttributeValue(nodeTemplateName,
 125             "execution-logs", JacksonUtils.jsonNodeFromObject(executionLogs))
 126     }
 127
 128     override suspend fun recoverNB(runtimeException: RuntimeException, executionRequest: ExecutionServiceInput) {
 129         bluePrintRuntimeService.getBluePrintError()
 130             .addError("Failed in ComponentJythonExecutor : ${runtimeException.message}")
 131     }
 132 }