aboutsummaryrefslogtreecommitdiffstats
path: root/auth/cli-codegen
diff options
context:
space:
mode:
Diffstat (limited to 'auth/cli-codegen')
-rw-r--r--auth/cli-codegen/pom.xml42
-rw-r--r--auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CGCliEditor.java515
-rw-r--r--auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java71
-rw-r--r--auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/package-info.java26
-rw-r--r--auth/cli-codegen/src/main/resources/org/onap/policy/apex/auth/clicodegen/cli-editor.stg129
-rw-r--r--auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/StErrorListener.java111
-rw-r--r--auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/TestSTG.java138
7 files changed, 1032 insertions, 0 deletions
diff --git a/auth/cli-codegen/pom.xml b/auth/cli-codegen/pom.xml
new file mode 100644
index 000000000..e1d35d817
--- /dev/null
+++ b/auth/cli-codegen/pom.xml
@@ -0,0 +1,42 @@
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2018 Ericsson. 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.
+
+ SPDX-License-Identifier: Apache-2.0
+ ============LICENSE_END=========================================================
+-->
+
+<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.policy.apex-pdp.auth</groupId>
+ <artifactId>auth</artifactId>
+ <version>2.0.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>cli-codegen</artifactId>
+ <name>${project.artifactId}</name>
+ <description>ST4 based ode Generation module for CLI Editor create commands</description>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.antlr</groupId>
+ <artifactId>ST4</artifactId>
+ <version>4.0.8</version>
+ </dependency>
+ </dependencies>
+</project> \ No newline at end of file
diff --git a/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CGCliEditor.java b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CGCliEditor.java
new file mode 100644
index 000000000..ca41e5f5f
--- /dev/null
+++ b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CGCliEditor.java
@@ -0,0 +1,515 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.auth.clicodegen;
+
+import java.util.List;
+
+import org.stringtemplate.v4.ST;
+import org.stringtemplate.v4.STGroupFile;
+
+/**
+ * Code generator generating expressions for the APEX CLI Editor.
+ *
+ * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+ */
+public class CGCliEditor {
+ // CHECKSTYLE:OFF: ParameterNumber
+
+ /** The name of the STG file for the code generator. */
+ public static final String STG_FILE = "org/onap/policy/apex/auth/clicodegen/cli-editor.stg";
+
+ /** The String Template Group, taken from the context. */
+ private final STGroupFile stg;
+
+ /** The ST for the model, loaded from the STG. */
+ private final ST model;
+
+ /** A default name space, set from specification. */
+ private String defaultNamespace;
+
+ /**
+ * Creates a new code generator.
+ */
+ public CGCliEditor() {
+ stg = new STGroupFile(STG_FILE);
+ stg.registerRenderer(String.class, new CgStringRenderer(), true);
+ model = stg.getInstanceOf("policyModel");
+ }
+
+ /**
+ * Adds model parameters to the template.
+ *
+ * @param name the name of the mode, must not be blank
+ * @param version a version, can be null
+ * @param uuid a UUID, can be null
+ * @param description a description, must not be blank
+ */
+ public void addModelParams(final String name, final String version, final String uuid, final String description) {
+ if (name == null || name.isEmpty()) {
+ throw new IllegalArgumentException("model name should not be blank");
+ }
+ if (description == null || description.isEmpty()) {
+ throw new IllegalArgumentException("model description should not be blank");
+ }
+
+ model.add("name", name);
+ model.add("version", version);
+ model.add("uuid", uuid);
+ model.add("description", description);
+ }
+
+ /**
+ * Returns the model.
+ *
+ * @return the model
+ */
+ public ST getModel() {
+ return model;
+ }
+
+ /**
+ * Sets the default name space.
+ *
+ * @param nameSpace new name space, ignored if blank
+ */
+ public void setDefaultNamespace(final String nameSpace) {
+ if (nameSpace != null && !nameSpace.isEmpty()) {
+ defaultNamespace = nameSpace;
+ }
+ }
+
+ /**
+ * Adds a new schema declaration to the model.
+ *
+ * @param name the name of the schema
+ * @param version the version of the declaration
+ * @param uuid the UUID for the declaration
+ * @param description a description of the schema
+ * @param flavour the flavour of the schema declaration, e.g. Java or Avro
+ * @param schema the actual schema declaration, either a string or as <code>LS schema LE</code>
+ */
+ public void addSchemaDeclaration(final String name, final String version, final String uuid,
+ final String description, final String flavour, final String schema) {
+ final ST st = stg.getInstanceOf("schemaDecl");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("uuid", uuid);
+ st.add("description", description);
+ st.add("flavour", flavour);
+ st.add("schema", schema);
+ model.add("declarations", st);
+ }
+
+ /**
+ * Adds a new context album declaration to the model.
+ *
+ * @param name the name of the context album
+ * @param version the version of the context album
+ * @param uuid a UUID for the declaration
+ * @param description a description for the context album
+ * @param scope the scope
+ * @param writable a flag for writable context
+ * @param schemaName the name of the schema
+ * @param schemaVersion the version of the declaration
+ */
+ public void addContextAlbumDeclaration(final String name, final String version, final String uuid,
+ final String description, final String scope, final boolean writable, final String schemaName,
+ final String schemaVersion) {
+ final ST st = stg.getInstanceOf("ctxAlbumDecl");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("uuid", uuid);
+ st.add("description", description);
+ st.add("scope", scope);
+ st.add("writable", writable);
+ st.add("schemaName", schemaName);
+ st.add("schemaVersion", schemaVersion);
+ model.add("declarations", st);
+ }
+
+ /**
+ * Creates a new event field definition which belongs to an event.
+ *
+ * @param eventName the event name
+ * @param version the event version
+ * @param fieldName the name for the field in the event
+ * @param fieldSchema the schema of the field
+ * @param fieldSchemaVersion the version of the schema
+ * @param optional a flag for optional fields
+ * @return a CLI command for event field definition
+ */
+ public ST createEventFieldDefinition(final String eventName, final String version, final String fieldName,
+ final String fieldSchema, final String fieldSchemaVersion, final boolean optional) {
+ final ST st = stg.getInstanceOf("eventDefField");
+ st.add("eventName", eventName);
+ st.add("version", version);
+ st.add("fieldName", fieldName);
+ st.add("fieldSchema", fieldSchema);
+ st.add("fieldSchemaVersion", fieldSchemaVersion);
+ st.add("optional", optional);
+ return st;
+ }
+
+ /**
+ * Creates a new task logic definition which belongs to a task.
+ *
+ * @param taskName the name of the task
+ * @param version the task version
+ * @param flavour the flavour, e.g. JAVA or JAVASCRIPT
+ * @param logic the actual logic (use either a string or a multi-line with
+ * <code>LS some code LE</code>
+ * @return a CLI command for task definition, logic
+ */
+ public ST createTaskDefLogic(final String taskName, final String version, final String flavour,
+ final String logic) {
+ final ST st = stg.getInstanceOf("taskDefLogic");
+ st.add("taskName", taskName);
+ st.add("version", version);
+ st.add("flavour", flavour);
+ st.add("logic", logic);
+ return st;
+ }
+
+ /**
+ * Adds a new event declaration to the model.
+ *
+ * @param name the event name
+ * @param version the event version
+ * @param uuid a UUID for the definition
+ * @param description a description of the event
+ * @param nameSpace the name space for the event
+ * @param source a source sending the event
+ * @param target a target receiving the event
+ * @param fields any event fields
+ */
+ public void addEventDeclaration(final String name, final String version, final String uuid,
+ final String description, final String nameSpace, final String source, final String target,
+ final List<ST> fields) {
+ final ST st = stg.getInstanceOf("eventDecl");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("uuid", uuid);
+ st.add("description", description);
+ st.add("source", source);
+ st.add("target", target);
+ st.add("fields", fields);
+
+ if (nameSpace != null) {
+ st.add("nameSpace", nameSpace);
+ } else if (defaultNamespace != null) {
+ st.add("nameSpace", defaultNamespace);
+ }
+
+ model.add("declarations", st);
+ }
+
+ /**
+ * Adds a new task declaration to the model.
+ *
+ * @param name the name of the task
+ * @param version the version of the task
+ * @param uuid a UUID for the definition
+ * @param description a description of the task
+ * @param infields all infields for the task
+ * @param outfields all outfields for the task
+ * @param logic the logic for the task
+ * @param parameters any task parameter
+ * @param contextRefs any context reference
+ */
+ public void addTaskDeclaration(final String name, final String version, final String uuid, final String description,
+ final List<ST> infields, final List<ST> outfields, final ST logic, final List<ST> parameters,
+ final List<ST> contextRefs) {
+ final ST st = stg.getInstanceOf("taskDecl");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("uuid", uuid);
+ st.add("description", description);
+ st.add("infields", infields);
+ st.add("outfields", outfields);
+ st.add("logic", logic);
+ st.add("parameters", parameters);
+ st.add("contextRefs", contextRefs);
+ model.add("declarations", st);
+ }
+
+ /**
+ * Adds a new policy definition to the model.
+ *
+ * @param name the name of the policy
+ * @param version the version of the policy
+ * @param uuid a UUID for the definition
+ * @param description a description of the policy
+ * @param template the template type for this policy
+ * @param firstState the first state of the policy
+ * @param states all policy states
+ */
+ public void addPolicyDefinition(final String name, final String version, final String uuid,
+ final String description, final String template, final String firstState, final List<ST> states) {
+ final ST st = stg.getInstanceOf("policyDef");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("uuid", uuid);
+ st.add("description", description);
+ st.add("template", template);
+ st.add("firstState", firstState);
+ st.add("states", states);
+ model.add("definitions", st);
+ }
+
+ /**
+ * Creates a new task infield definition.
+ *
+ * @param taskName the name of the task
+ * @param version the version of the task
+ * @param fieldName the name of the infield
+ * @param fieldSchema the schema for the infield
+ * @param fieldSchemaVersion the version of the schema
+ * @return a CLI command for task infield definition
+ */
+ public ST createTaskDefinitionInfields(final String taskName, final String version, final String fieldName,
+ final String fieldSchema, final String fieldSchemaVersion) {
+ final ST st = stg.getInstanceOf("taskDefInputFields");
+ st.add("taskName", taskName);
+ st.add("version", version);
+ st.add("fieldName", fieldName);
+ st.add("fieldSchema", fieldSchema);
+ st.add("fieldSchemaVersion", fieldSchemaVersion);
+ return st;
+ }
+
+ /**
+ * Creates a new task outfield definition.
+ *
+ * @param taskName the name of the task
+ * @param version the version of the task
+ * @param fieldName the name of the outfield
+ * @param fieldSchema the schema for the outfield
+ * @param fieldSchemaVersion the version of the schema
+ * @return a CLI command for task outfield definition
+ */
+ public ST createTaskDefinitionOutfields(final String taskName, final String version, final String fieldName,
+ final String fieldSchema, final String fieldSchemaVersion) {
+ final ST st = stg.getInstanceOf("taskDefOutputFields");
+ st.add("taskName", taskName);
+ st.add("version", version);
+ st.add("fieldName", fieldName);
+ st.add("fieldSchema", fieldSchema);
+ st.add("fieldSchemaVersion", fieldSchemaVersion);
+ return st;
+ }
+
+ /**
+ * Creates a new task parameter definition belonging to a task.
+ *
+ * @param name the name of the task
+ * @param version the version of the task
+ * @param parName the parameter name
+ * @param defaultValue a default value for the parameter
+ * @return a CLI command for a task parameter definition
+ */
+ public ST createTaskDefinitionParameters(final String name, final String version, final String parName,
+ final String defaultValue) {
+ final ST st = stg.getInstanceOf("taskDefParameter");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("parName", parName);
+ st.add("defaultValue", defaultValue);
+ return st;
+ }
+
+ /**
+ * Creates a new task definition context reference which belongs to a task.
+ *
+ * @param name the name of the task
+ * @param version the version of the task
+ * @param albumName the name of the context album
+ * @param albumVersion the version of the context album
+ * @return a CLI command for a task context reference definition
+ */
+ public ST createTaskDefinitionContextRef(final String name, final String version, final String albumName,
+ final String albumVersion) {
+ final ST st = stg.getInstanceOf("taskDefCtxRef");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("albumName", albumName);
+ st.add("albumVersion", albumVersion);
+ return st;
+ }
+
+ /**
+ * Creates a new policy state task definition for a task which belongs to a state which belongs
+ * to a policy.
+ *
+ * @param policyName the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the new state
+ * @param taskLocalName the local (in policy and state) name of the task
+ * @param taskName the identifier of the task (previously defined as a task)
+ * @param taskVersion the version of the task definition
+ * @param outputType the output type
+ * @param outputName the output name
+ * @return a CLI command for a policy state task definition
+ */
+ public ST createPolicyStateTask(final String policyName, final String version, final String stateName,
+ final String taskLocalName, final String taskName, final String taskVersion, final String outputType,
+ final String outputName) {
+ final ST st = stg.getInstanceOf("policyStateTask");
+ st.add("policyName", policyName);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("taskLocalName", taskLocalName);
+ st.add("taskName", taskName);
+ st.add("taskVersion", taskVersion);
+ st.add("outputType", outputType);
+ st.add("outputName", outputName);
+ return st;
+ }
+
+ /**
+ * Creates a new policy state output definition for a state which belongs to a policy.
+ *
+ * @param policyName the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the new state
+ * @param outputName the name of the new output
+ * @param eventName the event name for the output
+ * @param eventVersion the version of the event for the output
+ * @param nextState the next state if any
+ * @return a CLI command for a state output definition
+ */
+ public ST createPolicyStateOutput(final String policyName, final String version, final String stateName,
+ final String outputName, final String eventName, final String eventVersion, final String nextState) {
+ final ST st = stg.getInstanceOf("policyStateOutput");
+ st.add("policyName", policyName);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("outputName", outputName);
+ st.add("eventName", eventName);
+ st.add("eventVersion", eventVersion);
+ st.add("nextState", nextState);
+ return st;
+ }
+
+ /**
+ * Creates a new policy state definition for a state which belongs to a policy.
+ *
+ * @param policyName the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the new state
+ * @param triggerName the name of the trigger event
+ * @param triggerVersion the version of the trigger event
+ * @param defaultTask the identifier of the default task
+ * @param defaultTaskVersion the version of the default task
+ * @param outputs the output definitions of the state
+ * @param tasks the task definition of the state
+ * @param tsLogic the task selection logic of the state
+ * @param finalizerLogics the finalizer logics for the state
+ * @param ctxRefs any context reference for the state
+ * @return a CLI command for a policy state definition
+ */
+ public ST createPolicyStateDef(final String policyName, final String version, final String stateName,
+ final String triggerName, final String triggerVersion, final String defaultTask,
+ final String defaultTaskVersion, final List<ST> outputs, final List<ST> tasks, final List<ST> tsLogic,
+ final List<ST> finalizerLogics, final List<ST> ctxRefs) {
+ final ST st = stg.getInstanceOf("policyStateDef");
+ st.add("policyName", policyName);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("triggerName", triggerName);
+ st.add("triggerVersion", triggerVersion);
+ st.add("defaultTask", defaultTask);
+ st.add("defaultTaskVersion", defaultTaskVersion);
+ st.add("outputs", outputs);
+ st.add("tasks", tasks);
+ st.add("tsLogic", tsLogic);
+ st.add("finalizerLogics", finalizerLogics);
+ st.add("ctxRefs", ctxRefs);
+ return st;
+ }
+
+ /**
+ * Creates a new task selection logic definition for a state which belongs to a policy.
+ *
+ * @param name the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the state
+ * @param logicFlavour the flavour, e.g. JAVA or JAVASCRIPT
+ * @param logic the actual logic (use either a string or a multi-line with
+ * <code>LS some code LE</code>
+ * @return a CLI command for task selection logic definition
+ */
+ public ST createPolicyStateDefTaskSelLogic(final String name, final String version, final String stateName,
+ final String logicFlavour, final String logic) {
+ final ST st = stg.getInstanceOf("policyStateTaskSelectionLogic");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("logicFlavour", logicFlavour);
+ st.add("logic", logic);
+ return st;
+ }
+
+ /**
+ * Creates a new state finalizer definition for a state which belongs to a policy.
+ *
+ * @param name the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the state
+ * @param finalizerLogicName name of the finalizer logic
+ * @param logicFlavour the flavour, e.g. JAVA or JAVASCRIPT
+ * @param logic the actual logic (use either a string or a multi-line with
+ * <code>LS some code LE</code>
+ * @return a CLI command for finalizer definition
+ */
+ public ST createPolicyStateDefFinalizerLogic(final String name, final String version, final String stateName,
+ final String finalizerLogicName, final String logicFlavour, final String logic) {
+ final ST st = stg.getInstanceOf("policyStateFinalizerLogic");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("finalizerLogicName", finalizerLogicName);
+ st.add("logicFlavour", logicFlavour);
+ st.add("logic", logic);
+ return st;
+ }
+
+ /**
+ * Creates a new policy state context reference for a state which belongs to a policy.
+ *
+ * @param name the name of the policy
+ * @param version the version of the policy
+ * @param stateName the name of the state
+ * @param albumName the name of the album
+ * @param albumVersion the version of the album
+ * @return a CLI command for state context reference
+ */
+ public ST createPolicyStateDefContextRef(final String name, final String version, final String stateName,
+ final String albumName, final String albumVersion) {
+ final ST st = stg.getInstanceOf("policyStateContextRef");
+ st.add("name", name);
+ st.add("version", version);
+ st.add("stateName", stateName);
+ st.add("albumName", albumName);
+ st.add("albumVersion", albumVersion);
+ return st;
+ }
+
+}
diff --git a/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java
new file mode 100644
index 000000000..50600f99f
--- /dev/null
+++ b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java
@@ -0,0 +1,71 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.auth.clicodegen;
+
+import java.util.Locale;
+
+import org.stringtemplate.v4.AttributeRenderer;
+import org.stringtemplate.v4.StringRenderer;
+
+/**
+ * String object renderer for the code generator.
+ *
+ * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+ * @author John Keeney (John.Keeney@ericsson.com)
+ */
+public class CgStringRenderer implements AttributeRenderer {
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.stringtemplate.v4.AttributeRenderer#toString(java.lang.Object, java.lang.String,
+ * java.util.Locale)
+ */
+ @Override
+ public String toString(final Object o, final String format, final Locale locale) {
+ if ("doQuotes".equals(format)) {
+ if (o == null) {
+ return null;
+ }
+ String ret = o.toString();
+ if (ret.length() == 0) {
+ return "\"\"";
+ }
+ if (!ret.startsWith("\"")) {
+ ret = "\"" + ret + "\"";
+ }
+ return ret;
+ }
+
+ if ("doDescription".equals(format)) {
+ String ret = o.toString();
+ if (ret.contains("\n") || ret.contains("\"")) {
+ ret = "LS" + "\n" + ret + "\n" + "LE";
+ } else {
+ ret = this.toString(o, "doQuotes", locale);
+ }
+ return ret;
+ }
+
+ // return the default string renderer if we don't know otherwise
+ return new StringRenderer().toString(o, format, locale);
+ }
+}
diff --git a/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/package-info.java b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/package-info.java
new file mode 100644
index 000000000..248b26d4f
--- /dev/null
+++ b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/package-info.java
@@ -0,0 +1,26 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+/**
+ * Code generation utilities, including STG, for CLI editor commands.
+ *
+ * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+ */
+package org.onap.policy.apex.auth.clicodegen;
diff --git a/auth/cli-codegen/src/main/resources/org/onap/policy/apex/auth/clicodegen/cli-editor.stg b/auth/cli-codegen/src/main/resources/org/onap/policy/apex/auth/clicodegen/cli-editor.stg
new file mode 100644
index 000000000..5f05f3933
--- /dev/null
+++ b/auth/cli-codegen/src/main/resources/org/onap/policy/apex/auth/clicodegen/cli-editor.stg
@@ -0,0 +1,129 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+/*
+ * Template for creating APEX CLI Editor Commands.
+ *
+ * @package com.ericsson.apex.apps.pdsls.base
+ * @author Sven van der Meer &lt;sven.van.der.meer@ericsson.com&gt;
+ */
+
+policyModel(name, version, uuid, description, declarations, definitions) ::= <<
+model create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription">
+
+<declarations:{decl|<decl>}; separator="\n">
+
+<definitions:{def|<def>}; separator="\n">
+
+>>
+
+schemaDecl(name, version, uuid, description, flavour, schema) ::= <<
+schema create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription"> flavour=<flavour> schema=<schema>
+
+>>
+
+
+ctxAlbumDecl(name, version, uuid, description, scope, writable, schemaName, schemaVersion) ::= <<
+album create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription"> scope=<scope> writable=<writable> schemaName=<schemaName><if(schemaVersion)> schemaVersion=<schemaVersion><endif>
+>>
+
+
+eventDecl(name, version, uuid, description, nameSpace, source, target, fields) ::= <<
+event create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription"><if(nameSpace)> nameSpace=<nameSpace><endif><if(source)> source=<source; format="doQuotes"><endif><if(target)> target=<target; format="doQuotes"><endif>
+<fields:{field|<field>}; separator="\n">
+
+>>
+
+eventDefField(eventName, version, fieldName, fieldSchema, fieldSchemaVersion, optional) ::= <<
+event parameter create name=<eventName><if(version)> version=<version><endif> parName=<fieldName> schemaName=<fieldSchema><if(fieldSchemaVersion)> schemaVersion=<fieldSchemaVersion><endif><if(optional)> optional=<optional><endif>
+>>
+
+
+taskDecl(name, version, uuid, description, infields, outfields, logic, parameters, contextRefs) ::= <<
+task create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription">
+<infields:{field|<field>}; separator="\n">
+<outfields:{field|<field>}; separator="\n">
+<logic>
+<parameters:{parameter|<parameter>}; separator="\n">
+<contextRefs:{contextRef|<contextRef>}; separator="\n">
+>>
+
+taskDefInputFields(taskName, version, fieldName, fieldSchema, fieldSchemaVersion) ::= <<
+task inputfield create name=<taskName><if(version)> version=<version><endif> fieldName=<fieldName> schemaName=<fieldSchema><if(fieldSchemaVersion)> schemaVersion=<fieldSchemaVersion><endif>
+>>
+
+taskDefOutputFields(taskName, version, fieldName, fieldSchema, fieldSchemaVersion) ::= <<
+task outputfield create name=<taskName><if(version)> version=<version><endif> fieldName=<fieldName> schemaName=<fieldSchema><if(fieldSchemaVersion)> schemaVersion=<fieldSchemaVersion><endif>
+>>
+
+taskDefLogic(taskName, version, flavour, logic) ::= <<
+task logic create name=<taskName><if(version)> version=<version><endif> logicFlavour=<flavour> logic=LS
+<logic>
+LE
+>>
+
+taskDefParameter(name, version, parName, defaultValue) ::= <<
+task parameter create name=<name><if(version)> version=<version><endif> parName=<parName> defaultValue=<defaultValue>
+>>
+
+taskDefCtxRef(name, version, albumName, albumVersion) ::= <<
+task contextref create name=<name><if(version)> version=<version><endif> albumName=<albumName><if(albumVersion)> albumVersion=<albumVersion><endif>
+>>
+
+
+policyDef(name, version, uuid, description, template, firstState, states) ::= <<
+policy create name=<name><if(version)> version=<version><endif><if(uuid)> uuid=<uuid><endif> description=<description; format="doDescription"><if(template)> template=<template><endif> firstState=<firstState>
+<states:{state|<state>}; separator="\n\n">
+
+
+>>
+
+policyStateDef(policyName, version, stateName, triggerName, triggerVersion, defaultTask, defaultTaskVersion, outputs, tasks, tsLogic, finalizerLogics, ctxRefs) ::= <<
+policy state create name=<policyName><if(version)> version=<version><endif> stateName=<stateName> triggerName=<triggerName><if(triggerVersion)> triggerVersion=<triggerVersion><endif> defaultTaskName=<defaultTask><if(defaultTaskVersion)> defaultTaskVersion=<defaultTaskVersion><endif>
+<outputs:{output|<output>}; separator="\n">
+<tasks:{task|<task>}; separator="\n">
+<tsLogic>
+<finalizerLogics:{finalizerLogic|<finalizerLogic>}; separator="\n">
+<ctxRefs:{ctxRef|<ctxRef>}; separator="\n">
+>>
+
+policyStateOutput(policyName, version, stateName, outputName, eventName, eventVersion, nextState) ::= <<
+policy state output create name=<policyName><if(version)> version=<version><endif> stateName=<stateName> outputName=<outputName> eventName=<eventName><if(eventVersion)> eventVersion=<eventVersion><endif><if(nextState)> nextState=<nextState><endif>
+>>
+
+policyStateTaskSelectionLogic(name, version, stateName, logicFlavour, logic) ::= <<
+policy state selecttasklogic create name=<name><if(version)> version=<version><endif> stateName=<stateName><if(logicFlavour)> logicFlavour=<logicFlavour><endif><if(logic)> logic=LS
+<logic>
+LE<endif>
+>>
+
+policyStateTask(policyName, version, stateName, taskLocalName, taskName, taskVersion, outputType, outputName) ::= <<
+policy state taskref create name=<policyName><if(version)> version=<version><endif> stateName=<stateName><if(taskLocalName)> taskLocalName=<taskLocalName><endif> taskName=<taskName><if(taskVersion)> taskVersion=<taskVersion><endif> outputType=<outputType> outputName=<outputName>
+>>
+
+policyStateFinalizerLogic(name, version, stateName, finalizerLogicName, logicFlavour, logic) ::= <<
+policy state finalizerlogic create name=<name><if(version)> version=<version><endif> stateName=<stateName> finalizerLogicName=<finalizerLogicName><if(logicFlavour)> logicFlavour=<logicFlavour><endif><if(logic)> logic=LS
+<logic>
+LE<endif>
+>>
+
+policyStateContextRef(name, version, stateName, albumName, albumVersion) ::= <<
+policy state contextref create name=<name><if(version)> version=<version><endif> stateName=<stateName> albumName=<albumName><if(albumVersion)> albumVersion=<albumVersion><endif>
+>>
diff --git a/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/StErrorListener.java b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/StErrorListener.java
new file mode 100644
index 000000000..ed703da82
--- /dev/null
+++ b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/StErrorListener.java
@@ -0,0 +1,111 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.auth.clicodegen;
+
+import org.stringtemplate.v4.STErrorListener;
+import org.stringtemplate.v4.misc.STMessage;
+
+/**
+ * Customized ST error listener.
+ *
+ * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+ */
+public class StErrorListener implements STErrorListener {
+
+ /** Counts errors of the listener. */
+ private int errorCount;
+
+ /* (non-Javadoc)
+ * @see org.stringtemplate.v4.STErrorListener#IOError(org.stringtemplate.v4.misc.STMessage)
+ */
+ @Override
+ public void IOError(final STMessage msg) {
+ switch (msg.error) {
+ default:
+ this.registerErrors(msg);
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.stringtemplate.v4.STErrorListener#compileTimeError(org.stringtemplate.v4.misc.STMessage)
+ */
+ @Override
+ public void compileTimeError(final STMessage msg) {
+ switch (msg.error) {
+ default:
+ this.registerErrors(msg);
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.stringtemplate.v4.STErrorListener#internalError(org.stringtemplate.v4.misc.STMessage)
+ */
+ @Override
+ public void internalError(final STMessage msg) {
+ switch (msg.error) {
+ default:
+ this.registerErrors(msg);
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.stringtemplate.v4.STErrorListener#runTimeError(org.stringtemplate.v4.misc.STMessage)
+ */
+ @Override
+ public void runTimeError(final STMessage msg) {
+ switch (msg.error) {
+ case NO_SUCH_PROPERTY:
+ case ARGUMENT_COUNT_MISMATCH:
+ case ANON_ARGUMENT_MISMATCH:
+ break;
+ default:
+ this.registerErrors(msg);
+ }
+ }
+
+ /**
+ * Registers an error with the local error listener and increases the error count.
+ *
+ * @param msg error message
+ */
+ protected void registerErrors(final STMessage msg) {
+ setErrorCount(getErrorCount() + 1);
+ System.err.println("STG/ST (" + msg.error + ") " + msg.arg + " -> " + msg.cause);
+ }
+
+ /**
+ * Gets the error count.
+ *
+ * @return the error count
+ */
+ protected int getErrorCount() {
+ return errorCount;
+ }
+
+ /**
+ * Sets the error count.
+ *
+ * @param errorCount the new error count
+ */
+ protected void setErrorCount(final int errorCount) {
+ this.errorCount = errorCount;
+ }
+}
diff --git a/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/TestSTG.java b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/TestSTG.java
new file mode 100644
index 000000000..1fbc78de9
--- /dev/null
+++ b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/TestSTG.java
@@ -0,0 +1,138 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.auth.clicodegen;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
+
+import org.junit.Test;
+import org.onap.policy.apex.auth.clicodegen.CGCliEditor;
+import org.stringtemplate.v4.STGroup;
+import org.stringtemplate.v4.STGroupFile;
+
+/**
+ * Test for the CG CLI Editor STG file.
+ *
+ * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+ */
+public class TestSTG {
+
+ /**
+ * Get the chunks for the codegen.
+ *
+ * @return the chunks
+ */
+ private static Map<String, List<String>> getCodeGenChunks() {
+ // CHECKSTYLE:OFF: LineLength
+
+ final Map<String, List<String>> chunks = new LinkedHashMap<>();
+
+ chunks.put("/policyModel",
+ Arrays.asList("name", "version", "uuid", "description", "declarations", "definitions"));
+ chunks.put("/schemaDecl", Arrays.asList("name", "version", "uuid", "description", "flavour", "schema"));
+ chunks.put("/ctxAlbumDecl", Arrays.asList("name", "version", "uuid", "description", "scope", "writable",
+ "schemaName", "schemaVersion"));
+ chunks.put("/eventDecl",
+ Arrays.asList("name", "version", "uuid", "description", "nameSpace", "source", "target", "fields"));
+ chunks.put("/eventDefField",
+ Arrays.asList("eventName", "version", "fieldName", "fieldSchema", "fieldSchemaVersion", "optional"));
+ chunks.put("/taskDecl",
+ Arrays.asList("name", "version", "uuid", "description", "infields", "outfields", "logic"));
+ chunks.put("/taskDefInputFields",
+ Arrays.asList("taskName", "version", "fieldName", "fieldSchema", "fieldSchemaVersion"));
+ chunks.put("/taskDefOutputFields",
+ Arrays.asList("taskName", "version", "fieldName", "fieldSchema", "fieldSchemaVersion"));
+ chunks.put("/taskDefLogic", Arrays.asList("taskName", "version", "flavour", "logic"));
+ chunks.put("/taskDefParameter", Arrays.asList("name", "version", "parName", "defaultValue"));
+ chunks.put("/taskDefCtxRef", Arrays.asList("name", "version", "albumName", "albumVersion"));
+ chunks.put("/policyDef", Arrays.asList("name", "version", "uuid", "description", "template", "firstState"));
+ chunks.put("/policyStateDef", Arrays.asList("policyName", "version", "stateName", "triggerName",
+ "triggerVersion", "defaultTask", "defaultTaskVersion", "outputs", "tasks"));
+ chunks.put("/policyStateOutput", Arrays.asList("policyName", "version", "stateName", "outputName", "eventName",
+ "eventVersion", "nextState"));
+ chunks.put("/policyStateTaskSelectionLogic",
+ Arrays.asList("name", "version", "stateName", "logicFlavour", "logic"));
+ chunks.put("/policyStateTask", Arrays.asList("policyName", "version", "stateName", "taskLocalName", "taskName",
+ "taskVersion", "outputType", "outputName"));
+ chunks.put("/policyStateFinalizerLogic",
+ Arrays.asList("name", "version", "stateName", "finalizerLogicName", "logicFlavour", "logic"));
+ chunks.put("/policyStateContextRef",
+ Arrays.asList("name", "version", "stateName", "albumName", "albumVersion"));
+
+ return chunks;
+ // CHECKSTYLE:ON: LineLength
+ }
+
+ /** Test STG load. */
+ @Test
+ public void testSTGLoad() {
+ final StErrorListener errListener = new StErrorListener();
+ final STGroupFile stg = new STGroupFile(CGCliEditor.STG_FILE);
+ stg.setListener(errListener);
+
+ stg.getTemplateNames(); // dummy to compile group and get errors
+ assertEquals(0, errListener.getErrorCount());
+ }
+
+ /** Test STG chunks. */
+ @Test
+ public void testSTGChunks() {
+ final StErrorListener errListener = new StErrorListener();
+ final STGroupFile stg = new STGroupFile(CGCliEditor.STG_FILE);
+ stg.setListener(errListener);
+
+ stg.getTemplateNames(); // dummy to compile group and get errors
+ final Map<String, List<String>> chunks = getCodeGenChunks();
+ String error = "";
+ final Set<String> definedNames = stg.getTemplateNames();
+ for (final STGroup group : stg.getImportedGroups()) {
+ definedNames.addAll(group.getTemplateNames());
+ }
+ final Set<String> requiredNames = chunks.keySet();
+
+ for (final String required : requiredNames) {
+ if (!definedNames.contains(required)) {
+ error += " - target STG does not define template for <" + required + ">\n";
+ } else {
+ final Set<String> definedParams = ((stg.getInstanceOf(required).getAttributes() == null)
+ ? new TreeSet<String>() : stg.getInstanceOf(required).getAttributes().keySet());
+ final List<String> requiredParams = chunks.get(required);
+ for (final String reqArg : requiredParams) {
+ if (!definedParams.contains(reqArg)) {
+ error += " - target STG with template <" + required + "> does not define argument <" + reqArg
+ + ">\n";
+ }
+ }
+ }
+ }
+
+ if (!("".equals(error))) {
+ System.err.println(error);
+ }
+ assertEquals(0, error.length());
+ }
+}