From 42478b1721879ead6d595a238c45acd1c1f039c6 Mon Sep 17 00:00:00 2001 From: "Smokowski, Kevin (ks6305)" Date: Tue, 7 Aug 2018 19:07:35 +0000 Subject: [PATCH] add template node add tempalte node implementation Change-Id: Ifd3e6e7f2a7b9ff7029b523eab50274e440652cc Issue-ID: CCSDK-440 Signed-off-by: Smokowski, Kevin (ks6305) --- pom.xml | 1 + template-node/features/ccsdk-template-node/pom.xml | 28 +++++ .../features/features-template-node/pom.xml | 27 ++++ template-node/features/pom.xml | 20 +++ template-node/installer/pom.xml | 136 +++++++++++++++++++++ .../src/assembly/assemble_installer_zip.xml | 59 +++++++++ .../src/assembly/assemble_mvnrepo_zip.xml | 49 ++++++++ .../src/main/resources/scripts/install-feature.sh | 39 ++++++ template-node/pom.xml | 21 ++++ template-node/provider/pom.xml | 40 ++++++ .../ccsdk/sli/plugins/template/TemplateNode.java | 108 ++++++++++++++++ .../resources/OSGI-INF/blueprint/blueprint.xml | 8 ++ .../sli/plugins/template/MockTemplateNode.java | 7 ++ .../sli/plugins/template/TemplateNodeTest.java | 85 +++++++++++++ .../provider/src/test/resources/basic.vtl | 12 ++ .../src/test/resources/template-node.properties | 4 + 16 files changed, 644 insertions(+) create mode 100644 template-node/features/ccsdk-template-node/pom.xml create mode 100644 template-node/features/features-template-node/pom.xml create mode 100644 template-node/features/pom.xml create mode 100644 template-node/installer/pom.xml create mode 100644 template-node/installer/src/assembly/assemble_installer_zip.xml create mode 100644 template-node/installer/src/assembly/assemble_mvnrepo_zip.xml create mode 100644 template-node/installer/src/main/resources/scripts/install-feature.sh create mode 100644 template-node/pom.xml create mode 100644 template-node/provider/pom.xml create mode 100644 template-node/provider/src/main/java/org/onap/ccsdk/sli/plugins/template/TemplateNode.java create mode 100644 template-node/provider/src/main/resources/OSGI-INF/blueprint/blueprint.xml create mode 100644 template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/MockTemplateNode.java create mode 100644 template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/TemplateNodeTest.java create mode 100644 template-node/provider/src/test/resources/basic.vtl create mode 100644 template-node/provider/src/test/resources/template-node.properties diff --git a/pom.xml b/pom.xml index 164d81e2..a41f2311 100755 --- a/pom.xml +++ b/pom.xml @@ -26,6 +26,7 @@ sshapi-call-node restconf-client features + template-node diff --git a/template-node/features/ccsdk-template-node/pom.xml b/template-node/features/ccsdk-template-node/pom.xml new file mode 100644 index 00000000..fd3a9245 --- /dev/null +++ b/template-node/features/ccsdk-template-node/pom.xml @@ -0,0 +1,28 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + single-feature-parent + 1.1.0-SNAPSHOT + + + + org.onap.ccsdk.sli.plugins + ccsdk-template-node + 0.3.3-SNAPSHOT + feature + + + true + + + + + ${project.groupId} + template-node-provider + ${project.version} + + + diff --git a/template-node/features/features-template-node/pom.xml b/template-node/features/features-template-node/pom.xml new file mode 100644 index 00000000..c352ba51 --- /dev/null +++ b/template-node/features/features-template-node/pom.xml @@ -0,0 +1,27 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + feature-repo-parent + 1.1.0-SNAPSHOT + + + + org.onap.ccsdk.sli.plugins + features-template-node + 0.3.3-SNAPSHOT + feature + + + + ${project.groupId} + ccsdk-template-node + ${project.version} + xml + features + + + + diff --git a/template-node/features/pom.xml b/template-node/features/pom.xml new file mode 100644 index 00000000..1abcdbe3 --- /dev/null +++ b/template-node/features/pom.xml @@ -0,0 +1,20 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + odlparent-lite + 1.1.0-SNAPSHOT + + + org.onap.ccsdk.sli.plugins + template-node-features + 0.3.3-SNAPSHOT + pom + + + ccsdk-template-node + features-template-node + + diff --git a/template-node/installer/pom.xml b/template-node/installer/pom.xml new file mode 100644 index 00000000..1e4d24cd --- /dev/null +++ b/template-node/installer/pom.xml @@ -0,0 +1,136 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + odlparent-lite + 1.1.0-SNAPSHOT + + + org.onap.ccsdk.sli.plugins + template-node-installer + 0.3.3-SNAPSHOT + pom + + + ccsdk-template-node + ${application.name} + mvn:org.onap.ccsdk.sli.plugins/${features.boot}/${project.version}/xml/features + false + + + + + org.onap.ccsdk.sli.plugins + ${application.name} + ${project.version} + xml + features + + + * + * + + + + + org.onap.ccsdk.sli.plugins + template-node-provider + ${project.version} + + + + + + + maven-assembly-plugin + 2.6 + + + maven-repo-zip + + single + + package + + false + stage/${application.name}-${project.version} + + src/assembly/assemble_mvnrepo_zip.xml + + false + + + + installer-zip + + single + + package + + true + ${application.name}-${project.version}-installer + + src/assembly/assemble_installer_zip.xml + + false + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-dependencies + + copy-dependencies + + prepare-package + + false + ${project.build.directory}/assembly/system + false + true + true + true + false + false + org.onap.ccsdk.sli.plugins,org.apache.velocity + provided + + + + + + maven-resources-plugin + 2.6 + + + copy-version + + copy-resources + + validate + + ${basedir}/target/stage + + + src/main/resources/scripts + + install-feature.sh + + true + + + + + + + + + + + diff --git a/template-node/installer/src/assembly/assemble_installer_zip.xml b/template-node/installer/src/assembly/assemble_installer_zip.xml new file mode 100644 index 00000000..b6fd6558 --- /dev/null +++ b/template-node/installer/src/assembly/assemble_installer_zip.xml @@ -0,0 +1,59 @@ + + + + + + installer_zip + + zip + + + + false + + + + target/stage/ + ${application.name} + 755 + + *.sh + + + + target/stage/ + ${application.name} + 644 + + *.sh + + + + + + + diff --git a/template-node/installer/src/assembly/assemble_mvnrepo_zip.xml b/template-node/installer/src/assembly/assemble_mvnrepo_zip.xml new file mode 100644 index 00000000..2ee22447 --- /dev/null +++ b/template-node/installer/src/assembly/assemble_mvnrepo_zip.xml @@ -0,0 +1,49 @@ + + + + + + mvnrepo_zip + + zip + + + + false + + + + target/assembly/ + . + + + + + + + + diff --git a/template-node/installer/src/main/resources/scripts/install-feature.sh b/template-node/installer/src/main/resources/scripts/install-feature.sh new file mode 100644 index 00000000..0eab001d --- /dev/null +++ b/template-node/installer/src/main/resources/scripts/install-feature.sh @@ -0,0 +1,39 @@ +#!/bin/bash + +### +# ============LICENSE_START======================================================= +# openECOMP : SDN-C +# ================================================================================ +# Copyright (C) 2017 AT&T Intellectual Property. All rights +# reserved. +# ================================================================================ +# 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. +# ============LICENSE_END========================================================= +### + +ODL_HOME=${ODL_HOME:-/opt/opendaylight/current} +ODL_KARAF_CLIENT=${ODL_KARAF_CLIENT:-${ODL_HOME}/bin/client} +INSTALLERDIR=$(dirname $0) + +REPOZIP=${INSTALLERDIR}/${features.boot}-${project.version}.zip + +if [ -f ${REPOZIP} ] +then + unzip -d ${ODL_HOME} ${REPOZIP} +else + echo "ERROR : repo zip ($REPOZIP) not found" + exit 1 +fi + +${ODL_KARAF_CLIENT} feature:repo-add ${features.repositories} +${ODL_KARAF_CLIENT} feature:install ${features.boot} diff --git a/template-node/pom.xml b/template-node/pom.xml new file mode 100644 index 00000000..21ab127f --- /dev/null +++ b/template-node/pom.xml @@ -0,0 +1,21 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + odlparent-lite + 1.1.0-SNAPSHOT + + + org.onap.ccsdk.sli.plugins + template-node + 0.3.3-SNAPSHOT + pom + + + provider + features + installer + + diff --git a/template-node/provider/pom.xml b/template-node/provider/pom.xml new file mode 100644 index 00000000..936f76f3 --- /dev/null +++ b/template-node/provider/pom.xml @@ -0,0 +1,40 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + binding-parent + 1.1.0-SNAPSHOT + + + org.onap.ccsdk.sli.plugins + template-node-provider + 0.3.3-SNAPSHOT + bundle + + + + junit + junit + test + + + org.onap.ccsdk.sli.core + sli-common + + + org.onap.ccsdk.sli.core + sli-provider + + + org.slf4j + slf4j-api + + + org.apache.velocity + velocity + 1.7 + + + diff --git a/template-node/provider/src/main/java/org/onap/ccsdk/sli/plugins/template/TemplateNode.java b/template-node/provider/src/main/java/org/onap/ccsdk/sli/plugins/template/TemplateNode.java new file mode 100644 index 00000000..8a967681 --- /dev/null +++ b/template-node/provider/src/main/java/org/onap/ccsdk/sli/plugins/template/TemplateNode.java @@ -0,0 +1,108 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : SDN-C + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights + * reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.plugins.template; + +import java.io.FileInputStream; +import java.io.StringWriter; +import java.util.Map; +import java.util.Properties; +import org.apache.velocity.Template; +import org.apache.velocity.VelocityContext; +import org.apache.velocity.app.VelocityEngine; +import org.apache.velocity.runtime.RuntimeConstants; +import org.onap.ccsdk.sli.core.sli.SvcLogicContext; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; +import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class TemplateNode implements SvcLogicJavaPlugin { + private static final Logger logger = LoggerFactory.getLogger(TemplateNode.class); + public final static String TEMPLATE_PATH = "templatePath"; + public final static String OUTPUT_PATH_KEY = "output"; + public final static String PREFIX_KEY = "prefix"; + public final static String REQUIRED_PARAMETERS_ERROR_MESSAGE = "templateName & outputPath are required fields"; + protected static final String TEMPLATE_PROPERTIES_FILE_NAME = "template-node.properties"; + protected static final String DEFAULT_PROPERTIES_DIR = "/opt/onap/ccsdk/data/properties"; + protected static final String PROPERTIES_DIR_KEY = "SDNC_CONFIG_DIR"; + + protected VelocityEngine ve; + + public TemplateNode() { + ve = new VelocityEngine(); + setProperties(); + ve.init(); + } + + protected void setProperties() { + String configDir = System.getProperty(PROPERTIES_DIR_KEY, DEFAULT_PROPERTIES_DIR); + Properties props = new Properties(); + + try (FileInputStream in = new FileInputStream(configDir + "/" + TEMPLATE_PROPERTIES_FILE_NAME)) { + props.load(in); + } catch (Exception e) { + logger.error("Caught exception loading properties!", e); + } + + // give sensible defaults for required properties + ve.setProperty(RuntimeConstants.RESOURCE_LOADER, props.getProperty("velocity.resource.loader", "file")); + ve.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, + props.getProperty("velocity.file.resource.loader.path", "/opt/onap/sdnc/restapi/templates")); + ve.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_CACHE, + props.getProperty("velocity.file.resource.loader.cache", "false")); + + // allow flexible reading of additional velocity properties + for (String propertyName : props.stringPropertyNames()) { + if (propertyName.startsWith("velocity")) { + logger.error("set " + propertyName.substring(9) + "=" + props.get(propertyName)); + ve.setProperty(propertyName.substring(9), props.get(propertyName)); + } + } + } + + public void evaluateTemplate(Map params, SvcLogicContext ctx) throws SvcLogicException { + String templateName = params.get(TEMPLATE_PATH); + String outputPath = params.get(OUTPUT_PATH_KEY); + String prefix = params.get(PREFIX_KEY); + + if (prefix != null && prefix.length() > 0) { + outputPath = prefix + "." + outputPath; + } + + if (templateName == null || outputPath == null) { + throw new SvcLogicException(REQUIRED_PARAMETERS_ERROR_MESSAGE); + } else { + try { + Template template = ve.getTemplate(templateName); + VelocityContext context = new VelocityContext(); + context.put("ctx", ctx); + context.put("params", params); + StringWriter sw = new StringWriter(); + template.merge(context, sw); + ctx.setAttribute(outputPath, sw.toString()); + } catch (Exception e) { + throw new SvcLogicException(e.getMessage()); + } + } + } + +} \ No newline at end of file diff --git a/template-node/provider/src/main/resources/OSGI-INF/blueprint/blueprint.xml b/template-node/provider/src/main/resources/OSGI-INF/blueprint/blueprint.xml new file mode 100644 index 00000000..a8006b9b --- /dev/null +++ b/template-node/provider/src/main/resources/OSGI-INF/blueprint/blueprint.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/MockTemplateNode.java b/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/MockTemplateNode.java new file mode 100644 index 00000000..d628ac92 --- /dev/null +++ b/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/MockTemplateNode.java @@ -0,0 +1,7 @@ +package org.onap.ccsdk.sli.plugins.template; + +public class MockTemplateNode extends TemplateNode { + protected void setProperties() { + // do nothing + } +} diff --git a/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/TemplateNodeTest.java b/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/TemplateNodeTest.java new file mode 100644 index 00000000..29c5c973 --- /dev/null +++ b/template-node/provider/src/test/java/org/onap/ccsdk/sli/plugins/template/TemplateNodeTest.java @@ -0,0 +1,85 @@ +package org.onap.ccsdk.sli.plugins.template; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; +import java.util.HashMap; +import java.util.Map; +import java.util.Vector; +import org.apache.velocity.runtime.RuntimeConstants; +import org.junit.Test; +import org.onap.ccsdk.sli.core.sli.SvcLogicContext; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; + +public class TemplateNodeTest { + + @Test + public void sunnyDay() throws Exception { + String requestId = "REQ001"; + String uniqueKey = "UNIQUE_TEST"; + String action = "uPdaTe"; + String serviceType = "VPN"; + + TemplateNode t = new MockTemplateNode(); + + Map params = new HashMap(); + params.put(TemplateNode.PREFIX_KEY, "output"); + params.put(TemplateNode.OUTPUT_PATH_KEY, "mycontainer"); + params.put(TemplateNode.TEMPLATE_PATH, "src/test/resources/basic.vtl"); + params.put("service-type", serviceType); + SvcLogicContext ctx = new SvcLogicContext(); + ctx.setAttribute("input.svc-request-id", requestId); + ctx.setAttribute("input.unique-key", uniqueKey); + ctx.setAttribute("action", action); + + t.evaluateTemplate(params, ctx); + String result = ctx.getAttribute("output.mycontainer"); + assertNotNull(result); + assertTrue(result.contains(requestId)); + assertTrue(result.contains(uniqueKey)); + assertTrue(result.contains(action.toUpperCase())); + assertTrue(result.contains(serviceType)); + } + + @Test(expected = SvcLogicException.class) + public void parameterException() throws Exception { + TemplateNode t = new MockTemplateNode(); + Map params = new HashMap(); + SvcLogicContext ctx = new SvcLogicContext(); + t.evaluateTemplate(params, ctx); + } + + @Test(expected = SvcLogicException.class) + public void missingTemplate() throws Exception { + TemplateNode t = new MockTemplateNode(); + Map params = new HashMap(); + params.put(TemplateNode.PREFIX_KEY, "output"); + params.put(TemplateNode.OUTPUT_PATH_KEY, "mycontainer"); + params.put(TemplateNode.TEMPLATE_PATH, "src/test/resources/missing.vtl"); + SvcLogicContext ctx = new SvcLogicContext(); + t.evaluateTemplate(params, ctx); + } + + @Test + public void withProperties() throws Exception { + System.setProperty(TemplateNode.PROPERTIES_DIR_KEY, "src/test/resources"); + TemplateNode t = new TemplateNode(); + Vector loader = (Vector) t.ve.getProperty(RuntimeConstants.RESOURCE_LOADER); + assertTrue(loader.contains("class")); + assertEquals("/home/my/example", t.ve.getProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH)); + assertEquals("true", t.ve.getProperty(RuntimeConstants.FILE_RESOURCE_LOADER_CACHE)); + assertEquals("customValue", t.ve.getProperty("custom.property")); + } + + @Test + public void withNoProperties() throws Exception { + System.setProperty(TemplateNode.PROPERTIES_DIR_KEY, "i/do/not/exist"); + TemplateNode t = new TemplateNode(); + Vector loader = (Vector) t.ve.getProperty(RuntimeConstants.RESOURCE_LOADER); + assertTrue(loader.contains("file")); + assertEquals("/opt/onap/sdnc/restapi/templates", t.ve.getProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH)); + assertEquals("false", t.ve.getProperty(RuntimeConstants.FILE_RESOURCE_LOADER_CACHE)); + assertEquals(null, t.ve.getProperty("custom.property")); + } + +} \ No newline at end of file diff --git a/template-node/provider/src/test/resources/basic.vtl b/template-node/provider/src/test/resources/basic.vtl new file mode 100644 index 00000000..63fcc670 --- /dev/null +++ b/template-node/provider/src/test/resources/basic.vtl @@ -0,0 +1,12 @@ +{ + "input": { + "sdnc-request-header": { + "svc-request-id": "$ctx.getAttribute("input.svc-request-id")", + "svc-action": "$ctx.getAttribute("action").toUpperCase()" + }, + "service-information": { + "service-type": "$params.get("service-type")", + "service-instance-id": "$ctx.getAttribute("input.unique-key")" + } + } +} \ No newline at end of file diff --git a/template-node/provider/src/test/resources/template-node.properties b/template-node/provider/src/test/resources/template-node.properties new file mode 100644 index 00000000..1199a0cd --- /dev/null +++ b/template-node/provider/src/test/resources/template-node.properties @@ -0,0 +1,4 @@ +velocity.resource.loader=class +velocity.file.resource.loader.path=/home/my/example +velocity.file.resource.loader.cache=true +velocity.custom.property=customValue \ No newline at end of file -- 2.16.6