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

   1 /*
   2  *  Copyright © 2017-2018 AT&T Intellectual Property.
   3  *  Modifications Copyright © 2018-2019 IBM, Bell Canada
   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.blueprintsprocessor.functions.resource.resolution
  19
  20 import com.fasterxml.jackson.databind.JsonNode
  21 import kotlinx.coroutines.async
  22 import kotlinx.coroutines.awaitAll
  23 import kotlinx.coroutines.coroutineScope
  24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.ResourceResolution
  25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.ResourceResolutionDBService
  26 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db.TemplateResolutionService
  27 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor.ResourceAssignmentProcessor
  28 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
  29 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceDefinitionUtils.createResourceAssignments
  30 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  31 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  32 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
  33 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonType
  34 import org.onap.ccsdk.cds.controllerblueprints.core.checkNotEmpty
  35 import org.onap.ccsdk.cds.controllerblueprints.core.common.ApplicationConstants.LOG_REDACTED
  36 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintRuntimeService
  37 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintTemplateService
  38 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  39 import org.onap.ccsdk.cds.controllerblueprints.core.utils.PropertyDefinitionUtils.Companion.hasLogProtect
  40 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
  41 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDefinition
  42 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.utils.BulkResourceSequencingUtils
  43 import org.slf4j.LoggerFactory
  44 import org.springframework.context.ApplicationContext
  45 import org.springframework.stereotype.Service
  46 import java.util.UUID
  47
  48 interface ResourceResolutionService {
  49
  50     fun registeredResourceSources(): List<String>
  51
  52     suspend fun resolveFromDatabase(
  53         bluePrintRuntimeService: BluePrintRuntimeService<*>,
  54         artifactTemplate: String,
  55         resolutionKey: String
  56     ): String
  57
  58     suspend fun resolveResources(
  59         bluePrintRuntimeService: BluePrintRuntimeService<*>,
  60         nodeTemplateName: String,
  61         artifactNames: List<String>,
  62         properties: Map<String, Any>
  63     ): MutableMap<String, String>
  64
  65     suspend fun resolveResources(
  66         bluePrintRuntimeService: BluePrintRuntimeService<*>,
  67         nodeTemplateName: String,
  68         artifactPrefix: String,
  69         properties: Map<String, Any>
  70     ): String
  71
  72     /** Resolve resources for all the sources defined in a particular resource Definition[resolveDefinition]
  73      * with other [resourceDefinitions] dependencies for the sources [sources]
  74      * Used to get the same resource values from multiple sources. **/
  75     suspend fun resolveResourceDefinition(
  76         blueprintRuntimeService: BluePrintRuntimeService<*>,
  77         resourceDefinitions: MutableMap<String, ResourceDefinition>,
  78         resolveDefinition: String,
  79         sources: List<String>
  80     ):
  81             MutableMap<String, JsonNode>
  82
  83     suspend fun resolveResourceAssignments(
  84         blueprintRuntimeService: BluePrintRuntimeService<*>,
  85         resourceDefinitions: MutableMap<String, ResourceDefinition>,
  86         resourceAssignments: MutableList<ResourceAssignment>,
  87         artifactPrefix: String,
  88         properties: Map<String, Any>
  89     )
  90 }
  91
  92 @Service(ResourceResolutionConstants.SERVICE_RESOURCE_RESOLUTION)
  93 open class ResourceResolutionServiceImpl(
  94     private var applicationContext: ApplicationContext,
  95     private var templateResolutionDBService: TemplateResolutionService,
  96     private var blueprintTemplateService: BluePrintTemplateService,
  97     private var resourceResolutionDBService: ResourceResolutionDBService
  98 ) :
  99     ResourceResolutionService {
 100
 101     private val log = LoggerFactory.getLogger(ResourceResolutionService::class.java)
 102
 103     override fun registeredResourceSources(): List<String> {
 104         return applicationContext.getBeanNamesForType(ResourceAssignmentProcessor::class.java)
 105             .filter { it.startsWith(ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR) }
 106             .map { it.substringAfter(ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR) }
 107     }
 108
 109     override suspend fun resolveFromDatabase(
 110         bluePrintRuntimeService: BluePrintRuntimeService<*>,
 111         artifactTemplate: String,
 112         resolutionKey: String
 113     ): String {
 114         return templateResolutionDBService.findByResolutionKeyAndBlueprintNameAndBlueprintVersionAndArtifactName(
 115             bluePrintRuntimeService,
 116             artifactTemplate,
 117             resolutionKey
 118         )
 119     }
 120
 121     override suspend fun resolveResources(
 122         bluePrintRuntimeService: BluePrintRuntimeService<*>,
 123         nodeTemplateName: String,
 124         artifactNames: List<String>,
 125         properties: Map<String, Any>
 126     ): MutableMap<String, String> {
 127
 128         val resourceAssignmentRuntimeService =
 129             ResourceAssignmentUtils.transformToRARuntimeService(bluePrintRuntimeService, artifactNames.toString())
 130
 131         val resolvedParams: MutableMap<String, String> = hashMapOf()
 132         artifactNames.forEach { artifactName ->
 133             val resolvedContent = resolveResources(
 134                 resourceAssignmentRuntimeService, nodeTemplateName,
 135                 artifactName, properties
 136             )
 137
 138             resolvedParams[artifactName] = resolvedContent
 139         }
 140         return resolvedParams
 141     }
 142
 143     override suspend fun resolveResources(
 144         bluePrintRuntimeService: BluePrintRuntimeService<*>,
 145         nodeTemplateName: String,
 146         artifactPrefix: String,
 147         properties: Map<String, Any>
 148     ): String {
 149
 150         // Velocity Artifact Definition Name
 151         val artifactTemplate = "$artifactPrefix-template"
 152         // Resource Assignment Artifact Definition Name
 153         val artifactMapping = "$artifactPrefix-mapping"
 154
 155         val resolvedContent: String
 156         log.info("Resolving resource for template artifact($artifactTemplate) with resource assignment artifact($artifactMapping)")
 157
 158         val resourceAssignmentContent =
 159             bluePrintRuntimeService.resolveNodeTemplateArtifact(nodeTemplateName, artifactMapping)
 160
 161         val resourceAssignments: MutableList<ResourceAssignment> =
 162             JacksonUtils.getListFromJson(resourceAssignmentContent, ResourceAssignment::class.java)
 163                     as? MutableList<ResourceAssignment>
 164                 ?: throw BluePrintProcessorException("couldn't get Dictionary Definitions")
 165
 166         if (isToStore(properties)) {
 167             val existingResourceResolution = isNewResolution(bluePrintRuntimeService, properties, artifactPrefix)
 168             if (existingResourceResolution.isNotEmpty()) {
 169                 updateResourceAssignmentWithExisting(
 170                     bluePrintRuntimeService as ResourceAssignmentRuntimeService,
 171                     existingResourceResolution, resourceAssignments
 172                 )
 173             }
 174         }
 175
 176         // Get the Resource Dictionary Name
 177         val resourceDefinitions: MutableMap<String, ResourceDefinition> = ResourceAssignmentUtils
 178             .resourceDefinitions(bluePrintRuntimeService.bluePrintContext().rootPath)
 179
 180         // Resolve resources
 181         resolveResourceAssignments(
 182             bluePrintRuntimeService,
 183             resourceDefinitions,
 184             resourceAssignments,
 185             artifactPrefix,
 186             properties
 187         )
 188
 189         val resolvedParamJsonContent =
 190             ResourceAssignmentUtils.generateResourceDataForAssignments(resourceAssignments.toList())
 191
 192         resolvedContent = blueprintTemplateService.generateContent(
 193             bluePrintRuntimeService, nodeTemplateName,
 194             artifactTemplate, resolvedParamJsonContent, false,
 195             mutableMapOf(
 196                 ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE to
 197                         properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE].asJsonPrimitive()
 198             )
 199         )
 200
 201         if (isToStore(properties)) {
 202             templateResolutionDBService.write(properties, resolvedContent, bluePrintRuntimeService, artifactPrefix)
 203             log.info("Template resolution saved into database successfully : ($properties)")
 204         }
 205
 206         return resolvedContent
 207     }
 208
 209     override suspend fun resolveResourceDefinition(
 210         blueprintRuntimeService: BluePrintRuntimeService<*>,
 211         resourceDefinitions: MutableMap<String, ResourceDefinition>,
 212         resolveDefinition: String,
 213         sources: List<String>
 214     ):
 215             MutableMap<String, JsonNode> {
 216
 217         // Populate Dummy Resource Assignments
 218         val resourceAssignments = createResourceAssignments(resourceDefinitions, resolveDefinition, sources)
 219
 220         resolveResourceAssignments(
 221             blueprintRuntimeService, resourceDefinitions, resourceAssignments,
 222             UUID.randomUUID().toString(), hashMapOf()
 223         )
 224
 225         // Get the data from Resource Assignments
 226         return ResourceAssignmentUtils.generateResourceForAssignments(resourceAssignments)
 227     }
 228
 229     /**
 230      * Iterate the Batch, get the Resource Assignment, dictionary Name, Look for the Resource definition for the
 231      * name, then get the type of the Resource Definition, Get the instance for the Resource Type and process the
 232      * request.
 233      */
 234     override suspend fun resolveResourceAssignments(
 235         blueprintRuntimeService: BluePrintRuntimeService<*>,
 236         resourceDefinitions: MutableMap<String, ResourceDefinition>,
 237         resourceAssignments: MutableList<ResourceAssignment>,
 238         artifactPrefix: String,
 239         properties: Map<String, Any>
 240     ) {
 241
 242         val bulkSequenced = BulkResourceSequencingUtils.process(resourceAssignments)
 243
 244         // Check the BlueprintRuntime Service Should be ResourceAssignmentRuntimeService
 245         val resourceAssignmentRuntimeService = if (blueprintRuntimeService !is ResourceAssignmentRuntimeService) {
 246             ResourceAssignmentUtils.transformToRARuntimeService(blueprintRuntimeService, artifactPrefix)
 247         } else {
 248             blueprintRuntimeService
 249         }
 250
 251         exposeOccurrencePropertyInResourceAssignments(resourceAssignmentRuntimeService, properties)
 252
 253         coroutineScope {
 254             bulkSequenced.forEach { batchResourceAssignments ->
 255                 // Execute Non Dependent Assignments in parallel ( ie asynchronously )
 256                 val deferred = batchResourceAssignments
 257                     .filter { it.name != "*" && it.name != "start" }
 258                     .filter { it.status != BluePrintConstants.STATUS_SUCCESS }
 259                     .map { resourceAssignment ->
 260                         async {
 261                             val dictionaryName = resourceAssignment.dictionaryName
 262                             val dictionarySource = resourceAssignment.dictionarySource
 263
 264                             val processorName = processorName(dictionaryName!!, dictionarySource!!, resourceDefinitions)
 265
 266                             val resourceAssignmentProcessor =
 267                                 applicationContext.getBean(processorName) as? ResourceAssignmentProcessor
 268                                     ?: throw BluePrintProcessorException(
 269                                         "failed to get resource processor ($processorName) " +
 270                                                 "for resource assignment(${resourceAssignment.name})"
 271                                     )
 272                             try {
 273                                 // Set BluePrint Runtime Service
 274                                 resourceAssignmentProcessor.raRuntimeService = resourceAssignmentRuntimeService
 275                                 // Set Resource Dictionaries
 276                                 resourceAssignmentProcessor.resourceDictionaries = resourceDefinitions
 277                                 // Invoke Apply Method
 278                                 resourceAssignmentProcessor.applyNB(resourceAssignment)
 279
 280                                 if (isToStore(properties)) {
 281                                     resourceResolutionDBService.write(
 282                                         properties,
 283                                         blueprintRuntimeService,
 284                                         artifactPrefix,
 285                                         resourceAssignment
 286                                     )
 287                                     log.info("Resource resolution saved into database successfully : (${resourceAssignment.name})")
 288                                 }
 289
 290                                 // Set errors from RA
 291                                 blueprintRuntimeService.setBluePrintError(resourceAssignmentRuntimeService.getBluePrintError())
 292                             } catch (e: RuntimeException) {
 293                                 log.error("Fail in processing ${resourceAssignment.name}", e)
 294                                 throw BluePrintProcessorException(e)
 295                             }
 296                         }
 297                     }
 298                 log.debug("Resolving (${deferred.size})resources parallel.")
 299                 deferred.awaitAll()
 300             }
 301         }
 302     }
 303
 304     /**
 305      * If the Source instance is "input", then it is not mandatory to have source Resource Definition, So it can
 306      *  derive the default input processor.
 307      */
 308     private fun processorName(
 309         dictionaryName: String,
 310         dictionarySource: String,
 311         resourceDefinitions: MutableMap<String, ResourceDefinition>
 312     ): String {
 313         val processorName: String = when (dictionarySource) {
 314             "input" -> {
 315                 "${ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-input"
 316             }
 317             "default" -> {
 318                 "${ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR}source-default"
 319             }
 320             else -> {
 321                 val resourceDefinition = resourceDefinitions[dictionaryName]
 322                     ?: throw BluePrintProcessorException("couldn't get resource dictionary definition for $dictionaryName")
 323
 324                 val resourceSource = resourceDefinition.sources[dictionarySource]
 325                     ?: throw BluePrintProcessorException("couldn't get resource definition $dictionaryName source($dictionarySource)")
 326
 327                 ResourceResolutionConstants.PREFIX_RESOURCE_RESOLUTION_PROCESSOR.plus(resourceSource.type)
 328             }
 329         }
 330         checkNotEmpty(processorName) {
 331             "couldn't get processor name for resource dictionary definition($dictionaryName) source($dictionarySource)"
 332         }
 333
 334         return processorName
 335     }
 336
 337     // Check whether to store or not the resolution of resource and template
 338     private fun isToStore(properties: Map<String, Any>): Boolean {
 339         return properties.containsKey(ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT) &&
 340                 properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_STORE_RESULT] as Boolean
 341     }
 342
 343     // Check whether resolution already exist in the database for the specified resolution-key or resourceId/resourceType
 344     private suspend fun isNewResolution(
 345         bluePrintRuntimeService: BluePrintRuntimeService<*>,
 346         properties: Map<String, Any>,
 347         artifactPrefix: String
 348     ): List<ResourceResolution> {
 349         val occurrence = properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE] as Int
 350         val resolutionKey = properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOLUTION_KEY] as String
 351         val resourceId = properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_ID] as String
 352         val resourceType = properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_RESOURCE_TYPE] as String
 353
 354         if (resolutionKey.isNotEmpty()) {
 355             val existingResourceAssignments =
 356                 resourceResolutionDBService.findByBlueprintNameAndBlueprintVersionAndArtifactNameAndResolutionKeyAndOccurrence(
 357                     bluePrintRuntimeService,
 358                     resolutionKey,
 359                     occurrence,
 360                     artifactPrefix
 361                 )
 362             if (existingResourceAssignments.isNotEmpty()) {
 363                 log.info(
 364                     "Resolution with resolutionKey=($resolutionKey) already exist - will resolve all resources not already resolved.",
 365                     resolutionKey
 366                 )
 367             }
 368             return existingResourceAssignments
 369         } else if (resourceId.isNotEmpty() && resourceType.isNotEmpty()) {
 370             val existingResourceAssignments =
 371                 resourceResolutionDBService.findByBlueprintNameAndBlueprintVersionAndArtifactNameAndResourceIdAndResourceTypeAndOccurrence(
 372                     bluePrintRuntimeService,
 373                     resourceId,
 374                     resourceType,
 375
 376                     occurrence,
 377                     artifactPrefix
 378                 )
 379             if (existingResourceAssignments.isNotEmpty()) {
 380                 log.info(
 381                     "Resolution with resourceId=($resourceId) and resourceType=($resourceType) already exist - will resolve " +
 382                             "all resources not already resolved."
 383                 )
 384             }
 385             return existingResourceAssignments
 386         }
 387         return emptyList()
 388     }
 389
 390     // Update the resource assignment list with the status of the resource that have already been resolved
 391     private fun updateResourceAssignmentWithExisting(
 392         raRuntimeService: ResourceAssignmentRuntimeService,
 393         resourceResolutionList: List<ResourceResolution>,
 394         resourceAssignmentList: MutableList<ResourceAssignment>
 395     ) {
 396         resourceResolutionList.forEach { resourceResolution ->
 397             if (resourceResolution.status == BluePrintConstants.STATUS_SUCCESS) {
 398                 resourceAssignmentList.forEach {
 399                     if (compareOne(resourceResolution, it)) {
 400                         log.info("Resource ({}) already resolved: value=({})", it.name,
 401                             if (hasLogProtect(it.property)) LOG_REDACTED else resourceResolution.value)
 402
 403                         // Make sure to recreate value as per the defined type.
 404                         val value = resourceResolution.value!!.asJsonType(it.property!!.type)
 405                         it.property!!.value = value
 406                         it.status = resourceResolution.status
 407                         ResourceAssignmentUtils.setResourceDataValue(it, raRuntimeService, value)
 408                     }
 409                 }
 410             }
 411         }
 412     }
 413
 414     // Comparision between what we have in the database vs what we have to assign.
 415     private fun compareOne(resourceResolution: ResourceResolution, resourceAssignment: ResourceAssignment): Boolean {
 416         return (resourceResolution.name == resourceAssignment.name &&
 417                 resourceResolution.dictionaryName == resourceAssignment.dictionaryName &&
 418                 resourceResolution.dictionarySource == resourceAssignment.dictionarySource &&
 419                 resourceResolution.dictionaryVersion == resourceAssignment.version)
 420     }
 421
 422     private fun exposeOccurrencePropertyInResourceAssignments(
 423         raRuntimeService: ResourceAssignmentRuntimeService,
 424         properties: Map<String, Any>
 425     ) {
 426         raRuntimeService.putResolutionStore(
 427             ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE,
 428             properties[ResourceResolutionConstants.RESOURCE_RESOLUTION_INPUT_OCCURRENCE].asJsonPrimitive()
 429         )
 430     }
 431 }