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

   1 /*
   2  * Copyright © 2017-2018 AT&T Intellectual Property.
   3  * Modifications Copyright © 2018-2019 IBM.
   4  *
   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
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 package org.onap.ccsdk.cds.controllerblueprints.core.utils
  19
  20
  21 import org.slf4j.LoggerFactory
  22 import com.fasterxml.jackson.databind.JsonNode
  23 import kotlinx.coroutines.runBlocking
  24 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  25 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
  26 import org.onap.ccsdk.cds.controllerblueprints.core.data.ToscaMetaData
  27 import org.onap.ccsdk.cds.controllerblueprints.core.normalizedFile
  28 import org.onap.ccsdk.cds.controllerblueprints.core.readNBLines
  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
  33 import java.io.File
  34 import java.util.*
  35
  36 class BluePrintMetadataUtils {
  37     companion object {
  38         private val log= LoggerFactory.getLogger(this::class.toString())
  39
  40
  41         suspend fun toscaMetaData(basePath: String): ToscaMetaData {
  42             val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
  43                     .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
  44             return toscaMetaDataFromMetaFile(toscaMetaPath)
  45         }
  46
  47         suspend fun entryDefinitionFile(basePath: String): String {
  48             val toscaMetaPath = basePath.plus(BluePrintConstants.PATH_DIVIDER)
  49                     .plus(BluePrintConstants.TOSCA_METADATA_ENTRY_DEFINITION_FILE)
  50             return toscaMetaDataFromMetaFile(toscaMetaPath).entityDefinitions
  51         }
  52
  53         fun bluePrintEnvProperties(basePath: String): Properties {
  54             val blueprintsEnvFilePath = basePath.plus(File.separator)
  55                     .plus(BluePrintConstants.TOSCA_ENVIRONMENTS_DIR)
  56             return environmentFileProperties(blueprintsEnvFilePath)
  57         }
  58
  59         fun environmentFileProperties(pathName: String): Properties {
  60             val properties = Properties()
  61             val envDir = normalizedFile(pathName)
  62             // Verify if the environment directory exists
  63             if (envDir.exists() && envDir.isDirectory) {
  64                 //Find all available environment files
  65                 envDir.listFiles()
  66                         .filter { it.name.endsWith(".properties") }
  67                         .forEach {
  68                             val istream = it.inputStream()
  69                             properties.load(istream)
  70                             istream.close()
  71                         }
  72             }
  73             return properties
  74         }
  75
  76         private suspend fun toscaMetaDataFromMetaFile(metaFilePath: String): ToscaMetaData {
  77             val toscaMetaData = ToscaMetaData()
  78             val lines = normalizedFile(metaFilePath).readNBLines()
  79             lines.forEach { line ->
  80                 if (line.contains(":")) {
  81                     val keyValue = line.split(":")
  82                     if (keyValue.size == 2) {
  83                         val value: String = keyValue[1].trim()
  84                         when (keyValue[0]) {
  85                             "TOSCA-Meta-File-Version" -> toscaMetaData.toscaMetaFileVersion = value
  86                             "CSAR-Version" -> toscaMetaData.csarVersion = value
  87                             "Created-By" -> toscaMetaData.createdBy = value
  88                             "Entry-Definitions" -> toscaMetaData.entityDefinitions = value
  89                             "Template-Tags" -> toscaMetaData.templateTags = value
  90                         }
  91                     }
  92                 }
  93
  94             }
  95             return toscaMetaData
  96         }
  97
  98         fun getBluePrintRuntime(id: String, blueprintBasePath: String): BluePrintRuntimeService<MutableMap<String, JsonNode>> {
  99
 100             val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
 101
 102             val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
 103             bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
 104             bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
 105
 106             return bluePrintRuntimeService
 107         }
 108
 109         suspend fun getBaseEnhancementBluePrintRuntime(id: String, blueprintBasePath: String)
 110                 : BluePrintRuntimeService<MutableMap<String, JsonNode>> {
 111
 112             val bluePrintContext: BluePrintContext = getBaseEnhancementBluePrintContext(blueprintBasePath)
 113
 114             val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
 115             bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_BASE_PATH, blueprintBasePath.asJsonPrimitive())
 116             bluePrintRuntimeService.put(BluePrintConstants.PROPERTY_BLUEPRINT_PROCESS_ID, id.asJsonPrimitive())
 117
 118             return bluePrintRuntimeService
 119         }
 120
 121         fun getBluePrintRuntime(id: String, blueprintBasePath: String, executionContext: MutableMap<String, JsonNode>):
 122                 BluePrintRuntimeService<MutableMap<String, JsonNode>> {
 123             val bluePrintContext: BluePrintContext = getBluePrintContext(blueprintBasePath)
 124             val bluePrintRuntimeService = DefaultBluePrintRuntimeService(id, bluePrintContext)
 125             executionContext.forEach {
 126                 bluePrintRuntimeService.put(it.key, it.value)
 127             }
 128
 129             bluePrintRuntimeService.setExecutionContext(executionContext)
 130             return bluePrintRuntimeService
 131         }
 132
 133         fun getBluePrintContext(blueprintBasePath: String): BluePrintContext = runBlocking {
 134
 135             val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
 136
 137             log.info("Reading blueprint path($blueprintBasePath) and entry definition file (${toscaMetaData.entityDefinitions})")
 138
 139             readBlueprintFile(toscaMetaData.entityDefinitions, blueprintBasePath)
 140         }
 141
 142         private suspend fun getBaseEnhancementBluePrintContext(blueprintBasePath: String): BluePrintContext {
 143             val toscaMetaData: ToscaMetaData = toscaMetaData(blueprintBasePath)
 144             // Clean Type files
 145             BluePrintFileUtils.deleteBluePrintTypes(blueprintBasePath)
 146             val rootFilePath: String = blueprintBasePath.plus(File.separator).plus(toscaMetaData.entityDefinitions)
 147             val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
 148
 149             // Clean the Import Definitions
 150             BluePrintFileUtils.cleanImportTypes(rootServiceTemplate)
 151
 152             val blueprintContext = BluePrintContext(rootServiceTemplate)
 153             blueprintContext.rootPath = blueprintBasePath
 154             blueprintContext.entryDefinition = toscaMetaData.entityDefinitions
 155             return blueprintContext
 156         }
 157
 158         private suspend fun readBlueprintFile(entityDefinitions: String, basePath: String): BluePrintContext {
 159             val rootFilePath: String = basePath.plus(File.separator).plus(entityDefinitions)
 160             val rootServiceTemplate = ServiceTemplateUtils.getServiceTemplate(rootFilePath)
 161             // Recursively Import Template files
 162             val schemaImportResolverUtils = BluePrintImportService(rootServiceTemplate, basePath)
 163             val completeServiceTemplate = schemaImportResolverUtils.getImportResolvedServiceTemplate()
 164             val blueprintContext = BluePrintContext(completeServiceTemplate)
 165             blueprintContext.rootPath = basePath
 166             blueprintContext.entryDefinition = entityDefinitions
 167             return blueprintContext
 168         }
 169     }
 170 }