aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/main/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/interfaces/BlueprintEnhancer.kt
blob: 318fd2b9139da5cf2c976547acae39b6bbf6723b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*
 * Copyright © 2017-2018 AT&T Intellectual Property.
 * Modifications Copyright © 2019 IBM.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onap.ccsdk.cds.controllerblueprints.core.interfaces

import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintException
import org.onap.ccsdk.cds.controllerblueprints.core.data.ArtifactDefinition
import org.onap.ccsdk.cds.controllerblueprints.core.data.AttributeDefinition
import org.onap.ccsdk.cds.controllerblueprints.core.data.NodeTemplate
import org.onap.ccsdk.cds.controllerblueprints.core.data.NodeType
import org.onap.ccsdk.cds.controllerblueprints.core.data.PolicyType
import org.onap.ccsdk.cds.controllerblueprints.core.data.PropertyDefinition
import org.onap.ccsdk.cds.controllerblueprints.core.data.RelationshipTemplate
import org.onap.ccsdk.cds.controllerblueprints.core.data.RelationshipType
import org.onap.ccsdk.cds.controllerblueprints.core.data.ServiceTemplate
import org.onap.ccsdk.cds.controllerblueprints.core.data.TopologyTemplate
import org.onap.ccsdk.cds.controllerblueprints.core.data.Workflow
import org.onap.ccsdk.cds.controllerblueprints.core.service.BlueprintContext
import org.onap.ccsdk.cds.controllerblueprints.core.service.BlueprintRuntimeService

interface BlueprintEnhancer<T> {

    fun enhance(bluePrintRuntimeService: BlueprintRuntimeService<*>, name: String, type: T)
}

interface BlueprintServiceTemplateEnhancer : BlueprintEnhancer<ServiceTemplate>

interface BlueprintTopologyTemplateEnhancer : BlueprintEnhancer<TopologyTemplate>

interface BlueprintWorkflowEnhancer : BlueprintEnhancer<Workflow>

interface BlueprintNodeTemplateEnhancer : BlueprintEnhancer<NodeTemplate>

interface BlueprintNodeTypeEnhancer : BlueprintEnhancer<NodeType>

interface BlueprintRelationshipTemplateEnhancer : BlueprintEnhancer<RelationshipTemplate>

interface BlueprintRelationshipTypeEnhancer : BlueprintEnhancer<RelationshipType>

interface BlueprintArtifactDefinitionEnhancer : BlueprintEnhancer<ArtifactDefinition>

interface BlueprintPolicyTypeEnhancer : BlueprintEnhancer<PolicyType>

interface BlueprintPropertyDefinitionEnhancer : BlueprintEnhancer<PropertyDefinition>

interface BlueprintAttributeDefinitionEnhancer : BlueprintEnhancer<AttributeDefinition>

interface BlueprintEnhancerService {

    @Throws(BlueprintException::class)
    suspend fun enhance(basePath: String, enrichedBasePath: String): BlueprintContext

    @Throws(BlueprintException::class)
    suspend fun enhance(basePath: String): BlueprintContext
}

interface BlueprintTypeEnhancerService {

    fun getServiceTemplateEnhancers(): List<BlueprintServiceTemplateEnhancer>

    fun getTopologyTemplateEnhancers(): List<BlueprintTopologyTemplateEnhancer>

    fun getWorkflowEnhancers(): List<BlueprintWorkflowEnhancer>

    fun getNodeTemplateEnhancers(): List<BlueprintNodeTemplateEnhancer>

    fun getNodeTypeEnhancers(): List<BlueprintNodeTypeEnhancer>

    fun getRelationshipTemplateEnhancers(): List<BlueprintRelationshipTemplateEnhancer>

    fun getRelationshipTypeEnhancers(): List<BlueprintRelationshipTypeEnhancer>

    fun getArtifactDefinitionEnhancers(): List<BlueprintArtifactDefinitionEnhancer>

    fun getPolicyTypeEnhancers(): List<BlueprintPolicyTypeEnhancer>

    fun getPropertyDefinitionEnhancers(): List<BlueprintPropertyDefinitionEnhancer>

    fun getAttributeDefinitionEnhancers(): List<BlueprintAttributeDefinitionEnhancer>

    fun enhanceServiceTemplate(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        serviceTemplate: ServiceTemplate
    ) {
        val enhancers = getServiceTemplateEnhancers()
        doEnhancement(bluePrintRuntimeService, name, serviceTemplate, enhancers)
    }

    fun enhanceTopologyTemplate(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        topologyTemplate: TopologyTemplate
    ) {
        val enhancers = getTopologyTemplateEnhancers()
        doEnhancement(bluePrintRuntimeService, name, topologyTemplate, enhancers)
    }

    fun enhanceWorkflow(bluePrintRuntimeService: BlueprintRuntimeService<*>, name: String, workflow: Workflow) {
        val enhancers = getWorkflowEnhancers()
        doEnhancement(bluePrintRuntimeService, name, workflow, enhancers)
    }

    fun enhanceNodeTemplate(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        nodeTemplate: NodeTemplate
    ) {
        val enhancers = getNodeTemplateEnhancers()
        doEnhancement(bluePrintRuntimeService, name, nodeTemplate, enhancers)
    }

    fun enhanceNodeType(bluePrintRuntimeService: BlueprintRuntimeService<*>, name: String, nodeType: NodeType) {
        val enhancers = getNodeTypeEnhancers()
        doEnhancement(bluePrintRuntimeService, name, nodeType, enhancers)
    }

    fun enhanceRelationshipTemplate(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        relationshipTemplate: RelationshipTemplate
    ) {
        val enhancers = getRelationshipTemplateEnhancers()
        doEnhancement(bluePrintRuntimeService, name, relationshipTemplate, enhancers)
    }

    fun enhanceRelationshipType(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        relationshipType: RelationshipType
    ) {
        val enhancers = getRelationshipTypeEnhancers()
        doEnhancement(bluePrintRuntimeService, name, relationshipType, enhancers)
    }

    fun enhanceArtifactDefinition(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        artifactDefinition: ArtifactDefinition
    ) {
        val enhancers = getArtifactDefinitionEnhancers()
        doEnhancement(bluePrintRuntimeService, name, artifactDefinition, enhancers)
    }

    fun enhancePolicyType(bluePrintRuntimeService: BlueprintRuntimeService<*>, name: String, policyType: PolicyType) {
        val enhancers = getPolicyTypeEnhancers()
        doEnhancement(bluePrintRuntimeService, name, policyType, enhancers)
    }

    fun enhancePropertyDefinitions(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        properties: MutableMap<String, PropertyDefinition>
    ) {
        val errorMap = linkedMapOf<String, BlueprintException>()
        properties.forEach { propertyName, propertyDefinition ->
            try {
                enhancePropertyDefinition(bluePrintRuntimeService, propertyName, propertyDefinition)
            } catch (e: BlueprintException) {
                errorMap[propertyName] = e
            }
        }
        if (errorMap.isNotEmpty()) {
            val nestedErrors = errorMap.keys.map { "[ property: ${errorMap[it]?.message} ]" }.joinToString(";")
            throw BlueprintException("Failed to enhance properties $nestedErrors")
        }
    }

    fun enhancePropertyDefinition(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        propertyDefinition: PropertyDefinition
    ) {
        val enhancers = getPropertyDefinitionEnhancers()
        doEnhancement(bluePrintRuntimeService, name, propertyDefinition, enhancers)
    }

    fun enhanceAttributeDefinitions(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        attributes: MutableMap<String, AttributeDefinition>
    ) {
        val errorMap = linkedMapOf<String, BlueprintException>()
        attributes.forEach { attributeName, attributeDefinition ->
            try {
                enhanceAttributeDefinition(bluePrintRuntimeService, attributeName, attributeDefinition)
            } catch (e: BlueprintException) {
                errorMap[attributeName] = e
            }
        }
        if (errorMap.isNotEmpty()) {
            val nestedErrors = errorMap.keys.map { "[ attribute: ${errorMap[it]?.message} ]" }.joinToString(";")
            throw BlueprintException("Failed to enhance attributes $nestedErrors")
        }
    }

    fun enhanceAttributeDefinition(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        attributeDefinition: AttributeDefinition
    ) {
        val enhancers = getAttributeDefinitionEnhancers()
        doEnhancement(bluePrintRuntimeService, name, attributeDefinition, enhancers)
    }

    @Suppress("UNCHECKED_CAST")
    private fun <T> doEnhancement(
        bluePrintRuntimeService: BlueprintRuntimeService<*>,
        name: String,
        definition: Any,
        enhancers: List<BlueprintEnhancer<T>>
    ) {
        if (enhancers.isNotEmpty()) {
            val errorMap = linkedMapOf<String, BlueprintException>()
            enhancers.forEach {
                try {
                    it.enhance(bluePrintRuntimeService, name, definition as T)
                } catch (e: BlueprintException) {
                    errorMap[name] = e
                }
            }
            if (errorMap.isNotEmpty()) {
                val nestedErrors = errorMap.keys.map {
                    "${errorMap[it]?.message ?: errorMap[it].toString()}"
                }.joinToString(";")
                throw BlueprintException("$name-->$nestedErrors")
            }
        }
    }
}