2 * Copyright © 2017-2018 AT&T Intellectual Property.
3 * Modifications Copyright © 2018 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
21 import com.att.eelf.configuration.EELFLogger
22 import com.att.eelf.configuration.EELFManager
23 import com.fasterxml.jackson.databind.JsonNode
24 import kotlinx.coroutines.runBlocking
25 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
26 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
27 import org.onap.ccsdk.cds.controllerblueprints.core.data.ToscaMetaData
28 import org.onap.ccsdk.cds.controllerblueprints.core.normalizedFile
29 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintContext
30 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintImportService
31 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
32 import org.onap.ccsdk.cds.controllerblueprints.core.service.DefaultBluePrintRuntimeService
34 import java.nio.charset.Charset
37 class BluePrintMetadataUtils {
39 private val log: EELFLogger = EELFManager.getInstance().getLogger(this::class.toString())
42 fun toscaMetaData(basePath: String): ToscaMetaData {
43 val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
44 .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
45 return toscaMetaDataFromMetaFile(toscaMetaPath)
48 fun entryDefinitionFile(basePath: String): String {
49 val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
50 .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
51 return toscaMetaDataFromMetaFile(toscaMetaPath).entityDefinitions
54 fun bluePrintEnvProperties(basePath: String): Properties {
55 val blueprintsEnvFilePath = basePath.plus(File.separator)
56 .plus(BluePrintConstants.TOSCA_ENVIRONMENTS_DIR)
57 return environmentFileProperties(blueprintsEnvFilePath)
60 fun environmentFileProperties(pathName: String): Properties {
61 val properties = Properties()
62 val envDir = File(pathName)
63 // Verify if the environment directory exists
64 if (envDir.exists() && envDir.isDirectory) {
65 //Find all available environment files
67 .filter { it.name.endsWith(".properties") }
69 properties.load(it.inputStream())
75 fun toscaMetaDataFromMetaFile(metaFilePath: String): ToscaMetaData {
76 val toscaMetaData = ToscaMetaData()
77 val lines = normalizedFile(metaFilePath).readLines(Charset.defaultCharset())
78 lines.forEach { line ->
79 if (line.contains(":")) {
80 val keyValue = line.split(":")
81 if (keyValue.size == 2) {
82 val value: String = keyValue[1].trim()
84 "TOSCA-Meta-File-Version" -> toscaMetaData.toscaMetaFileVersion = value
85 "CSAR-Version" -> toscaMetaData.csarVersion = value
86 "Created-By" -> toscaMetaData.createdBy = value
87 "Entry-Definitions" -> toscaMetaData.entityDefinitions = value
88 "Template-Tags" -> toscaMetaData.templateTags = value
97 fun getBluePrintRuntime(id: String, blueprintBasePath: String): BluePrintRuntimeService<MutableMap<String, JsonNode>> {
99 val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
101 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
102 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
103 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
105 return bluePrintRuntimeService
108 suspend fun getBaseEnhancementBluePrintRuntime(id: String, blueprintBasePath: String)
109 : BluePrintRuntimeService<MutableMap<String, JsonNode>> {
111 val bluePrintContext: BluePrintContext = getBaseEnhancementBluePrintContext(blueprintBasePath)
113 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
114 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
115 bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
117 return bluePrintRuntimeService
120 fun getBluePrintRuntime(id: String, blueprintBasePath: String, executionContext: MutableMap<String, JsonNode>):
121 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
122 val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
123 val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
124 executionContext.forEach {
125 bluePrintRuntimeService.put(it.key, it.value)
128 bluePrintRuntimeService.setExecutionContext(executionContext)
129 return bluePrintRuntimeService
132 fun getBluePrintContext(blueprintBasePath: String): BluePrintContext = runBlocking {
134 val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
136 log.info("Reading blueprint path($blueprintBasePath) and entry definition file (${toscaMetaData.entityDefinitions})")
138 readBlueprintFile(toscaMetaData.entityDefinitions, blueprintBasePath)
141 private suspend fun getBaseEnhancementBluePrintContext(blueprintBasePath: String): BluePrintContext {
142 val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
144 BluePrintFileUtils.deleteBluePrintTypes(blueprintBasePath)
145 val rootFilePath: String = blueprintBasePath.plus(File.separator).plus(toscaMetaData.entityDefinitions)
146 val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
148 // Clean the Import Definitions
149 BluePrintFileUtils.cleanImportTypes(rootServiceTemplate)
151 val blueprintContext = BluePrintContext(rootServiceTemplate)
152 blueprintContext.rootPath = blueprintBasePath
153 blueprintContext.entryDefinition = toscaMetaData.entityDefinitions
154 return blueprintContext
157 private suspend fun readBlueprintFile(entityDefinitions: String, basePath: String): BluePrintContext {
158 val rootFilePath: String = basePath.plus(File.separator).plus(entityDefinitions)
159 val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
160 // Recursively Import Template files
161 val schemaImportResolverUtils = BluePrintImportService(rootServiceTemplate, basePath)
162 val completeServiceTemplate = schemaImportResolverUtils.getImportResolvedServiceTemplate()
163 val blueprintContext = BluePrintContext(completeServiceTemplate)
164 blueprintContext.rootPath = basePath
165 blueprintContext.entryDefinition = entityDefinitions
166 return blueprintContext