blueprint scripting module

Change-Id: Ibe7602bdb6708d9adbe1aecd26eb14e24872f75d
Issue-ID: CCSDK-941
Signed-off-by: Muthuramalingam, Brinda Santh <bs2796@att.com>

4 files changed, 359 insertions, 0 deletions

diff --git a/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompiledScript.kt b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompiledScript.kt
new file mode 100644
index 00000000..8ac915bd
--- /dev/null
+++ b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompiledScript.kt
@@ -0,0 +1,56 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onap.ccsdk.apps.controllerblueprints.scripts
+
+import java.io.File
+import java.io.Serializable
+import java.net.URL
+import java.net.URLClassLoader
+import kotlin.reflect.KClass
+import kotlin.script.experimental.api.*
+
+open class BluePrintCompiledScript<out JarFile : File>(
+        private val scriptCompilationConfiguration: ScriptCompilationConfiguration,
+        private val compiledJar: File) :
+        CompiledScript<JarFile>, Serializable {
+
+    lateinit var scriptClassFQName: String
+
+    override val compilationConfiguration: ScriptCompilationConfiguration
+        get() = scriptCompilationConfiguration
+
+    override suspend fun getClass(scriptEvaluationConfiguration: ScriptEvaluationConfiguration?): ResultWithDiagnostics<KClass<*>> = try {
+
+        val baseClassLoader = Thread.currentThread().contextClassLoader
+
+        val urls = arrayListOf<URL>()
+        urls.add(compiledJar.toURI().toURL())
+        val classLoaderWithDependencies = URLClassLoader(urls.toTypedArray(), baseClassLoader)
+
+        val clazz = classLoaderWithDependencies.loadClass(scriptClassFQName).kotlin
+        clazz.asSuccess()
+    } catch (e: Throwable) {
+        ResultWithDiagnostics.Failure(
+                ScriptDiagnostic(
+                        "Unable to instantiate class $scriptClassFQName",
+                        exception = e
+                )
+        )
+    }
+
+}
+
diff --git a/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompilerProxy.kt b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompilerProxy.kt
new file mode 100644
index 00000000..7e9e8688
--- /dev/null
+++ b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintCompilerProxy.kt
@@ -0,0 +1,150 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onap.ccsdk.apps.controllerblueprints.scripts
+
+import org.jetbrains.kotlin.com.intellij.openapi.util.Disposer
+import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys
+import org.jetbrains.kotlin.cli.common.config.addKotlinSourceRoots
+import org.jetbrains.kotlin.cli.common.environment.setIdeaIoUseFallback
+import org.jetbrains.kotlin.cli.common.messages.AnalyzerWithCompilerReport
+import org.jetbrains.kotlin.cli.common.messages.CompilerMessageLocation
+import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
+import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+import org.jetbrains.kotlin.cli.jvm.compiler.EnvironmentConfigFiles
+import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
+import org.jetbrains.kotlin.cli.jvm.compiler.KotlinToJVMBytecodeCompiler
+import org.jetbrains.kotlin.cli.jvm.config.JvmClasspathRoot
+import org.jetbrains.kotlin.config.*
+import org.slf4j.LoggerFactory
+import java.io.File
+import kotlin.script.experimental.api.*
+import kotlin.script.experimental.host.ScriptingHostConfiguration
+import kotlin.script.experimental.jvm.util.classpathFromClasspathProperty
+import kotlin.script.experimental.jvmhost.KJvmCompilerProxy
+
+open class BluePrintsCompilerProxy(private val hostConfiguration: ScriptingHostConfiguration) : KJvmCompilerProxy {
+
+    private val log = LoggerFactory.getLogger(BluePrintsCompilerProxy::class.java)!!
+
+    override fun compile(script: SourceCode, scriptCompilationConfiguration: ScriptCompilationConfiguration)
+            : ResultWithDiagnostics<CompiledScript<*>> {
+
+        val messageCollector = ScriptDiagnosticsMessageCollector()
+
+        fun failure(vararg diagnostics: ScriptDiagnostic): ResultWithDiagnostics.Failure =
+                ResultWithDiagnostics.Failure(*messageCollector.diagnostics.toTypedArray(), *diagnostics)
+
+        // Compile the Code
+        try {
+
+            log.trace("Scripting Host Configuration : $hostConfiguration")
+
+            setIdeaIoUseFallback()
+
+            val blueprintSourceCode = script as BluePrintSourceCode
+
+            val compiledJarFile = blueprintSourceCode.targetJarFile
+
+            if (!compiledJarFile.exists() || blueprintSourceCode.regenerate) {
+
+                var environment: KotlinCoreEnvironment? = null
+
+                val rootDisposable = Disposer.newDisposable()
+
+                val compilerConfiguration = CompilerConfiguration().apply {
+
+                    put(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, messageCollector)
+                    put(CommonConfigurationKeys.MODULE_NAME, blueprintSourceCode.moduleName)
+                    put(JVMConfigurationKeys.OUTPUT_JAR, compiledJarFile)
+                    put(JVMConfigurationKeys.RETAIN_OUTPUT_IN_MEMORY, false)
+
+                    // Load Current Class loader to Compilation Class loader
+                    val currentClassLoader = classpathFromClasspathProperty()
+                    currentClassLoader?.forEach {
+                        add(CLIConfigurationKeys.CONTENT_ROOTS, JvmClasspathRoot(it))
+                    }
+
+                    // Add all Kotlin Sources
+                    addKotlinSourceRoots(blueprintSourceCode.blueprintKotlinSources)
+
+                    languageVersionSettings = LanguageVersionSettingsImpl(
+                            LanguageVersion.LATEST_STABLE, ApiVersion.LATEST_STABLE, mapOf(AnalysisFlags.skipMetadataVersionCheck to true)
+                    )
+                }
+
+                //log.info("Executing with compiler configuration : $compilerConfiguration")
+
+                environment = KotlinCoreEnvironment.createForProduction(rootDisposable, compilerConfiguration,
+                        EnvironmentConfigFiles.JVM_CONFIG_FILES)
+
+                // Compile Kotlin Sources
+                val compiled = KotlinToJVMBytecodeCompiler.compileBunchOfSources(environment)
+
+                log.info("Generated jar(${compiledJarFile.absolutePath}) status : $compiled}")
+
+                val analyzerWithCompilerReport = AnalyzerWithCompilerReport(messageCollector,
+                        environment.configuration.languageVersionSettings)
+
+                if (analyzerWithCompilerReport.hasErrors()) {
+                    return failure()
+                }
+            }
+
+            val res = BluePrintCompiledScript<File>(scriptCompilationConfiguration, compiledJarFile)
+
+            return ResultWithDiagnostics.Success(res, messageCollector.diagnostics)
+
+        } catch (ex: Throwable) {
+            return failure(ex.asDiagnostics())
+        }
+    }
+}
+
+class ScriptDiagnosticsMessageCollector : MessageCollector {
+
+    private val _diagnostics = arrayListOf<ScriptDiagnostic>()
+
+    val diagnostics: List<ScriptDiagnostic> get() = _diagnostics
+
+    override fun clear() {
+        _diagnostics.clear()
+    }
+
+    override fun hasErrors(): Boolean =
+            _diagnostics.any { it.severity == ScriptDiagnostic.Severity.ERROR }
+
+
+    override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageLocation?) {
+        val mappedSeverity = when (severity) {
+            CompilerMessageSeverity.EXCEPTION,
+            CompilerMessageSeverity.ERROR -> ScriptDiagnostic.Severity.ERROR
+            CompilerMessageSeverity.STRONG_WARNING,
+            CompilerMessageSeverity.WARNING -> ScriptDiagnostic.Severity.WARNING
+            CompilerMessageSeverity.INFO -> ScriptDiagnostic.Severity.INFO
+            CompilerMessageSeverity.LOGGING -> ScriptDiagnostic.Severity.DEBUG
+            else -> null
+        }
+        if (mappedSeverity != null) {
+            val mappedLocation = location?.let {
+                if (it.line < 0 && it.column < 0) null // special location created by CompilerMessageLocation.create
+                else SourceCode.Location(SourceCode.Position(it.line, it.column))
+            }
+            _diagnostics.add(ScriptDiagnostic(message, mappedSeverity, location?.path, mappedLocation))
+        }
+    }
+}
+
diff --git a/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintScriptConfiguration.kt b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintScriptConfiguration.kt
new file mode 100644
index 00000000..3b3a5907
--- /dev/null
+++ b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BluePrintScriptConfiguration.kt
@@ -0,0 +1,61 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onap.ccsdk.apps.controllerblueprints.scripts
+
+import java.io.File
+import kotlin.script.experimental.annotations.KotlinScript
+import kotlin.script.experimental.api.ScriptCompilationConfiguration
+import kotlin.script.experimental.api.SourceCode
+import kotlin.script.experimental.api.defaultImports
+import kotlin.script.experimental.jvm.jvm
+import kotlin.script.experimental.jvm.util.classpathFromClassloader
+
+@KotlinScript(
+        fileExtension = "cba.kts",
+        compilationConfiguration = BluePrintScripCompilationConfiguration::class,
+        displayName = "Controller Blueprint Archive Kotlin Scripts"
+)
+abstract class BluePrintKotlinScript
+
+object BluePrintScripCompilationConfiguration : ScriptCompilationConfiguration(
+        {
+            defaultImports(
+                    "org.onap.ccsdk.apps.controllerblueprints.core.*",
+                    "org.onap.ccsdk.apps.controllerblueprints.core.data.*",
+                    "org.onap.ccsdk.apps.controllerblueprints.core.interfaces.*",
+                    "org.onap.ccsdk.apps.controllerblueprints.core.services.*",
+                    "org.onap.ccsdk.apps.controllerblueprints.core.utils.*")
+            jvm {
+                classpathFromClassloader(BluePrintScripCompilationConfiguration::class.java.classLoader)
+            }
+        }
+)
+
+open class BluePrintSourceCode : SourceCode {
+    lateinit var blueprintKotlinSources: MutableList<String>
+    lateinit var moduleName: String
+    lateinit var targetJarFile: File
+    var regenerate: Boolean = false
+
+    override val text: String
+        get() = ""
+
+    override val locationId: String? = null
+
+    override val name: String?
+        get() = moduleName
+}
diff --git a/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BlueprintScriptingHost.kt b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BlueprintScriptingHost.kt
new file mode 100644
index 00000000..59ce4abb
--- /dev/null
+++ b/ms/controllerblueprints/modules/blueprint-scripts/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/scripts/BlueprintScriptingHost.kt
@@ -0,0 +1,92 @@
+/*
+ * Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onap.ccsdk.apps.controllerblueprints.scripts
+
+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintProcessorException
+import org.slf4j.LoggerFactory
+import java.util.*
+import kotlin.script.experimental.api.*
+import kotlin.script.experimental.host.BasicScriptingHost
+import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration
+import kotlin.script.experimental.jvmhost.JvmScriptCompiler
+import kotlin.script.experimental.jvmhost.impl.withDefaults
+
+val blueprintScriptCompiler = JvmScriptCompiler(defaultJvmScriptingHostConfiguration,
+        BluePrintsCompilerProxy(defaultJvmScriptingHostConfiguration.withDefaults()))
+
+open class BlueprintScriptingHost(evaluator: ScriptEvaluator) : BasicScriptingHost(blueprintScriptCompiler, evaluator) {
+
+    override fun eval(
+            script: SourceCode,
+            scriptCompilationConfiguration: ScriptCompilationConfiguration,
+            configuration: ScriptEvaluationConfiguration?
+    ): ResultWithDiagnostics<EvaluationResult> =
+
+            runInCoroutineContext {
+
+                compiler(script, scriptCompilationConfiguration)
+                        .onSuccess {
+                            evaluator(it, configuration)
+                        }
+            }
+}
+
+
+open class BluePrintScriptEvaluator<T>(private val scriptClassName: String) : ScriptEvaluator {
+
+    private val log = LoggerFactory.getLogger(BluePrintScriptEvaluator::class.java)!!
+
+    override suspend operator fun invoke(
+            compiledScript: CompiledScript<*>,
+            scriptEvaluationConfiguration: ScriptEvaluationConfiguration?
+    ): ResultWithDiagnostics<EvaluationResult> =
+            try {
+                log.info("Getting class name($scriptClassName) of type() from the compiled sources ")
+                val bluePrintCompiledScript = compiledScript as BluePrintCompiledScript
+                bluePrintCompiledScript.scriptClassFQName = scriptClassName
+
+                val res = compiledScript.getClass(scriptEvaluationConfiguration)
+                when (res) {
+                    is ResultWithDiagnostics.Failure -> res
+                    is ResultWithDiagnostics.Success -> {
+
+                        val scriptClass = res.value
+                        val args = ArrayList<Any?>()
+                        scriptEvaluationConfiguration?.get(ScriptEvaluationConfiguration.providedProperties)?.forEach {
+                            args.add(it.value)
+                        }
+                        scriptEvaluationConfiguration?.get(ScriptEvaluationConfiguration.implicitReceivers)?.let {
+                            args.addAll(it)
+                        }
+                        scriptEvaluationConfiguration?.get(ScriptEvaluationConfiguration.constructorArgs)?.let {
+                            args.addAll(it)
+                        }
+
+                        val instance = scriptClass.java.newInstance() as? T
+                                ?: throw BluePrintProcessorException("failed to create instance from the script")
+
+                        log.info("Created script instance successfully....")
+
+                        ResultWithDiagnostics.Success(EvaluationResult(ResultValue.Value(scriptClass.qualifiedName!!,
+                                instance, "", instance),
+                                scriptEvaluationConfiguration))
+                    }
+                }
+            } catch (e: Throwable) {
+                ResultWithDiagnostics.Failure(e.asDiagnostics("Error evaluating script"))
+            }
+}
\ No newline at end of file