ms/controllerblueprints/modules/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/service/BluePrintContext.kt

   1 /*
   2  * Copyright © 2017-2018 AT&T Intellectual Property.
   3  * Modifications Copyright © 2018 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 @file:Suppress("unused")
  18
  19 package org.onap.ccsdk.cds.controllerblueprints.core.service
  20
  21 import com.fasterxml.jackson.databind.JsonNode
  22 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  23 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
  24 import org.onap.ccsdk.cds.controllerblueprints.core.data.*
  25 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  26 import org.slf4j.LoggerFactory
  27
  28 /**
  29  *
  30  *
  31  * @author Brinda Santh
  32  */
  33 class BluePrintContext(val serviceTemplate: ServiceTemplate) {
  34
  35     private val log = LoggerFactory.getLogger(this::class.toString())
  36
  37     /**
  38      * Blueprint CBA extracted file location
  39      */
  40     var rootPath = "."
  41     /**
  42      * Root Definition file path
  43      */
  44     var entryDefinition = ""
  45
  46     /** Other definitions along with model, It may Resource Definition, Resource Assignments, Configurations etc..*/
  47     var otherDefinitions: MutableMap<String, Any> = hashMapOf()
  48
  49     fun <T> otherDefinition(key: String) = otherDefinitions[key] as T
  50
  51     fun checkOtherDefinition(key: String) = otherDefinitions.containsKey(key)
  52
  53     fun imports(): List<ImportDefinition>? = serviceTemplate.imports
  54
  55     fun dslDefinitions() = serviceTemplate.dslDefinitions
  56
  57     val metadata: MutableMap<String, String>? = serviceTemplate.metadata
  58
  59     fun dataTypes(): MutableMap<String, DataType>? = serviceTemplate.dataTypes
  60
  61     fun inputs(): MutableMap<String, PropertyDefinition>? = serviceTemplate.topologyTemplate?.inputs
  62
  63     fun blueprintJson(pretty: Boolean = false): String = print("json", pretty)
  64
  65     private fun print(type: String? = "json", pretty: Boolean = false): String {
  66         return JacksonUtils.getJson(serviceTemplate, pretty)
  67     }
  68
  69     fun name(): String = metadata?.get(BluePrintConstants.METADATA_TEMPLATE_NAME)
  70             ?: throw BluePrintException("could't get template name from meta data")
  71
  72     fun version(): String = metadata?.get(BluePrintConstants.METADATA_TEMPLATE_VERSION)
  73             ?: throw BluePrintException("could't get template version from meta data")
  74
  75     fun author(): String = metadata?.get(BluePrintConstants.METADATA_TEMPLATE_AUTHOR)
  76             ?: throw BluePrintException("could't get template author from meta data")
  77
  78     // Workflow
  79     fun workflows(): MutableMap<String, Workflow>? = serviceTemplate.topologyTemplate?.workflows
  80
  81     fun workflowByName(workFlowName: String): Workflow = workflows()?.get(workFlowName)
  82             ?: throw BluePrintException("could't get workflow($workFlowName)")
  83
  84     fun workflowInputs(workFlowName: String) = workflowByName(workFlowName).inputs
  85
  86     fun workflowStepByName(workFlowName: String, stepName: String): Step {
  87         return workflowByName(workFlowName).steps?.get(stepName)
  88                 ?: throw BluePrintException("could't get step($stepName) for workflow($workFlowName)")
  89     }
  90
  91     fun workflowStepNodeTemplate(workFlowName: String, stepName: String): String {
  92         return workflowStepByName(workFlowName, stepName).target
  93                 ?: throw BluePrintException("could't get node template name for workflow($workFlowName)'s step($stepName)")
  94     }
  95
  96     fun workflowFirstStepNodeTemplate(workFlowName: String): String {
  97         val firstStepName = workflowByName(workFlowName).steps?.keys?.first()
  98                 ?: throw BluePrintException("could't get first step for workflow($workFlowName)")
  99         return workflowStepNodeTemplate(workFlowName, firstStepName)
 100     }
 101
 102     fun workflowStepFirstCallOperation(workFlowName: String, stepName: String): String {
 103         return workflowStepByName(workFlowName, stepName).activities?.filter { it.callOperation != null }?.single()?.callOperation
 104                 ?: throw BluePrintException("could't get first callOperation for WorkFlow($workFlowName) ")
 105     }
 106
 107     // DSL
 108     fun dslPropertiesByName(name: String): JsonNode = dslDefinitions()?.get(name)
 109             ?: throw BluePrintException("could't get policy type for the dsl($name)")
 110
 111     // Data Type
 112     fun dataTypeByName(name: String): DataType? = dataTypes()?.get(name)
 113
 114     // Artifact Type
 115     fun artifactTypes(): MutableMap<String, ArtifactType>? = serviceTemplate.artifactTypes
 116
 117     // Policy Types
 118     fun policyTypes(): MutableMap<String, PolicyType>? = serviceTemplate.policyTypes
 119
 120     fun policyTypeByName(policyName: String) = policyTypes()?.get(policyName)
 121             ?: throw BluePrintException("could't get policy type for the name($policyName)")
 122
 123     fun policyTypesDerivedFrom(name: String): MutableMap<String, PolicyType>? {
 124         return policyTypes()?.filterValues { policyType -> policyType.derivedFrom == name }?.toMutableMap()
 125     }
 126
 127     fun policyTypesTarget(target: String): MutableMap<String, PolicyType>? {
 128         return policyTypes()?.filterValues { it.targets.contains(target) }?.toMutableMap()
 129     }
 130
 131     fun policyTypesTargetNDerivedFrom(target: String, derivedFrom: String): MutableMap<String, PolicyType>? {
 132         return policyTypesDerivedFrom(derivedFrom)?.filterValues {
 133             it.targets.contains(target)
 134         }?.toMutableMap()
 135     }
 136
 137     // Node Type Methods
 138     fun nodeTypes(): MutableMap<String, NodeType>? = serviceTemplate.nodeTypes
 139
 140     fun nodeTypeByName(name: String): NodeType =
 141             nodeTypes()?.get(name)
 142                     ?: throw BluePrintException("could't get node type for the name($name)")
 143
 144     fun nodeTypeDerivedFrom(name: String): MutableMap<String, NodeType>? {
 145         return nodeTypes()?.filterValues { nodeType -> nodeType.derivedFrom == name }?.toMutableMap()
 146     }
 147
 148     fun nodeTypeInterface(nodeTypeName: String, interfaceName: String): InterfaceDefinition {
 149         return nodeTypeByName(nodeTypeName).interfaces?.get(interfaceName)
 150                 ?: throw BluePrintException("could't get node type($nodeTypeName)'s interface definition($interfaceName)")
 151     }
 152
 153     fun nodeTypeInterfaceOperation(nodeTypeName: String, interfaceName: String, operationName: String): OperationDefinition {
 154         return nodeTypeInterface(nodeTypeName, interfaceName).operations?.get(operationName)
 155                 ?: throw BluePrintException("could't get node type($nodeTypeName)'s interface definition($interfaceName) operation definition($operationName)")
 156     }
 157
 158     fun interfaceNameForNodeType(nodeTypeName: String): String {
 159         return nodeTypeByName(nodeTypeName).interfaces?.keys?.first()
 160                 ?: throw BluePrintException("could't get NodeType($nodeTypeName)'s first InterfaceDefinition name")
 161     }
 162
 163     fun nodeTypeInterfaceOperationInputs(nodeTypeName: String, interfaceName: String, operationName: String): MutableMap<String, PropertyDefinition>? {
 164         return nodeTypeInterfaceOperation(nodeTypeName, interfaceName, operationName).inputs
 165     }
 166
 167     fun nodeTypeInterfaceOperationOutputs(nodeTypeName: String, interfaceName: String, operationName: String): MutableMap<String, PropertyDefinition>? {
 168         return nodeTypeInterfaceOperation(nodeTypeName, interfaceName, operationName).outputs
 169     }
 170
 171     // Node Template Methods
 172     fun nodeTemplates(): MutableMap<String, NodeTemplate>? = serviceTemplate.topologyTemplate?.nodeTemplates
 173
 174     fun nodeTemplateByName(name: String): NodeTemplate =
 175             nodeTemplates()?.get(name) ?: throw BluePrintException("could't get node template for the name($name)")
 176
 177     fun nodeTemplateForNodeType(name: String): MutableMap<String, NodeTemplate>? {
 178         return nodeTemplates()?.filterValues { nodeTemplate -> nodeTemplate.type == name }?.toMutableMap()
 179     }
 180
 181     fun nodeTemplateNodeType(nodeTemplateName: String): NodeType {
 182         val nodeTemplateType: String = nodeTemplateByName(nodeTemplateName).type
 183         return nodeTypeByName(nodeTemplateType)
 184     }
 185
 186     fun nodeTemplateProperty(nodeTemplateName: String, propertyName: String): Any? {
 187         return nodeTemplateByName(nodeTemplateName).properties?.get(propertyName)
 188     }
 189
 190     fun nodeTemplateArtifacts(nodeTemplateName: String): MutableMap<String, ArtifactDefinition>? {
 191         return nodeTemplateByName(nodeTemplateName).artifacts
 192     }
 193
 194     fun nodeTemplateArtifact(nodeTemplateName: String, artifactName: String): ArtifactDefinition {
 195         return nodeTemplateArtifacts(nodeTemplateName)?.get(artifactName)
 196                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s ArtifactDefinition($artifactName)")
 197     }
 198
 199     fun nodeTemplateArtifactForArtifactType(nodeTemplateName: String, artifactType: String): ArtifactDefinition {
 200         return nodeTemplateArtifacts(nodeTemplateName)?.filter { it.value.type == artifactType }?.map { it.value }?.get(0)
 201                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s Artifact Type($artifactType)")
 202     }
 203
 204     fun nodeTemplateFirstInterface(nodeTemplateName: String): InterfaceAssignment {
 205         return nodeTemplateByName(nodeTemplateName).interfaces?.values?.first()
 206                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s first InterfaceAssignment")
 207     }
 208
 209     fun nodeTemplateFirstInterfaceName(nodeTemplateName: String): String {
 210         return nodeTemplateByName(nodeTemplateName).interfaces?.keys?.first()
 211                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s first InterfaceAssignment name")
 212     }
 213
 214     fun nodeTemplateFirstInterfaceFirstOperationName(nodeTemplateName: String): String {
 215         return nodeTemplateFirstInterface(nodeTemplateName).operations?.keys?.first()
 216                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s first InterfaceAssignment's first OperationAssignment name")
 217     }
 218
 219     fun nodeTemplateInterfaceOperationInputs(nodeTemplateName: String, interfaceName: String, operationName: String): MutableMap<String, JsonNode>? {
 220         return nodeTemplateInterfaceOperation(nodeTemplateName, interfaceName, operationName).inputs
 221     }
 222
 223     fun nodeTemplateInterfaceOperationOutputs(nodeTemplateName: String, interfaceName: String, operationName: String): MutableMap<String, JsonNode>? {
 224         return nodeTemplateInterfaceOperation(nodeTemplateName, interfaceName, operationName).outputs
 225     }
 226
 227     fun nodeTemplateInterface(nodeTemplateName: String, interfaceName: String): InterfaceAssignment {
 228         return nodeTemplateByName(nodeTemplateName).interfaces?.get(interfaceName)
 229                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s InterfaceAssignment($interfaceName)")
 230     }
 231
 232     fun nodeTemplateInterfaceOperation(nodeTemplateName: String, interfaceName: String, operationName: String): OperationAssignment {
 233         return nodeTemplateInterface(nodeTemplateName, interfaceName).operations?.get(operationName)
 234                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s InterfaceAssignment($interfaceName) OperationAssignment($operationName)")
 235     }
 236
 237     fun nodeTemplateCapability(nodeTemplateName: String, capabilityName: String): CapabilityAssignment {
 238         return nodeTemplateByName(nodeTemplateName).capabilities?.get(capabilityName)
 239                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s CapabilityAssignment($capabilityName)")
 240     }
 241
 242     fun nodeTemplateRequirement(nodeTemplateName: String, requirementName: String): RequirementAssignment {
 243         return nodeTemplateByName(nodeTemplateName).requirements?.get(requirementName)
 244                 ?: throw BluePrintException("could't get NodeTemplate($nodeTemplateName)'s first RequirementAssignment($requirementName)")
 245     }
 246
 247     fun nodeTemplateRequirementNode(nodeTemplateName: String, requirementName: String): NodeTemplate {
 248         val filteredNodeTemplateName: String = nodeTemplateByName(nodeTemplateName).requirements?.get(requirementName)?.node
 249                 ?: throw BluePrintException("could't NodeTemplate for NodeTemplate's($nodeTemplateName) requirement's ($requirementName) ")
 250         return nodeTemplateByName(filteredNodeTemplateName)
 251     }
 252
 253     fun nodeTemplateCapabilityProperty(nodeTemplateName: String, capabilityName: String, propertyName: String): Any? {
 254         return nodeTemplateCapability(nodeTemplateName, capabilityName).properties?.get(propertyName)
 255     }
 256
 257     // Chained Functions
 258
 259     fun nodeTypeChained(nodeTypeName: String): NodeType {
 260         return BluePrintChainedService(this).nodeTypeChained(nodeTypeName)
 261     }
 262
 263     fun nodeTypeChainedProperties(nodeTypeName: String): MutableMap<String, PropertyDefinition>? {
 264         return BluePrintChainedService(this).nodeTypeChainedProperties(nodeTypeName)
 265     }
 266
 267 }