Templating constants added to ResourceAssignment
[ccsdk/cds.git] / ms / blueprintsprocessor / functions / resource-resolution / src / main / kotlin / org / onap / ccsdk / cds / blueprintsprocessor / functions / resource / resolution / processor / ResourceAssignmentProcessor.kt
index 97e2f2c..fb9997c 100644 (file)
@@ -1,6 +1,7 @@
 /*
  *  Copyright © 2018 IBM.
- *  Modifications Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ *  Modifications Copyright © 2017-2019 AT&T, Bell Canada
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor
 
 import com.fasterxml.jackson.databind.JsonNode
-import org.apache.commons.collections.MapUtils
+import com.fasterxml.jackson.databind.node.TextNode
 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceAssignmentRuntimeService
 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
+import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
+import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
+import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BlueprintFunctionNode
-import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintTemplateService
-import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
+import org.onap.ccsdk.cds.controllerblueprints.core.isNullOrMissing
+import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintVelocityTemplateService
 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDefinition
 import org.slf4j.LoggerFactory
-import java.util.*
 
 abstract class ResourceAssignmentProcessor : BlueprintFunctionNode<ResourceAssignment, Boolean> {
 
     private val log = LoggerFactory.getLogger(ResourceAssignmentProcessor::class.java)
 
     lateinit var raRuntimeService: ResourceAssignmentRuntimeService
-    lateinit var resourceDictionaries: MutableMap<String, ResourceDefinition>
+    var resourceDictionaries: MutableMap<String, ResourceDefinition> = hashMapOf()
+    var resourceAssignments: MutableList<ResourceAssignment> = arrayListOf()
 
     var scriptPropertyInstances: MutableMap<String, Any> = hashMapOf()
+    lateinit var scriptType: String
 
     /**
      * This will be called from the scripts to serve instance from runtime to scripts.
@@ -47,69 +52,157 @@ abstract class ResourceAssignmentProcessor : BlueprintFunctionNode<ResourceAssig
             ?: throw BluePrintProcessorException("couldn't get script property instance ($name)")
     }
 
-    open fun getFromInput(resourceAssignment: ResourceAssignment): JsonNode? {
-        var value: JsonNode? = null
+    open fun setFromInput(resourceAssignment: ResourceAssignment): Boolean {
         try {
-            value = raRuntimeService.getInputValue(resourceAssignment.name)
-            ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
+            val value = raRuntimeService.getInputValue(resourceAssignment.name)
+            if (!value.isNullOrMissing()) {
+                log.debug(
+                    "For Resource:(${resourceAssignment.name}) found value:({}) in input-data.",
+                    ResourceAssignmentUtils.getValueToLog(resourceAssignment.property?.metadata, value)
+                )
+                ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
+                return true
+            }
         } catch (e: BluePrintProcessorException) {
             // NoOp - couldn't find value from input
         }
-        return value
+        return false
+    }
+
+    open fun setFromInputKeyDependencies(keys: MutableList<String>, resourceAssignment: ResourceAssignment): Boolean {
+        try {
+            for (dependencyKey in keys) {
+                var value = raRuntimeService.getInputValue(dependencyKey)
+                if (!value.isNullOrMissing()) {
+                    log.debug(
+                        "For Resource:(${resourceAssignment.name}) found value:({}) in input-data under: ($dependencyKey).",
+                        ResourceAssignmentUtils.getValueToLog(resourceAssignment.property?.metadata, value)
+                    )
+                    ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
+                    return true
+                }
+            }
+        } catch (e: BluePrintProcessorException) {
+            // NoOp - couldn't find value from input
+        }
+        return false
+    }
+
+    open fun resourceDefinition(name: String): ResourceDefinition? {
+        return if (resourceDictionaries.containsKey(name)) resourceDictionaries[name] else null
     }
 
-    open fun resourceDefinition(name: String): ResourceDefinition {
-        return resourceDictionaries[name]
-            ?: throw BluePrintProcessorException("couldn't get resource definition for ($name)")
+    open fun resolveInputKeyMappingVariables(
+        inputKeyMapping: Map<String, String>,
+        templatingConstants: Map<String, String>?
+    ): Map<String, JsonNode> {
+        val const = templatingConstants?.mapValues { TextNode(it.value) as JsonNode }
+        return inputKeyMapping.mapValues { const?.get(it.value) ?: raRuntimeService.getResolutionStore(it.value) }
     }
 
-    open fun resolveInputKeyMappingVariables(inputKeyMapping: Map<String, String>): Map<String, Any> {
-        val resolvedInputKeyMapping = HashMap<String, Any>()
-        if (MapUtils.isNotEmpty(inputKeyMapping)) {
-            for ((key, value) in inputKeyMapping) {
-                val resultValue = raRuntimeService.getResolutionStore(value)
-                val expressionValue = JacksonUtils.getValue(resultValue)
-                log.trace("Reference dictionary key ({}), value ({})", key, expressionValue)
-                resolvedInputKeyMapping[key] = expressionValue
+    open suspend fun resolveFromInputKeyMapping(valueToResolve: String, keyMapping: MutableMap<String, JsonNode>):
+        String {
+            if (valueToResolve.isEmpty() || !valueToResolve.contains("$")) {
+                return valueToResolve
             }
+            // TODO("Optimize to JSON Node directly without velocity").asJsonNode().toString()
+            return BluePrintVelocityTemplateService.generateContent(valueToResolve, keyMapping.asJsonNode().toString())
         }
-        return resolvedInputKeyMapping
-    }
 
-    open fun resolveFromInputKeyMapping(valueToResolve: String, keyMapping: Map<String, Any>): String {
-        if (valueToResolve.isEmpty() || !valueToResolve.contains("$")) {
-            return valueToResolve
+    final override suspend fun applyNB(resourceAssignment: ResourceAssignment): Boolean {
+        try {
+            processNB(resourceAssignment)
+        } catch (runtimeException: RuntimeException) {
+            log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
+            recoverNB(runtimeException, resourceAssignment)
+            return false
         }
-        return BluePrintTemplateService.generateContent(valueToResolve, additionalContext = keyMapping)
+        return true
     }
 
-    override fun prepareRequest(resourceAssignment: ResourceAssignment): ResourceAssignment {
-        log.info("prepareRequest for ${resourceAssignment.name}, dictionary(${resourceAssignment.dictionaryName})," +
-                "source(${resourceAssignment.dictionarySource})")
-        return resourceAssignment
+    open suspend fun executeScript(resourceAssignment: ResourceAssignment) {
+        return when (scriptType) {
+            BluePrintConstants.SCRIPT_JYTHON -> {
+                executeScriptBlocking(resourceAssignment)
+            }
+            else -> {
+                executeScriptNB(resourceAssignment)
+            }
+        }
     }
 
-    override fun prepareResponse(): Boolean {
-        log.info("Preparing Response...")
-        return true
+    private suspend fun executeScriptNB(resourceAssignment: ResourceAssignment) {
+        try {
+            processNB(resourceAssignment)
+        } catch (runtimeException: RuntimeException) {
+            log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
+            recoverNB(runtimeException, resourceAssignment)
+        }
     }
 
-    override fun apply(resourceAssignment: ResourceAssignment): Boolean {
+    private fun executeScriptBlocking(resourceAssignment: ResourceAssignment) {
         try {
-            prepareRequest(resourceAssignment)
             process(resourceAssignment)
         } catch (runtimeException: RuntimeException) {
+            log.error("failed in ResourceAssignmentProcessor : ${runtimeException.message}", runtimeException)
             recover(runtimeException, resourceAssignment)
         }
-        return prepareResponse()
+    }
+
+    /**
+     * If Jython Script, Override Blocking methods(process() and recover())
+     * If Kotlin or Internal Scripts, Override non blocking methods ( processNB() and recoverNB()), so default
+     * blocking
+     * methods will have default implementation,
+     *
+     * Always applyNB() method will be invoked, apply() won't be called from parent
+     */
+
+    final override fun apply(resourceAssignment: ResourceAssignment): Boolean {
+        throw BluePrintException("Not Implemented, use applyNB method")
+    }
+
+    final override fun prepareRequest(resourceAssignment: ResourceAssignment): ResourceAssignment {
+        throw BluePrintException("Not Implemented required")
+    }
+
+    final override fun prepareResponse(): Boolean {
+        throw BluePrintException("Not Implemented required")
+    }
+
+    final override suspend fun prepareRequestNB(resourceAssignment: ResourceAssignment): ResourceAssignment {
+        throw BluePrintException("Not Implemented required")
+    }
+
+    final override suspend fun prepareResponseNB(): Boolean {
+        throw BluePrintException("Not Implemented required")
+    }
+
+    override fun process(resourceAssignment: ResourceAssignment) {
+        throw BluePrintException("Not Implemented, child class will implement this")
+    }
+
+    override fun recover(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
+        throw BluePrintException("Not Implemented, child class will implement this")
     }
 
     fun addError(type: String, name: String, error: String) {
-        raRuntimeService.getBluePrintError().addError(type, name, error)
+        raRuntimeService.getBluePrintError().addError(type, name, error, getName())
     }
 
     fun addError(error: String) {
-        raRuntimeService.getBluePrintError().addError(error)
+        raRuntimeService.getBluePrintError().addError(error, getName())
     }
 
-}
\ No newline at end of file
+    open fun isTemplateKeyValueNull(resourceAssignment: ResourceAssignment): Boolean {
+        val resourceProp = checkNotNull(resourceAssignment.property) {
+            "Failed to populate mandatory resource resource mapping $resourceAssignment"
+        }
+        if (resourceProp.required != null && resourceProp.required!! &&
+            resourceProp.value.isNullOrMissing()
+        ) {
+            return true
+        }
+        return false
+    }
+}