2 * Copyright © 2017-2018 AT&T Intellectual Property.
3 * Modifications Copyright © 2018-2019 IBM.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 package org.onap.ccsdk.cds.controllerblueprints.core.utils
20 import com.fasterxml.jackson.databind.JsonNode
21 import kotlinx.coroutines.runBlocking
22 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
23 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
24 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
25 import org.onap.ccsdk.cds.controllerblueprints.core.data.ToscaMetaData
26 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BluePrintDefinitions
27 import org.onap.ccsdk.cds.controllerblueprints.core.normalizedFile
28 import org.onap.ccsdk.cds.controllerblueprints.core.normalizedPathName
29 import org.onap.ccsdk.cds.controllerblueprints.core.readNBLines
30 import org.onap.ccsdk.cds.controllerblueprints.core.scripts.BluePrintScriptsServiceImpl
31 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintContext
32 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintImportService
33 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
34 import org.onap.ccsdk.cds.controllerblueprints.core.service.DefaultBluePrintRuntimeService
35 import org.slf4j.LoggerFactory
37 import java.util.Properties
39 class BluePrintMetadataUtils {
41 private val log = LoggerFactory.getLogger(this::class.toString())
43 suspend fun toscaMetaData(basePath: String): ToscaMetaData {
44 val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
45 .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
46 return toscaMetaDataFromMetaFile(toscaMetaPath)
49 suspend fun entryDefinitionFile(basePath: String): String {
50 val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
51 .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
52 return toscaMetaDataFromMetaFile(toscaMetaPath).entityDefinitions
55 fun bluePrintEnvProperties(basePath: String): Properties {
56 val blueprintsEnvFilePath = basePath.plus(File.separator)
57 .plus(BluePrintConstants.TOSCA_ENVIRONMENTS_DIR)
58 return environmentFileProperties(blueprintsEnvFilePath)
61 fun environmentFileProperties(pathName: String): Properties {
62 val properties = Properties()
63 val envDir = normalizedFile(pathName)
64 // Verify if the environment directory exists
65 if (envDir.exists() && envDir.isDirectory) {
66 // Find all available environment files
68 .filter { it.name.endsWith(".properties") }
70 val istream = it.inputStream()
71 properties.load(istream)
78 private suspend fun toscaMetaDataFromMetaFile(metaFilePath: String): ToscaMetaData {
79 val toscaMetaData = ToscaMetaData()
80 val lines = normalizedFile(metaFilePath).readNBLines()
81 lines.forEach { line ->
82 if (line.contains(":")) {
83 val keyValue = line.split(":")
84 if (keyValue.size == 2) {
85 val value: String = keyValue[1].trim()
87 "TOSCA-Meta-File-Version" -> toscaMetaData.toscaMetaFileVersion = value
88 "CSAR-Version" -> toscaMetaData.csarVersion = value
89 "Created-By" -> toscaMetaData.createdBy = value
90 "Entry-Definitions" -> toscaMetaData.entityDefinitions = value
91 "Template-Name" -> toscaMetaData.templateName = value
92 "Template-Version" -> toscaMetaData.templateVersion = value
93 "Template-Tags" -> toscaMetaData.templateTags = value
101 fun getBluePrintRuntime(id: String, blueprintBasePath: String):
102 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
103 val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
104 return getBluePrintRuntime(id, bluePrintContext)
107 fun getBluePrintRuntime(id: String, bluePrintContext: BluePrintContext):
108 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
109 checkNotEmpty(bluePrintContext.rootPath) { "blueprint context root path is missing." }
110 checkNotEmpty(bluePrintContext.entryDefinition) { "blueprint context entry definition is missing." }
111 val blueprintBasePath = bluePrintContext.rootPath
112 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
113 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
114 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
115 return bluePrintRuntimeService
118 suspend fun getBaseEnhancementBluePrintRuntime(id: String, blueprintBasePath: String):
119 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
121 val bluePrintContext: BluePrintContext = getBaseEnhancementBluePrintContext(blueprintBasePath)
123 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
124 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
125 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
127 return bluePrintRuntimeService
130 fun getBluePrintRuntime(id: String, blueprintBasePath: String, executionContext: MutableMap<String, JsonNode>):
131 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
132 val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
133 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
134 executionContext.forEach {
135 bluePrintRuntimeService.put(it.key, it.value)
138 bluePrintRuntimeService.setExecutionContext(executionContext)
139 return bluePrintRuntimeService
142 fun getBluePrintContext(blueprintBasePath: String): BluePrintContext = runBlocking {
144 val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
146 log.info("Reading blueprint path($blueprintBasePath) and entry definition file (${toscaMetaData.entityDefinitions})")
148 // If the EntryDefinition is Kotlin file, compile and get Service Template
149 if (toscaMetaData.entityDefinitions.endsWith("kt")) {
150 readBlueprintKotlinFile(toscaMetaData, blueprintBasePath)
152 readBlueprintFile(toscaMetaData.entityDefinitions, blueprintBasePath)
156 private suspend fun getBaseEnhancementBluePrintContext(blueprintBasePath: String): BluePrintContext {
157 val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
159 BluePrintFileUtils.deleteBluePrintTypes(blueprintBasePath)
160 val rootFilePath: String = blueprintBasePath.plus(File.separator).plus(toscaMetaData.entityDefinitions)
161 val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
163 // Clean the Import Definitions
164 BluePrintFileUtils.cleanImportTypes(rootServiceTemplate)
166 val blueprintContext = BluePrintContext(rootServiceTemplate)
167 blueprintContext.rootPath = blueprintBasePath
168 blueprintContext.entryDefinition = toscaMetaData.entityDefinitions
169 return blueprintContext
172 private suspend fun readBlueprintFile(entityDefinitions: String, basePath: String): BluePrintContext {
173 val normalizedBasePath = normalizedPathName(basePath)
174 val rootFilePath = normalizedPathName(normalizedBasePath, entityDefinitions)
175 val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
176 // Recursively Import Template files
177 val schemaImportResolverUtils = BluePrintImportService(rootServiceTemplate, normalizedBasePath)
178 val completeServiceTemplate = schemaImportResolverUtils.getImportResolvedServiceTemplate()
179 val blueprintContext = BluePrintContext(completeServiceTemplate)
180 blueprintContext.rootPath = normalizedBasePath
181 blueprintContext.entryDefinition = entityDefinitions
182 return blueprintContext
185 /** Reade the Service Template Definitions from the Kotlin file */
186 private suspend fun readBlueprintKotlinFile(toscaMetaData: ToscaMetaData, basePath: String): BluePrintContext {
188 checkNotNull(toscaMetaData.templateName) { "couldn't find 'Template-Name' key in TOSCA.meta" }
189 checkNotNull(toscaMetaData.templateVersion) { "couldn't find 'Template-Version' key in TOSCA.meta" }
191 val definitionClassName = toscaMetaData.entityDefinitions.removeSuffix(".kt")
192 val normalizedBasePath = normalizedPathName(basePath)
194 val bluePrintScriptsService = BluePrintScriptsServiceImpl()
195 val bluePrintDefinitions = bluePrintScriptsService
196 .scriptInstance<BluePrintDefinitions>(
197 normalizedBasePath, toscaMetaData.templateName!!,
198 toscaMetaData.templateVersion!!, definitionClassName, false
200 // Get the Service Template
201 val serviceTemplate = bluePrintDefinitions.serviceTemplate()
203 // Clean the Default type import Definitions
204 BluePrintFileUtils.cleanImportTypes(serviceTemplate)
206 val blueprintContext = BluePrintContext(serviceTemplate)
207 blueprintContext.rootPath = normalizedBasePath
208 blueprintContext.entryDefinition = toscaMetaData.entityDefinitions
209 blueprintContext.otherDefinitions = bluePrintDefinitions.otherDefinitions()
210 return blueprintContext