CBA Velocity Template - Testing

This guide will show how to validate CBA velocity Templates.

Add pom.xml to your CBA

^.
^{├── Definitions
│   └── hello_world.json}
^{├── Templates
│   └── base-config-data-velocity.json}
^{│   └── base-config-velocity-template.vtl}
^{│ └── default-variable-value-data.json}
^{│ └── default-variable-value-velocity-template.vtl}
^{├── TOSCA-Metadata
│   └── TOSCA.meta
├── pom.xml}

pom.xml

pom.xml

^{<?xml version="1.0" encoding="UTF-8"?>}
^
^{<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">}
^{<modelVersion>4.0.0</modelVersion>}

^<parent>
^{<groupId>org.onap.ccsdk.cds.components.cba</groupId>}
^{<artifactId>blueprint-model</artifactId>}
^{<version>1.3.0-SNAPSHOT</version>}
^</parent>

^{<artifactId>hello_world_1.0.0-CBA</artifactId>}
^{<packaging>pom</packaging>}

^{<name>Components Model Catalog - Blueprints Model - hello_world_1.0.0 Parent</name>}

^<properties>
^{<kotlin.version>1.6.20-RC</kotlin.version>}
^{</properties>}
^{<dependencies>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.modules</groupId>}
^{<artifactId>execution-service</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>}
^{<artifactId>resource-resolution</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>}
^{<artifactId>netconf-executor</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>}
^{<artifactId>restconf-executor</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>}
^{<artifactId>cli-executor</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>}
^{<artifactId>message-prioritization</artifactId>}
^{</dependency>}
^<dependency>
^{<groupId>org.jetbrains.kotlin</groupId>}
^{<artifactId>kotlin-test-junit</artifactId>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>org.jetbrains.kotlinx</groupId>}
^{<artifactId>kotlinx-coroutines-test</artifactId>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>junit</groupId>}
^{<artifactId>junit</artifactId>}
^{<version>4.13.2</version>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>io.mockk</groupId>}
^{<artifactId>mockk</artifactId>}
^{<version>1.10.0</version>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>com.squareup.okhttp3</groupId>}
^{<artifactId>okhttp</artifactId>}
^{<version>3.14.0</version>}
^{</dependency>}
^<dependency>
^{<groupId>junit</groupId>}
^{<artifactId>junit</artifactId>}
^{<version>4.13</version>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>org.jetbrains.kotlin</groupId>}
^{<artifactId>kotlin-stdlib-jdk8</artifactId>}
^{<version>${kotlin.version}</version>}
^{</dependency>}
^<dependency>
^{<groupId>org.jetbrains.kotlin</groupId>}
^{<artifactId>kotlin-test</artifactId>}
^{<version>${kotlin.version}</version>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.blueprintsprocessor.modules</groupId>}
^{<artifactId>blueprint-core</artifactId>}
^{<version>1.3.0-SNAPSHOT</version>}
^{</dependency>}
^<dependency>
^{<groupId>org.testng</groupId>}
^{<artifactId>testng</artifactId>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>org.testng</groupId>}
^{<artifactId>testng</artifactId>}
^{<scope>test</scope>}
^{</dependency>}
^<dependency>
^{<groupId>org.apache.velocity</groupId>}
^{<artifactId>velocity</artifactId>}
^{<version>1.5</version>}
^{</dependency>}
^{</dependencies>}

^<build>
^{<sourceDirectory>src/kotlin</sourceDirectory>}
^<resources>
^<resource>
^{<directory>${project.basedir}/Environments</directory>}
^</resource>
^</resources>
^<plugins>
^<plugin>
^{<groupId>org.jacoco</groupId>}
^{<artifactId>jacoco-maven-plugin</artifactId>}
^<executions>
^<execution>
^{<id>pre-unit-test</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>default-prepare-agent</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>post-unit-test</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>default-report</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>pre-integration-test</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>post-integration-test</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>default-check</id>}
^{<phase>none</phase>}
^</execution>
^{</executions>}
^</plugin>
^<plugin>
^{<groupId>org.jetbrains.kotlin</groupId>}
^{<artifactId>kotlin-maven-plugin</artifactId>}
^{<version>${kotlin.version}</version>}
^<executions>
^<execution>
^{<id>compile</id>}
^{<phase>compile</phase>}
^<goals>
^{<goal>compile</goal>}
^</goals>
^</execution>
^<execution>
^{<id>test-compile</id>}
^{<phase>test-compile</phase>}
^<goals>
^{<goal>test-compile</goal>}
^</goals>
^</execution>
^{</executions>}
^{<configuration>}
^{<jvmTarget>1.8</jvmTarget>}
^{</configuration>}
^</plugin>
^<plugin>
^{<groupId>org.apache.maven.plugins</groupId>}
^{<artifactId>maven-site-plugin</artifactId>}
^<executions>
^<execution>
^{<id>attach-descriptor</id>}
^{<phase>none</phase>}
^</execution>
^{</executions>}
^</plugin>
^<plugin>
^{<artifactId>maven-checkstyle-plugin</artifactId>}
^<executions>
^<execution>
^{<id>check-license</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>check-style</id>}
^{<phase>none</phase>}
^</execution>
^{</executions>}
^</plugin>
^<plugin>
^{<artifactId>maven-assembly-plugin</artifactId>}
^{<dependencies>}
^<dependency>
^{<groupId>org.onap.ccsdk.cds.components.cba</groupId>}
^{<artifactId>cba-assembly-descriptor</artifactId>}
^{<version>${ccsdk.cds.version}</version>}
^<exclusions>
^<exclusion>
^{<groupId>*</groupId>}
^{<artifactId>*</artifactId>}
^</exclusion>
^{</exclusions>}
^{</dependency>}
^{</dependencies>}
^<executions>
^<execution>
^{<id>make-assembly</id>}
^{<phase>package</phase>}
^<goals>
^{<goal>single</goal>}
^</goals>
^{<configuration>}
^{<descriptorRefs>}
^{<descriptorRef>cba_zip</descriptorRef>}
^{</descriptorRefs>}
^{</configuration>}
^</execution>
^{</executions>}
^</plugin>
^<plugin>
^{<groupId>org.apache.maven.plugins</groupId>}
^{<artifactId>maven-failsafe-plugin</artifactId>}
^<executions>
^<execution>
^{<id>default</id>}
^{<phase>none</phase>}
^</execution>
^<execution>
^{<id>integration-tests</id>}
^{<phase>none</phase>}
^</execution>
^{</executions>}
^</plugin>
^<plugin>
^{<artifactId>maven-surefire-plugin</artifactId>}
^<executions>
^<execution>
^{<id>default-test</id>}
^{<phase>test</phase>}
^<goals>
^{<goal>test</goal>}
^</goals>
^</execution>
^{</executions>}
^</plugin>
^</plugins>
^</build>

^<profiles>
^<profile>
^{<id>deploy-cba</id>}
^<build>
^<plugins>
^<plugin>
^{<groupId>org.codehaus.gmaven</groupId>}
^{<artifactId>groovy-maven-plugin</artifactId>}
^{<dependencies>}
^<dependency>
^{<groupId>com.squareup.okhttp3</groupId>}
^{<artifactId>okhttp</artifactId>}
^{<version>3.14.0</version>}
^{</dependency>}
^<dependency>
^{<groupId>commons-io</groupId>}
^{<artifactId>commons-io</artifactId>}
^{<version>${commons-io-version}</version>}
^{</dependency>}
^{</dependencies>}
^<executions>
^<execution>
^{<id>deploy-cba</id>}
^{<phase>install</phase>}
^<goals>
^{<goal>execute</goal>}
^</goals>
^{<configuration>}
^<source>
^{import okhttp3.Credentials}
^{import okhttp3.MediaType}
^{import okhttp3.MultipartBody}
^{import okhttp3.OkHttpClient}
^{import okhttp3.Request}
^{import okhttp3.RequestBody}
^{import org.apache.commons.io.IOUtils}

^{import java.io.File}

^{target = "${basedir.absolutePath}/target"}
^{userName = throwIfPropMissing('cds.username')}
^{password = throwIfPropMissing('cds.password')}
^{protocol = properties['cds.protocol'] ?: 'http'}
^{host = properties['cds.host'] ?: 'localhost'}
^{port = properties['cds.port'] ?: '8081'}

^{def cba = "${project.artifact.artifactId}-${project.artifact.version}-cba.zip"}
^{def enrichedCba = "${project.artifact.artifactId}-${project.artifact.version}-enriched-cba.zip"}
^{def enrichEndpoint = properties['cds.enrich.endpoint'] ?: 'api/v1/blueprint-model/enrich'}
^{def publishEndpoint = properties['cds.publish.endpoint'] ?: 'api/v1/blueprint-model/publish'}

^{def throwIfPropMissing(prop) {}
^{value = properties[prop]}
^{if (!value || "".equals(value)) {}
^{throw new RuntimeException("Property missing: $prop")}
^}
^{return value}
^}

^{def buildRequest(endpoint, fileName) {}
^{body = new MultipartBody.Builder()}
^{.setType(MultipartBody.FORM)}
^{.addFormDataPart("file",}
^fileName,
^{RequestBody.create(MediaType.parse('application/zip'), new File(target, fileName)))}
^.build()

^{return new Request.Builder()}
^{.url("$protocol://$host:$port/$endpoint")}
^{.addHeader('Authorization', Credentials.basic(userName, password))}
^.post(body)
^.build()
^}

^{def logAndThrow(msg) {}
^{if(response) {}
^{log.error(response.body().string())}
^}
^{throw new RuntimeException(msg)}
^}

^{response = null}
^{try {}
^{def client = new OkHttpClient()}

^{response = client.newCall(buildRequest(enrichEndpoint, cba)).execute()}
^{if (!response || !response.isSuccessful()) {}
^{logAndThrow("Failed to enrich CBA")}
^}

^{IOUtils.copy(}
^{response.body().byteStream(),}
^{new FileOutputStream(new File(target, enrichedCba))}
⁾
^{log.info("Created enriched cba: $enrichedCba")}

^{response = client.newCall(buildRequest(publishEndpoint, enrichedCba)).execute()}
^{if (!response || !response.isSuccessful()) {}
^{logAndThrow("Failed to publish CBA")}
^}

^{log.info("CBA Deployed")}
^{log.info(response.body().string())}
^{} finally {}
^{if (response) {}
^{response.close()}
^}
^}
^</source>
^{</configuration>}
^</execution>
^{</executions>}
^</plugin>
^</plugins>
^</build>
^</profile>
^</profiles>
^</project>

Run tests with maven

Run tests with maven
`mvn clean test`

Build zip file

Build zip file
`# This will build /target/your-cba-name-1.0.0-SNAPSHOT-cba.zip` `mvn clean install`

Add Unit tests

^.
^{├── Definitions}
^{│ └── hello_world.json}
^{├── Templates}
^{│ └── base-config-data-velocity.json}
^{│ └── base-config-velocity-template.vtl}
^{│ └── default-variable-value-data.json}
^{│ └── default-variable-value-velocity-template.vtl}
^{├── Tests}
^{│ └── kotlin}
^{│ └── BlueprintVelocityTemplateTest.kt}
^{│ └── default-variable-value-data.txt}
^{├── TOSCA-Metadata}
^{│ └── TOSCA.meta}
^{├── pom.xml}

^{Kotlin unit tests should be added under /Tests/kotlin as show above. Test files must contain "Test" in the filename,}
^{for example BlueprintVelocityTemplateTest.kt or TestBlueprintVelocityTemplate.kt}

^{Example project:}

Testing

After the pom is added, the CBA can be used in IntelliJ as a maven project.

Create a new empty project

Give it a name

Click the + symbol and select import module

Select the pom.xml in your CBA directory

CBA with JSON & Templates

Inorder to Validate the Templates we require JSON file where we include variable values, so that it maps to the VTL

For each variable in base-config-template.vtl we have base-config-velocity.json which has variable values

Similarly, we have default-variable-value-data.json which has only one variable value for default-variable-value-template.vtl

You should now be able to write, run unit tests

Create BlueprintVelocityTemplateTest class , Under Test directory to implement unit tests

Here we use the existing class BlueprintVelocityTemplateService which is in CDS container by importing it to project ,where

it has Velocity Engine implementation

You can implement following methods to test the templates

First we use assertNotNull() method means " passed parameter must not be null ": if it is null then the test case fails

Second , assertEquals can be used to check if two objects is equally defined or not

Third , we take the Expected value variable from a file

Then we write tests

Once you include Test code, Make sure your CBA is working properly, then run the below command in the terminal

we get Build Success

Then, Modify run configuration add Environmental variables