Controller Blueprints Microservice

Add Resource Assignment Validation Service and their Test cases.

Change-Id: I106be2bfc03115867041ca341947a4662cf126c4
Issue-ID: CCSDK-487
Signed-off-by: Muthuramalingam, Brinda Santh(bs2796) <bs2796@att.com>

6 files changed, 531 insertions, 3 deletions

diff --git a/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationService.kt b/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationService.kt
new file mode 100644
index 00000000..6809831f
--- /dev/null
+++ b/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationService.kt
@@ -0,0 +1,133 @@
+/*
+ *  Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ *  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.apps.controllerblueprints.resource.dict.service
+
+import org.apache.commons.lang3.text.StrBuilder
+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException
+import org.onap.ccsdk.apps.controllerblueprints.core.utils.TopologicalSortingUtils
+import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceAssignment
+import org.onap.ccsdk.apps.controllerblueprints.resource.dict.validator.ResourceAssignmentValidator
+import org.slf4j.LoggerFactory
+import org.apache.commons.collections.CollectionUtils
+import org.apache.commons.lang3.StringUtils
+import java.io.Serializable
+/**
+ * ResourceAssignmentValidationService.
+ *
+ * @author Brinda Santh
+ */
+interface ResourceAssignmentValidationService : Serializable {
+
+    @Throws(BluePrintException::class)
+    fun validate(resourceAssignments: List<ResourceAssignment>): Boolean
+}
+
+/**
+ * ResourceAssignmentValidationDefaultService.
+ *
+ * @author Brinda Santh
+ */
+open class ResourceAssignmentValidationDefaultService : ResourceAssignmentValidationService {
+    private val log = LoggerFactory.getLogger(ResourceAssignmentValidator::class.java)
+    open var resourceAssignments: List<ResourceAssignment> = arrayListOf()
+    open var resourceAssignmentMap: MutableMap<String, ResourceAssignment> = hashMapOf()
+    open val validationMessage = StrBuilder()
+
+    override fun validate(resourceAssignments: List<ResourceAssignment>): Boolean {
+        this.resourceAssignments = resourceAssignments
+        validateSources(resourceAssignments)
+        validateDuplicateDictionaryKeys()
+        validateCyclicDependency()
+        if (StringUtils.isNotBlank(validationMessage)) {
+            throw BluePrintException("Resource Assignment Validation :" + validationMessage.toString())
+        }
+        return true
+    }
+
+    open fun validateSources(resourceAssignments: List<ResourceAssignment>) {
+        log.info("validating resource assignment sources")
+    }
+
+    open fun validateDuplicateDictionaryKeys() {
+        val uniqueDictionaryKeys = hashSetOf<String>()
+
+        this.resourceAssignments.forEach { resourceAssignment ->
+            // Check Duplicate Names
+            if (!resourceAssignmentMap.containsKey(resourceAssignment.name)) {
+                resourceAssignmentMap[resourceAssignment.name] = resourceAssignment
+            } else {
+                validationMessage.appendln(String.format("Duplicate Assignment Template Key (%s) is Present",
+                        resourceAssignment.name))
+            }
+            // Check duplicate Dictionary Keys
+            if (!uniqueDictionaryKeys.contains(resourceAssignment.dictionaryName!!)) {
+                uniqueDictionaryKeys.add(resourceAssignment.dictionaryName!!)
+            } else {
+                validationMessage.appendln(
+                        String.format("Duplicate Assignment Dictionary Key (%s) present with Template Key (%s)",
+                                resourceAssignment.dictionaryName, resourceAssignment.name))
+            }
+        }
+    }
+
+    open fun validateCyclicDependency() {
+        val startResourceAssignment = ResourceAssignment()
+        startResourceAssignment.name = "*"
+
+        val topologySorting = TopologicalSortingUtils<ResourceAssignment>()
+        this.resourceAssignmentMap.forEach { assignmentKey, assignment ->
+            if (CollectionUtils.isNotEmpty(assignment.dependencies)) {
+                for (dependency in assignment.dependencies!!) {
+                    topologySorting.add(resourceAssignmentMap[dependency]!!, assignment)
+                }
+            } else {
+                topologySorting.add(startResourceAssignment, assignment)
+            }
+        }
+
+        if (!topologySorting.isDag) {
+            val graph = getTopologicalGraph(topologySorting)
+            validationMessage.appendln("Cyclic Dependency :$graph")
+        }
+    }
+
+    open fun getTopologicalGraph(topologySorting: TopologicalSortingUtils<ResourceAssignment>): String {
+        val s = StringBuilder()
+        val neighbors = topologySorting.getNeighbors()
+
+        neighbors.forEach { v, vs ->
+            if (v.name == "*") {
+                s.append("\n    * -> [")
+                for (resourceAssignment in vs) {
+                    s.append("(" + resourceAssignment.dictionaryName + ":" + resourceAssignment.name
+                            + "),")
+                }
+                s.append("]")
+            } else {
+                s.append("\n    (" + v.dictionaryName + ":" + v.name + ") -> [")
+                for (resourceAssignment in vs) {
+                    s.append("(" + resourceAssignment.dictionaryName + ":" + resourceAssignment.name
+                            + "),")
+                }
+                s.append("]")
+            }
+        }
+        return s.toString()
+    }
+
+
+}
\ No newline at end of file
diff --git a/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceDictionaryValidationService.kt b/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceDictionaryValidationService.kt
index 81bb37d0..e4835a06 100644
--- a/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceDictionaryValidationService.kt
+++ b/ms/controllerblueprints/modules/resource-dict/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceDictionaryValidationService.kt
@@ -31,15 +31,23 @@ import org.onap.ccsdk.apps.controllerblueprints.core.utils.JacksonUtils
 import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceDefinition
 import org.slf4j.LoggerFactory
 import java.io.Serializable
-
+/**
+ * ResourceDictionaryValidationService.
+ *
+ * @author Brinda Santh
+ */
 interface ResourceDictionaryValidationService : Serializable {
 
     @Throws(BluePrintException::class)
     fun validate(resourceDefinition: ResourceDefinition)
 
 }
-
-open class ResourceDictionaryDefaultValidationService(val bluePrintRepoService: BluePrintRepoService) : ResourceDictionaryValidationService {
+/**
+ * ResourceDictionaryDefaultValidationService.
+ *
+ * @author Brinda Santh
+ */
+open class ResourceDictionaryDefaultValidationService(private val bluePrintRepoService: BluePrintRepoService) : ResourceDictionaryValidationService {
 
     private val log = LoggerFactory.getLogger(ResourceDictionaryDefaultValidationService::class.java)
 
diff --git a/ms/controllerblueprints/modules/resource-dict/src/test/java/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationServiceTest.kt b/ms/controllerblueprints/modules/resource-dict/src/test/java/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationServiceTest.kt
new file mode 100644
index 00000000..4d8301f4
--- /dev/null
+++ b/ms/controllerblueprints/modules/resource-dict/src/test/java/org/onap/ccsdk/apps/controllerblueprints/resource/dict/service/ResourceAssignmentValidationServiceTest.kt
@@ -0,0 +1,56 @@
+/*

+ *  Copyright © 2017-2018 AT&T Intellectual Property.

+ *

+ *  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.apps.controllerblueprints.resource.dict.service

+

+import org.junit.Assert

+import org.junit.Test

+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException

+import org.onap.ccsdk.apps.controllerblueprints.core.utils.JacksonUtils

+import org.onap.ccsdk.apps.controllerblueprints.resource.dict.ResourceAssignment

+import org.slf4j.LoggerFactory

+/**

+ * ResourceAssignmentValidationServiceTest.

+ *

+ * @author Brinda Santh

+ */

+class ResourceAssignmentValidationServiceTest {

+    private val log = LoggerFactory.getLogger(ResourceAssignmentValidationServiceTest::class.java)

+    @Test

+    fun testValidateSuccess() {

+        log.info("**************** testValidateSuccess *****************")

+        val assignments = JacksonUtils.getListFromClassPathFile("validation/success.json", ResourceAssignment::class.java)

+        val resourceAssignmentValidator = ResourceAssignmentValidationDefaultService()

+        val result = resourceAssignmentValidator.validate(assignments!!)

+        Assert.assertTrue("Failed to Validate", result)

+    }

+

+    @Test(expected = BluePrintException::class)

+    fun testValidateDuplicate() {

+        log.info(" **************** testValidateDuplicate *****************")

+        val assignments = JacksonUtils.getListFromClassPathFile("validation/duplicate.json", ResourceAssignment::class.java)

+        val resourceAssignmentValidator = ResourceAssignmentValidationDefaultService()

+        resourceAssignmentValidator.validate(assignments!!)

+    }

+

+    @Test(expected = BluePrintException::class)

+    fun testValidateCyclic() {

+        log.info(" ****************  testValidateCyclic *****************")

+        val assignments = JacksonUtils.getListFromClassPathFile("validation/cyclic.json", ResourceAssignment::class.java)

+        val resourceAssignmentValidator = ResourceAssignmentValidationDefaultService()

+        resourceAssignmentValidator.validate(assignments!!)

+    }

+}
\ No newline at end of file
diff --git a/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/cyclic.json b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/cyclic.json
new file mode 100644
index 00000000..d837dc5d
--- /dev/null
+++ b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/cyclic.json
@@ -0,0 +1,111 @@
+[

+  {

+    "name": "vnf-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "service-instance-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "service-instance-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "bundle-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-id",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-ip",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-ip",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-mac",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "bundle-mac",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id",

+      "bundle-id"

+    ]

+  },

+  {

+    "name": "managed-ip",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "managed-ip",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "vnf-name",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-name",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "managed-ip1",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "managed-ip1",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "loopback-ip",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "loopback-ip",

+    "dictionary-source": "db",

+    "dependencies": [

+      "bundle-mac",

+      "managed-ip1"

+    ]

+  }

+]

diff --git a/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/duplicate.json b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/duplicate.json
new file mode 100644
index 00000000..330324cd
--- /dev/null
+++ b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/duplicate.json
@@ -0,0 +1,110 @@
+[

+  {

+    "name": "vnf-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "service-instance-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "service-instance-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "bundle-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-id",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-ip",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-ip",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-mac",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "bundle-mac",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id",

+      "bundle-id"

+    ]

+  },

+  {

+    "name": "bundle-mac",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "bundle-mac",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "vnf-name",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-name",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "managed-ip1",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "managed-ip1",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "loopback-ip",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "loopback-ip",

+    "dictionary-source": "db",

+    "dependencies": [

+      "bundle-mac"

+    ]

+  }

+]

diff --git a/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/success.json b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/success.json
new file mode 100644
index 00000000..3215d06d
--- /dev/null
+++ b/ms/controllerblueprints/modules/resource-dict/src/test/resources/validation/success.json
@@ -0,0 +1,110 @@
+[

+  {

+    "name": "vnf-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "service-instance-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "service-instance-id",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "bundle-id",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-id",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-ip",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "bundle-ip",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id"

+    ]

+  },

+  {

+    "name": "bundle-mac",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "bundle-mac",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "vnf-id",

+      "bundle-id"

+    ]

+  },

+  {

+    "name": "managed-ip",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "managed-ip",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "vnf-name",

+    "input-param": true,

+    "property": {

+      "type": "string",

+      "required": true

+    },

+    "dictionary-name": "vnf-name",

+    "dictionary-source": "input",

+    "dependencies": []

+  },

+  {

+    "name": "managed-ip1",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "managed-ip1",

+    "dictionary-source": "mdsal",

+    "dependencies": [

+      "loopback-ip"

+    ]

+  },

+  {

+    "name": "loopback-ip",

+    "input-param": true,

+    "property": {

+      "type": "string"

+    },

+    "dictionary-name": "loopback-ip",

+    "dictionary-source": "db",

+    "dependencies": [

+      "bundle-mac"

+    ]

+  }

+]