ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationService.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
  18 package org.onap.ccsdk.apps.controllerblueprints.resource.dict.service
  19
  20 import com.att.eelf.configuration.EELFLogger
  21 import com.att.eelf.configuration.EELFManager
  22 import org.apache.commons.collections.CollectionUtils
  23 import org.apache.commons.lang3.StringUtils
  24 import org.apache.commons.lang3.text.StrBuilder
  25 import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException
  26 import org.onap.ccsdk.apps.controllerblueprints.core.utils.TopologicalSortingUtils
  27 import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceAssignment
  28 import java.io.Serializable
  29
  30 /**
  31  * ResourceAssignmentValidationService.
  32  *
  33  * @author Brinda Santh
  34  */
  35 interface ResourceAssignmentValidationService : Serializable {
  36
  37     @Throws(BluePrintException::class)
  38     fun validate(resourceAssignments: List<ResourceAssignment>): Boolean
  39 }
  40
  41 /**
  42  * ResourceAssignmentValidationServiceImpl.
  43  *
  44  * @author Brinda Santh
  45  */
  46 open class ResourceAssignmentValidationServiceImpl : ResourceAssignmentValidationService {
  47     private val log: EELFLogger = EELFManager.getInstance().getLogger(ResourceAssignmentValidationServiceImpl::class.java)
  48
  49     open var resourceAssignmentMap: Map<String, ResourceAssignment> = hashMapOf()
  50     open val validationMessage = StrBuilder()
  51
  52     override fun validate(resourceAssignments: List<ResourceAssignment>): Boolean {
  53         try {
  54             validateTemplateNDictionaryKeys(resourceAssignments)
  55             validateCyclicDependency(resourceAssignments)
  56             if (StringUtils.isNotBlank(validationMessage)) {
  57                 throw BluePrintException("Resource Assignment Validation Failure")
  58             }
  59         } catch (e: Exception) {
  60             throw BluePrintException("Resource Assignment Validation :" + validationMessage.toString(), e)
  61         }
  62         return true
  63     }
  64
  65
  66     open fun validateTemplateNDictionaryKeys(resourceAssignments: List<ResourceAssignment>) {
  67
  68         resourceAssignmentMap = resourceAssignments.map { it.name to it }.toMap()
  69
  70         // Check the Resource Assignment has Duplicate Key Names
  71         val duplicateKeyNames = resourceAssignments.groupBy { it.name }
  72                 .filter { it.value.size > 1 }
  73                 .map { it.key }
  74
  75         if (duplicateKeyNames.isNotEmpty()) {
  76             validationMessage.appendln(String.format("Duplicate Assignment Template Keys (%s) is Present", duplicateKeyNames))
  77         }
  78
  79         // Collect all the dependencies as a single list
  80         val dependenciesNames = resourceAssignments.mapNotNull { it.dependencies }.flatten()
  81
  82         // Check all the dependencies keys have Resource Assignment mappings.
  83         val notPresentDictionaries = dependenciesNames.filter { !resourceAssignmentMap.containsKey(it) }.distinct()
  84         if (notPresentDictionaries.isNotEmpty()) {
  85             validationMessage.appendln(String.format("No assignments for Dictionary Keys (%s)", notPresentDictionaries))
  86         }
  87
  88         if (StringUtils.isNotBlank(validationMessage)) {
  89             throw BluePrintException("Resource Assignment Validation Failure")
  90         }
  91     }
  92
  93     open fun validateCyclicDependency(resourceAssignments: List<ResourceAssignment>) {
  94         val startResourceAssignment = ResourceAssignment()
  95         startResourceAssignment.name = "*"
  96
  97         val topologySorting = TopologicalSortingUtils<ResourceAssignment>()
  98
  99         resourceAssignmentMap.map { it.value }.map { resourceAssignment ->
 100             if (CollectionUtils.isNotEmpty(resourceAssignment.dependencies)) {
 101                 resourceAssignment.dependencies!!.map {
 102                     log.trace("Topological Graph link from {} to {}", it, resourceAssignment.name)
 103                     topologySorting.add(resourceAssignmentMap[it]!!, resourceAssignment)
 104                 }
 105             } else {
 106                 topologySorting.add(startResourceAssignment, resourceAssignment)
 107             }
 108         }
 109
 110         if (!topologySorting.isDag) {
 111             val graph = getTopologicalGraph(topologySorting)
 112             validationMessage.appendln("Cyclic Dependency :$graph")
 113         }
 114     }
 115
 116     open fun getTopologicalGraph(topologySorting: TopologicalSortingUtils<ResourceAssignment>): String {
 117         val s = StringBuilder()
 118         val neighbors = topologySorting.getNeighbors()
 119
 120         neighbors.forEach { v, vs ->
 121             if (v.name == "*") {
 122                 s.append("\n    * -> [")
 123                 for (resourceAssignment in vs) {
 124                     s.append("(" + resourceAssignment.dictionaryName + ":" + resourceAssignment.name
 125                             + "),")
 126                 }
 127                 s.append("]")
 128             } else {
 129                 s.append("\n    (" + v.dictionaryName + ":" + v.name + ") -> [")
 130                 for (resourceAssignment in vs) {
 131                     s.append("(" + resourceAssignment.dictionaryName + ":" + resourceAssignment.name
 132                             + "),")
 133                 }
 134                 s.append("]")
 135             }
 136         }
 137         return s.toString()
 138     }
 139
 140
 141 }