2 * Copyright © 2017-2018 AT&T Intellectual Property.
3 * Modifications Copyright © 2018-2019 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.blueprintsprocessor.functions.resource.resolution
20 import kotlinx.coroutines.async
21 import kotlinx.coroutines.awaitAll
22 import kotlinx.coroutines.coroutineScope
23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.ResourceResolutionResultService
24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor.ResourceAssignmentProcessor
25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
27 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
28 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
29 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintTemplateService
30 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
31 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
32 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDefinition
33 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.utils.BulkResourceSequencingUtils
34 import org.slf4j.LoggerFactory
35 import org.springframework.context.ApplicationContext
36 import org.springframework.stereotype.Service
38 interface ResourceResolutionService {
40 fun registeredResourceSources(): List<String>
42 suspend fun resolveFromDatabase(bluePrintRuntimeService: BluePrintRuntimeService<*>, artifactTemplate: String,
43 resolutionKey: String): String
45 suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
46 artifactNames: List<String>, properties: Map<String, Any>): MutableMap<String, String>
48 suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
49 artifactPrefix: String, properties: Map<String, Any>): String
51 suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
52 artifactMapping: String, artifactTemplate: String?): String
54 suspend fun resolveResourceAssignments(blueprintRuntimeService: BluePrintRuntimeService<*>,
55 resourceDefinitions: MutableMap<String, ResourceDefinition>,
56 resourceAssignments: MutableList<ResourceAssignment>,
57 identifierName: String)
60 @Service(ResourceResolutionConstants.SERVICE_RESOURCE_RESOLUTION)
61 open class ResourceResolutionServiceImpl(private var applicationContext: ApplicationContext,
62 private var resolutionResultService: ResourceResolutionResultService) :
63 ResourceResolutionService {
65 private val log = LoggerFactory.getLogger(ResourceResolutionService::class.java)
67 override fun registeredResourceSources(): List<String> {
68 return applicationContext.getBeanNamesForType(ResourceAssignmentProcessor::class.java)
69 .filter { it.startsWith(ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR) }
70 .map { it.substringAfter(ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR) }
73 override suspend fun resolveFromDatabase(bluePrintRuntimeService: BluePrintRuntimeService<*>,
74 artifactTemplate: String,
75 resolutionKey: String): String {
76 return resolutionResultService.read(bluePrintRuntimeService, artifactTemplate, resolutionKey)
79 override suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
80 artifactNames: List<String>,
81 properties: Map<String, Any>): MutableMap<String, String> {
83 val resolvedParams: MutableMap<String, String> = hashMapOf()
84 artifactNames.forEach { artifactName ->
85 val resolvedContent = resolveResources(bluePrintRuntimeService, nodeTemplateName, artifactName, properties)
86 resolvedParams[artifactName] = resolvedContent
91 override suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
92 artifactPrefix: String, properties: Map<String, Any>): String {
94 // Velocity Artifact Definition Name
95 val artifactTemplate = "$artifactPrefix-template"
96 // Resource Assignment Artifact Definition Name
97 val artifactMapping = "$artifactPrefix-mapping"
99 val result = resolveResources(bluePrintRuntimeService, nodeTemplateName, artifactMapping, artifactTemplate)
101 if (properties.containsKey(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT)
102 && properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT] as Boolean) {
103 resolutionResultService.write(properties, result, bluePrintRuntimeService, artifactPrefix)
104 log.info("resolution saved into database successfully : ($properties)")
111 override suspend fun resolveResources(bluePrintRuntimeService: BluePrintRuntimeService<*>, nodeTemplateName: String,
112 artifactMapping: String, artifactTemplate: String?): String {
114 val resolvedContent: String
115 log.info("Resolving resource for template artifact($artifactTemplate) with resource assignment artifact($artifactMapping)")
117 val identifierName = artifactTemplate ?: "no-template"
119 val resourceAssignmentContent =
120 bluePrintRuntimeService.resolveNodeTemplateArtifact(nodeTemplateName, artifactMapping)
122 val resourceAssignments: MutableList<ResourceAssignment> =
123 JacksonUtils.getListFromJson(resourceAssignmentContent, ResourceAssignment::class.java)
124 as? MutableList<ResourceAssignment>
125 ?: throw BluePrintProcessorException("couldn't get Dictionary Definitions")
127 // Get the Resource Dictionary Name
128 val resourceDefinitions: MutableMap<String, ResourceDefinition> = ResourceAssignmentUtils
129 .resourceDefinitions(bluePrintRuntimeService.bluePrintContext().rootPath)
132 resolveResourceAssignments(bluePrintRuntimeService, resourceDefinitions, resourceAssignments, identifierName)
134 val resolvedParamJsonContent =
135 ResourceAssignmentUtils.generateResourceDataForAssignments(resourceAssignments.toList())
137 // Check Template is there
138 if (artifactTemplate != null) {
139 val templateContent =
140 bluePrintRuntimeService.resolveNodeTemplateArtifact(nodeTemplateName, artifactTemplate)
141 resolvedContent = BluePrintTemplateService.generateContent(templateContent, resolvedParamJsonContent)
143 resolvedContent = resolvedParamJsonContent
146 return resolvedContent
150 * Iterate the Batch, get the Resource Assignment, dictionary Name, Look for the Resource definition for the
151 * name, then get the type of the Resource Definition, Get the instance for the Resource Type and process the
154 override suspend fun resolveResourceAssignments(blueprintRuntimeService: BluePrintRuntimeService<*>,
155 resourceDefinitions: MutableMap<String, ResourceDefinition>,
156 resourceAssignments: MutableList<ResourceAssignment>,
157 identifierName: String) {
159 val bulkSequenced = BulkResourceSequencingUtils.process(resourceAssignments)
160 val resourceAssignmentRuntimeService =
161 ResourceAssignmentUtils.transformToRARuntimeService(blueprintRuntimeService, identifierName)
164 bulkSequenced.forEach { batchResourceAssignments ->
165 // Execute Non Dependent Assignments in parallel ( ie asynchronously )
166 val deferred = batchResourceAssignments.filter { it.name != "*" && it.name != "start" }
167 .map { resourceAssignment ->
169 val dictionaryName = resourceAssignment.dictionaryName
170 val dictionarySource = resourceAssignment.dictionarySource
172 * Get the Processor name
174 val processorName = processorName(dictionaryName!!, dictionarySource!!, resourceDefinitions)
176 val resourceAssignmentProcessor =
177 applicationContext.getBean(processorName) as? ResourceAssignmentProcessor
178 ?: throw BluePrintProcessorException("failed to get resource processor ($processorName) " +
179 "for resource assignment(${resourceAssignment.name})")
181 // Set BluePrint Runtime Service
182 resourceAssignmentProcessor.raRuntimeService = resourceAssignmentRuntimeService
183 // Set Resource Dictionaries
184 resourceAssignmentProcessor.resourceDictionaries = resourceDefinitions
185 // Invoke Apply Method
186 resourceAssignmentProcessor.applyNB(resourceAssignment)
187 // Set errors from RA
188 blueprintRuntimeService.setBluePrintError(resourceAssignmentRuntimeService.getBluePrintError())
189 } catch (e: RuntimeException) {
190 throw BluePrintProcessorException(e)
194 log.debug("Resolving (${deferred.size})resources parallel.")
203 * If the Source instance is "input", then it is not mandatory to have source Resource Definition, So it can
204 * derive the default input processor.
206 private fun processorName(dictionaryName: String, dictionarySource: String,
207 resourceDefinitions: MutableMap<String, ResourceDefinition>): String {
208 val processorName: String = when (dictionarySource) {
210 "${ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-input"
213 "${ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-default"
216 val resourceDefinition = resourceDefinitions[dictionaryName]
217 ?: throw BluePrintProcessorException("couldn't get resource dictionary definition for $dictionaryName")
219 val resourceSource = resourceDefinition.sources[dictionarySource]
220 ?: throw BluePrintProcessorException("couldn't get resource definition $dictionaryName source($dictionarySource)")
222 ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR.plus(resourceSource.type)
225 checkNotEmpty(processorName) {
226 "couldn't get processor name for resource dictionary definition($dictionaryName) source($dictionarySource)"