ms/blueprintsprocessor/modules/blueprints/blueprint-core/src/test/kotlin/org/onap/ccsdk/cds/controllerblueprints/core/dsl/BluePrintDSLTest.kt

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.controllerblueprints.core.dsl
  18
  19 import com.fasterxml.jackson.databind.JsonNode
  20 import org.junit.Test
  21 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintTypes
  22 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
  23 import org.onap.ccsdk.cds.controllerblueprints.core.data.NodeTemplate
  24 import org.onap.ccsdk.cds.controllerblueprints.core.jsonAsJsonType
  25 import kotlin.test.assertNotNull
  26
  27 class BluePrintDSLTest {
  28
  29     @Test
  30     fun testOperationDSLWorkflow() {
  31
  32         val blueprint = blueprint(
  33             "sample-bp", "1.0.0",
  34             "brindasanth@onap.com", "sample, blueprints"
  35         ) {
  36
  37             artifactType(BluePrintTypes.artifactTypeTemplateVelocity())
  38
  39             // For New Component Definition
  40             component(
  41                 "resource-resolution", "component-script-executor", "1.0.0",
  42                 "Resource Resolution component."
  43             ) {
  44                 implementation(180)
  45                 // Attributes ( Properties which will be set during execution)
  46                 attribute("template1-data", "string", true, "")
  47
  48                 // Properties
  49                 property("string-value1", "string", true, "sample")
  50                 property("string-value2", "string", true, getInput("key-1"))
  51                 // Inputs
  52                 input("json-content", "json", true, """{ "name" : "cds"}""")
  53                 input("template-content", "string", true, getArtifact("template1"))
  54                 // Outputs
  55                 output("self-attribute-expression", "json", true, getAttribute("template1-data"))
  56                 // Artifacts
  57                 artifact("template1", "artifact-template-velocity", "Templates/template1.vtl")
  58             }
  59
  60             // Already definitions Registered Components
  61             registryComponent(
  62                 "activate-restconf", "component-resource-resolution", "1.0.0",
  63                 "RestconfExecutor", "Resource Resolution component."
  64             ) {
  65                 implementation(180)
  66                 // Properties
  67                 property("string-value1", "data")
  68                 // Inputs
  69                 input("json-content", """{ "name" : "cds"}""")
  70                 // Outputs
  71                 output("self-attribute-expression", getAttribute("template1-data"))
  72                 // Artifacts
  73                 artifact("template2", "artifact-template-velocity", "Templates/template1.vtl")
  74             }
  75
  76             workflow("resource-resolution-process", "Resource Resolution wf") {
  77                 input("json-content", "json", true, "")
  78                 input("key-1", "string", true, "")
  79                 output("status", "string", true, "success")
  80                 step("resource-resolution-call", "resource-resolution", "Resource Resolution component invoke")
  81             }
  82         }
  83         assertNotNull(blueprint.components, "failed to get components")
  84         assertNotNull(blueprint.workflows, "failed to get workflows")
  85         // println(blueprint.asJsonString(true))
  86
  87         val serviceTemplateGenerator = BluePrintServiceTemplateGenerator(blueprint)
  88         val serviceTemplate = serviceTemplateGenerator.serviceTemplate()
  89         assertNotNull(serviceTemplate.topologyTemplate, "failed to get service topology template")
  90         // println(serviceTemplate.asJsonString(true))
  91     }
  92
  93     @Test
  94     fun testServiceTemplate() {
  95         val serviceTemplate = serviceTemplate(
  96             "sample-bp", "1.0.0",
  97             "brindasanth@onap.com", "sample, blueprints"
  98         ) {
  99             metadata("release", "1806")
 100             import("Definition/data_types.json")
 101             dsl("rest-endpoint", """{ "selector" : "odl-selector"}""")
 102             dsl("db-endpoint", """{ "selector" : "db-selector"}""")
 103
 104             nodeTypeComponent()
 105             nodeTypeResourceSource()
 106             nodeTypeVnf()
 107
 108             artifactTypeTemplateVelocity()
 109             artifactTypeTempleJinja()
 110             artifactTypeScriptKotlin()
 111             artifactTypeMappingResource()
 112             artifactTypeComponentJar()
 113
 114             relationshipTypeConnectsTo()
 115             relationshipTypeDependsOn()
 116             relationshipTypeHostedOn()
 117
 118             topologyTemplate {
 119                 nodeTemplateOperation(
 120                     nodeTemplateName = "activate", type = "sample-node-type", interfaceName = "RestconfExecutor",
 121                     description = "sample activation"
 122                 ) {
 123                     implementation(360, "SELF") {
 124                         primary("Scripts/sample.py")
 125                         dependencies("one", "two")
 126                     }
 127                     inputs {
 128                         property("json-content", """{ "name" : "cds"}""")
 129                         property("array-content", """["controller", "blueprints"]""")
 130                         property("int-value", 234)
 131                         property("boolean-value", true)
 132                         property("string-value", "sample")
 133                         property("input-expression", getInput("key-1"))
 134                         property("self-property-expression", getProperty("key-1"))
 135                         property("self-artifact-expression", getArtifact("key-1"))
 136                         property("other-artifact-expression", getNodeTemplateArtifact("node-1", "key-1"))
 137                     }
 138                     outputs {
 139                         property("self-attribute-expression", getAttribute("key-1"))
 140                     }
 141                 }
 142                 // Other way of defining Node Template with artifacts, implementation
 143                 nodeTemplate("resolve", "sample-resolve-type", "Resource Resolution") {
 144                     operation("ResourceResolutionExecutor", "") {
 145                         implementation(180)
 146                         inputs {
 147                             property("boolean-value", true)
 148                             property("string-value", "sample")
 149                         }
 150                         outputs {
 151                             property("resolve-expression", getAttribute("key-1"))
 152                         }
 153                     }
 154                     artifact("sample-template", "artifact-velocity", "Templates/sample-template.vtl")
 155                 }
 156
 157                 workflow("resource-resolution", "to resolve resources") {
 158                     step("resource-resolution-call", "resolve", "Resource Resolution component invoke")
 159                 }
 160                 // Alternate way to define workflow
 161                 workflow("activate", "to resolve resources") {
 162                     // Alternate step definition
 163                     step("netconf-activate-call", "activate", "call activation component") {
 164                         success("END")
 165                         failure("END")
 166                     }
 167                     inputs {
 168                         property("request-content", "json", true)
 169                     }
 170                     outputs {
 171                         property("response-content", "json", true) {
 172                             value(getAttribute("key-1"))
 173                             defaultValue("""{ "status" : "success"}""".jsonAsJsonType())
 174                         }
 175                     }
 176                 }
 177             }
 178         }
 179
 180         // println(serviceTemplate.asJsonString(true))
 181         assertNotNull(serviceTemplate.artifactTypes, "failed to get artifactTypes")
 182         assertNotNull(serviceTemplate.nodeTypes, "failed to get nodeTypes")
 183         assertNotNull(serviceTemplate.relationshipTypes, "failed to get relationshipTypes")
 184         assertNotNull(serviceTemplate.topologyTemplate, "failed to get topology template")
 185         assertNotNull(serviceTemplate.topologyTemplate?.nodeTemplates, "failed to get nodeTypes")
 186         assertNotNull(
 187             serviceTemplate.topologyTemplate?.nodeTemplates!!["activate"],
 188             "failed to get nodeTypes(activate)"
 189         )
 190     }
 191
 192     @Test
 193     fun testNodeTypePropertyConstrains() {
 194         val nodeType = nodeType("data-node", "1.0.0", "tosca.Nodes.root", "") {
 195             property("ip-address", "string", true, "") {
 196                 defaultValue("127.0.0.1")
 197                 constrain {
 198                     validValues(arrayListOf("""127.0.0.1""".asJsonPrimitive()))
 199                     length(10)
 200                     maxLength(20)
 201                     minLength(10)
 202                 }
 203             }
 204             property("disk-space", "string", true, "") {
 205                 defaultValue(10)
 206                 constrain {
 207                     validValues("""["200KB", "400KB"]""")
 208                     equal("200KB")
 209                     inRange("""["100KB", "500KB" ]""")
 210                     maxLength("10MB")
 211                     minLength("10KB")
 212                 }
 213                 constrain {
 214                     validValues("""[ 200, 400]""")
 215                     greaterOrEqual("10KB")
 216                     greaterThan("20KB")
 217                     lessOrEqual("200KB")
 218                     lessThan("190KB")
 219                 }
 220             }
 221         }
 222         assertNotNull(nodeType, "failed to get nodeType")
 223         // println(nodeType.asJsonString(true))
 224     }
 225
 226     @Test
 227     fun testServiceTemplateWorkflow() {
 228         val serviceTemplate = serviceTemplate(
 229             "sample-bp", "1.0.0",
 230             "brindasanth@onap.com", "sample, blueprints"
 231         ) {
 232             topologyTemplate {
 233                 workflowNodeTemplate("activate", "component-resource-resolution", "") {
 234                     operation("ResourceResolutionExecutor", "") {
 235                         inputs {
 236                             property("string-value", "sample")
 237                         }
 238                     }
 239                 }
 240             }
 241         }
 242         assertNotNull(serviceTemplate.topologyTemplate, "failed to get topology template")
 243         assertNotNull(serviceTemplate.topologyTemplate?.workflows?.get("activate"), "failed to get workflow(activate)")
 244         // println(serviceTemplate.asJsonString(true))
 245     }
 246
 247     @Test
 248     fun testNodeTemplateOperationTypes() {
 249
 250         val testNodeTemplateInstance = BluePrintTypes.nodeTemplateComponentTestExecutor(
 251             id = "test-node-template",
 252             description = ""
 253         ) {
 254             definedProperties {
 255                 prop1("i am property1")
 256                 prop2("i am property2")
 257             }
 258             definedOperation("") {
 259                 implementation(360)
 260                 inputs {
 261                     request("i am request")
 262                 }
 263                 outputs {
 264                     response(getAttribute("attribute1"))
 265                 }
 266             }
 267         }
 268         assertNotNull(testNodeTemplateInstance, "failed to get test node template")
 269         // println(testNodeTemplateInstance.asJsonString(true))
 270     }
 271 }
 272
 273 fun BluePrintTypes.nodeTemplateComponentTestExecutor(
 274     id: String,
 275     description: String,
 276     block: TestNodeTemplateOperationImplBuilder.() -> Unit
 277 ):
 278     NodeTemplate {
 279     return TestNodeTemplateOperationImplBuilder(id, description).apply(block).build()
 280 }
 281
 282 class TestNodeTemplateOperationImplBuilder(id: String, description: String) :
 283     AbstractNodeTemplateOperationImplBuilder<TestProperty, TestInput, TestOutput>(
 284         id, "component-test-executor",
 285         "ComponentTestExecutor",
 286         description
 287     )
 288
 289 class TestProperty : PropertiesAssignmentBuilder() {
 290     fun prop1(prop1: String) {
 291         property("prop1", prop1.asJsonPrimitive())
 292     }
 293
 294     fun prop2(prop2: String) {
 295         property("prop2", prop2.asJsonPrimitive())
 296     }
 297 }
 298
 299 class TestInput : PropertiesAssignmentBuilder() {
 300     fun request(request: String) {
 301         property("request", request.asJsonPrimitive())
 302     }
 303 }
 304
 305 class TestOutput : PropertiesAssignmentBuilder() {
 306     fun response(response: String) {
 307         response(response.asJsonPrimitive())
 308     }
 309
 310     fun response(response: JsonNode) {
 311         property("response", response)
 312     }
 313 }