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

   1 /*\r
   2  * Copyright © 2017-2018 AT&T Intellectual Property.\r
   3  * Modifications Copyright © 2018 IBM.\r
   4  *\r
   5  * Licensed under the Apache License, Version 2.0 (the "License");\r
   6  * you may not use this file except in compliance with the License.\r
   7  * You may obtain a copy of the License at\r
   8  *\r
   9  *     http://www.apache.org/licenses/LICENSE-2.0\r
  10  *\r
  11  * Unless required by applicable law or agreed to in writing, software\r
  12  * distributed under the License is distributed on an "AS IS" BASIS,\r
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14  * See the License for the specific language governing permissions and\r
  15  * limitations under the License.\r
  16  */\r
  17 \r
  18 package org.onap.ccsdk.apps.controllerblueprints.core.service\r
  19 \r
  20 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException\r
  21 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintTypes\r
  22 import org.onap.ccsdk.apps.controllerblueprints.core.data.*\r
  23 import org.onap.ccsdk.apps.controllerblueprints.core.format\r
  24 import com.att.eelf.configuration.EELFLogger\r
  25 import com.att.eelf.configuration.EELFManager\r
  26 import org.onap.ccsdk.apps.controllerblueprints.core.utils.JacksonReactorUtils\r
  27 import java.io.Serializable\r
  28 \r
  29 /**\r
  30  * BluePrintEnhancerService\r
  31  * @author Brinda Santh\r
  32  *\r
  33  */\r
  34 interface BluePrintEnhancerService : Serializable {\r
  35 \r
  36     @Throws(BluePrintException::class)\r
  37     fun enhance(content: String): ServiceTemplate\r
  38 \r
  39     /**\r
  40      * Read Blueprint from CSAR structure Directory\r
  41      */\r
  42     @Throws(BluePrintException::class)\r
  43     fun enhance(fileName: String, basePath: String): ServiceTemplate\r
  44 \r
  45     @Throws(BluePrintException::class)\r
  46     fun enhance(serviceTemplate: ServiceTemplate): ServiceTemplate\r
  47 \r
  48     @Throws(BluePrintException::class)\r
  49     fun enrichNodeTemplate(nodeTemplateName: String, nodeTemplate: NodeTemplate)\r
  50 \r
  51     @Throws(BluePrintException::class)\r
  52     fun enrichNodeType(nodeTypeName: String, nodeType: NodeType)\r
  53 \r
  54     @Throws(BluePrintException::class)\r
  55     fun enrichPropertyDefinition(propertyName: String, propertyDefinition: PropertyDefinition)\r
  56 }\r
  57 \r
  58 open class BluePrintEnhancerDefaultService(val bluePrintRepoService: BluePrintRepoService) : BluePrintEnhancerService {\r
  59 \r
  60     private val log: EELFLogger = EELFManager.getInstance().getLogger(BluePrintEnhancerDefaultService::class.toString())\r
  61 \r
  62     lateinit var serviceTemplate: ServiceTemplate\r
  63 \r
  64     @Throws(BluePrintException::class)\r
  65     override fun enhance(content: String): ServiceTemplate {\r
  66         return JacksonReactorUtils.readValueFromFile(content, ServiceTemplate::class.java).map { serviceTemplate ->\r
  67             enhance(serviceTemplate!!)\r
  68         }.block()!!\r
  69     }\r
  70 \r
  71     @Throws(BluePrintException::class)\r
  72     override fun enhance(fileName: String, basePath: String): ServiceTemplate {\r
  73         TODO("not implemented") //To change body of created functions use File | Settings | File Templates.\r
  74     }\r
  75 \r
  76     @Throws(BluePrintException::class)\r
  77     override fun enhance(serviceTemplate: ServiceTemplate): ServiceTemplate {\r
  78         this.serviceTemplate = serviceTemplate\r
  79         initialCleanUp()\r
  80         enrichTopologyTemplate(serviceTemplate)\r
  81 \r
  82         // log.info("Enriched Blueprint :\n {}", JacksonUtils.getJson(serviceTemplate, true))\r
  83         return this.serviceTemplate\r
  84     }\r
  85 \r
  86     open fun initialCleanUp() {\r
  87         serviceTemplate.artifactTypes?.clear()\r
  88         serviceTemplate.nodeTypes?.clear()\r
  89         serviceTemplate.dataTypes?.clear()\r
  90 \r
  91         serviceTemplate.artifactTypes = HashMap()\r
  92         serviceTemplate.nodeTypes = HashMap()\r
  93         serviceTemplate.dataTypes = HashMap()\r
  94 \r
  95     }\r
  96 \r
  97     @Throws(BluePrintException::class)\r
  98     open fun enrichTopologyTemplate(serviceTemplate: ServiceTemplate) {\r
  99         serviceTemplate.topologyTemplate?.let { topologyTemplate ->\r
 100             enrichTopologyTemplateInputs(topologyTemplate)\r
 101             enrichTopologyTemplateNodeTemplates(topologyTemplate)\r
 102         }\r
 103     }\r
 104 \r
 105     @Throws(BluePrintException::class)\r
 106     open fun enrichTopologyTemplateInputs(topologyTemplate: TopologyTemplate) {\r
 107         topologyTemplate.inputs?.let { inputs ->\r
 108             enrichPropertyDefinitions(inputs)\r
 109         }\r
 110     }\r
 111 \r
 112     open fun enrichTopologyTemplateNodeTemplates(topologyTemplate: TopologyTemplate) {\r
 113         topologyTemplate.nodeTemplates?.forEach { nodeTemplateName, nodeTemplate ->\r
 114             enrichNodeTemplate(nodeTemplateName, nodeTemplate)\r
 115         }\r
 116     }\r
 117 \r
 118     @Throws(BluePrintException::class)\r
 119     override fun enrichNodeTemplate(nodeTemplateName: String, nodeTemplate: NodeTemplate) {\r
 120         val nodeTypeName = nodeTemplate.type\r
 121         // Get NodeType from Repo and Update Service Template\r
 122         val nodeType = populateNodeType(nodeTypeName)\r
 123 \r
 124         // Enrich NodeType\r
 125         enrichNodeType(nodeTypeName, nodeType)\r
 126 \r
 127         //Enrich Node Template Artifacts\r
 128         enrichNodeTemplateArtifactDefinition(nodeTemplateName, nodeTemplate)\r
 129     }\r
 130 \r
 131     @Throws(BluePrintException::class)\r
 132     override fun enrichNodeType(nodeTypeName: String, nodeType: NodeType) {\r
 133 \r
 134         // NodeType Property Definitions\r
 135         enrichNodeTypeProperties(nodeTypeName, nodeType)\r
 136 \r
 137         //NodeType Requirement\r
 138         enrichNodeTypeRequirements(nodeTypeName, nodeType)\r
 139 \r
 140         //NodeType Capability\r
 141         enrichNodeTypeCapabilityProperties(nodeTypeName, nodeType)\r
 142 \r
 143         //NodeType Interface\r
 144         enrichNodeTypeInterfaces(nodeTypeName, nodeType)\r
 145     }\r
 146 \r
 147     open fun enrichNodeTypeProperties(nodeTypeName: String, nodeType: NodeType) {\r
 148         nodeType.properties?.let { enrichPropertyDefinitions(nodeType.properties!!) }\r
 149     }\r
 150 \r
 151     open fun enrichNodeTypeRequirements(nodeTypeName: String, nodeType: NodeType) {\r
 152 \r
 153         nodeType.requirements?.forEach { _, requirementDefinition ->\r
 154             // Populate Requirement Node\r
 155             requirementDefinition.node?.let { requirementNodeTypeName ->\r
 156                 // Get Requirement NodeType from Repo and Update Service Template\r
 157                 val requirementNodeType = populateNodeType(requirementNodeTypeName)\r
 158 \r
 159                 enrichNodeType(requirementNodeTypeName, requirementNodeType)\r
 160             }\r
 161         }\r
 162     }\r
 163 \r
 164     open fun enrichNodeTypeCapabilityProperties(nodeTypeName: String, nodeType: NodeType) {\r
 165         nodeType.capabilities?.forEach { capabilityDefinitionName, capabilityDefinition ->\r
 166             capabilityDefinition.properties?.let { properties ->\r
 167                 enrichPropertyDefinitions(properties)\r
 168             }\r
 169         }\r
 170     }\r
 171 \r
 172     open fun enrichNodeTypeInterfaces(nodeTypeName: String, nodeType: NodeType) {\r
 173         nodeType.interfaces?.forEach { interfaceName, interfaceObj ->\r
 174             // Populate Node type Interface Operation\r
 175             log.info("*** ** Enriching NodeType: {} Interface {}", nodeTypeName, interfaceName)\r
 176             populateNodeTypeInterfaceOperation(nodeTypeName, interfaceName, interfaceObj)\r
 177 \r
 178         }\r
 179     }\r
 180 \r
 181     open fun populateNodeTypeInterfaceOperation(nodeTypeName: String, interfaceName: String, interfaceObj: InterfaceDefinition) {\r
 182 \r
 183         interfaceObj.operations?.forEach { operationName, operation ->\r
 184             enrichNodeTypeInterfaceOperationInputs(nodeTypeName, operationName, operation)\r
 185             enrichNodeTypeInterfaceOperationOputputs(nodeTypeName, operationName, operation)\r
 186         }\r
 187     }\r
 188 \r
 189     open fun enrichNodeTypeInterfaceOperationInputs(nodeTypeName: String, operationName: String, operation: OperationDefinition) {\r
 190         operation.inputs?.let { inputs ->\r
 191             enrichPropertyDefinitions(inputs)\r
 192         }\r
 193     }\r
 194 \r
 195     open fun enrichNodeTypeInterfaceOperationOputputs(nodeTypeName: String, operationName: String, operation: OperationDefinition) {\r
 196         operation.outputs?.let { inputs ->\r
 197             enrichPropertyDefinitions(inputs)\r
 198         }\r
 199     }\r
 200 \r
 201     open fun enrichPropertyDefinitions(properties: MutableMap<String, PropertyDefinition>) {\r
 202 \r
 203         properties.forEach { propertyName, propertyDefinition ->\r
 204             enrichPropertyDefinition(propertyName, propertyDefinition)\r
 205         }\r
 206     }\r
 207 \r
 208     @Throws(BluePrintException::class)\r
 209     override fun enrichPropertyDefinition(propertyName: String, propertyDefinition: PropertyDefinition) {\r
 210         val propertyType = propertyDefinition.type\r
 211         if (BluePrintTypes.validPrimitiveTypes().contains(propertyType)) {\r
 212 \r
 213         } else if (BluePrintTypes.validCollectionTypes().contains(propertyType)) {\r
 214             val entrySchema = propertyDefinition.entrySchema\r
 215                     ?: throw BluePrintException(format("Entry Schema is missing for collection property : {}", propertyName))\r
 216 \r
 217             if (!BluePrintTypes.validPrimitiveTypes().contains(entrySchema.type)) {\r
 218                 populateDataTypes(entrySchema.type)\r
 219             }\r
 220         } else {\r
 221             populateDataTypes(propertyType)\r
 222         }\r
 223 \r
 224     }\r
 225 \r
 226     open fun enrichNodeTemplateArtifactDefinition(nodeTemplateName: String, nodeTemplate: NodeTemplate) {\r
 227 \r
 228         nodeTemplate.artifacts?.forEach { artifactDefinitionName, artifactDefinition ->\r
 229             val artifactTypeName = artifactDefinition.type\r
 230                     ?: throw BluePrintException(format("Artifact type is missing for NodeTemplate({}) artifact({})", nodeTemplateName, artifactDefinitionName))\r
 231 \r
 232             // Populate Artifact Type\r
 233             populateArtifactType(artifactTypeName)\r
 234         }\r
 235     }\r
 236 \r
 237     open fun populateNodeType(nodeTypeName: String): NodeType {\r
 238         val nodeType = bluePrintRepoService.getNodeType(nodeTypeName)?.block()\r
 239                 ?: throw BluePrintException(format("Couldn't get NodeType({}) from repo.", nodeTypeName))\r
 240         serviceTemplate.nodeTypes?.put(nodeTypeName, nodeType)\r
 241         return nodeType\r
 242     }\r
 243 \r
 244     open fun populateArtifactType(artifactTypeName: String): ArtifactType {\r
 245         val artifactType = bluePrintRepoService.getArtifactType(artifactTypeName)?.block()\r
 246                 ?: throw BluePrintException(format("Couldn't get ArtifactType({}) from repo.", artifactTypeName))\r
 247         serviceTemplate.artifactTypes?.put(artifactTypeName, artifactType)\r
 248         return artifactType\r
 249     }\r
 250 \r
 251     open fun populateDataTypes(dataTypeName: String): DataType {\r
 252         val dataType = bluePrintRepoService.getDataType(dataTypeName)?.block()\r
 253                 ?: throw BluePrintException(format("Couldn't get DataType({}) from repo.", dataTypeName))\r
 254         serviceTemplate.dataTypes?.put(dataTypeName, dataType)\r
 255         return dataType\r
 256     }\r
 257 \r
 258 }\r
 259 \r