From 5722440b2eb8ff1923dda9d4d856f0adc1ac8e6f Mon Sep 17 00:00:00 2001 From: "waqas.ikram" Date: Fri, 1 Jun 2018 14:23:01 +0100 Subject: Adding apex auth modules Change-Id: Iec210465636458f0c104c99893440706279062f0 Issue-ID: POLICY-860 Signed-off-by: waqas.ikram --- auth/cli-codegen/pom.xml | 42 + .../policy/apex/auth/clicodegen/CGCliEditor.java | 515 +++ .../apex/auth/clicodegen/CgStringRenderer.java | 71 + .../policy/apex/auth/clicodegen/package-info.java | 26 + .../policy/apex/auth/clicodegen/cli-editor.stg | 129 + .../apex/auth/clicodegen/StErrorListener.java | 111 + .../onap/policy/apex/auth/clicodegen/TestSTG.java | 138 + auth/cli-editor/pom.xml | 47 + .../apex/auth/clieditor/ApexCLIEditorMain.java | 195 + .../apex/auth/clieditor/ApexModelHandler.java | 185 + .../apex/auth/clieditor/ApexModelProperties.java | 215 ++ .../policy/apex/auth/clieditor/CLIArgument.java | 144 + .../apex/auth/clieditor/CLIArgumentValue.java | 91 + .../policy/apex/auth/clieditor/CLICommand.java | 240 ++ .../policy/apex/auth/clieditor/CLICommands.java | 42 + .../policy/apex/auth/clieditor/CLIEditorLoop.java | 543 +++ .../policy/apex/auth/clieditor/CLIException.java | 49 + .../policy/apex/auth/clieditor/CLILineParser.java | 321 ++ .../apex/auth/clieditor/CLIParameterParser.java | 156 + .../policy/apex/auth/clieditor/CLIParameters.java | 571 +++ .../policy/apex/auth/clieditor/KeywordNode.java | 188 + .../policy/apex/auth/clieditor/package-info.java | 28 + .../resources/etc/editor/ApexModelProperties.json | 9 + .../src/main/resources/etc/editor/Commands.json | 2427 ++++++++++++ .../examples/scripts/ShellPolicyModel.apex | 23 + .../scripts/ShellPolicyModelAddSchema.apex | 21 + .../scripts/TestPolicyAvroEventContext.apex | 569 +++ .../scripts/TestPolicyJavaEventContext.apex | 324 ++ .../auth/clieditor/TestCLIEditorEventsContext.java | 103 + .../apex/auth/clieditor/TestCLIEditorOptions.java | 277 ++ .../auth/clieditor/TestCLIEditorScripting.java | 132 + .../apex/auth/clieditor/TestContextAlbums.java | 93 + .../policy/apex/auth/clieditor/TestFileMacro.java | 115 + .../policy/apex/auth/clieditor/TestLogicBlock.java | 117 + .../resources/compare/AvroSchemaModel_Compare.json | 239 ++ .../compare/ContextAlbumsModel_Compare.json | 1625 ++++++++ .../resources/compare/FileMacroModel_Compare.json | 361 ++ .../test/resources/compare/FileMacro_Compare.log | 77 + .../compare/FuzzyPolicyModel_Compare.json | 3897 ++++++++++++++++++++ .../resources/compare/LogicBlockModel_Compare.json | 374 ++ .../cli-editor/src/test/resources/logback-test.xml | 78 + .../src/test/resources/macros/MacroFile0.apexmacro | 1 + .../src/test/resources/macros/MacroFile1.apexmacro | 1 + .../src/test/resources/macros/MacroFile2.apexmacro | 1 + .../src/test/resources/macros/MacroFile3.apexmacro | 1 + .../src/test/resources/macros/MacroFile4.apexmacro | 1 + .../src/test/resources/macros/MacroFile5.apexmacro | 1 + .../src/test/resources/macros/MacroFile6.apexmacro | 1 + .../src/test/resources/macros/MacroFile7.apexmacro | 2 + .../src/test/resources/macros/MacroFile8.apexmacro | 2 + .../src/test/resources/macros/MacroFile9.apexmacro | 2 + .../src/test/resources/scripts/AvroSchema.apex | 57 + .../src/test/resources/scripts/ContextAlbums.apex | 81 + .../src/test/resources/scripts/FileMacro.apex | 49 + .../src/test/resources/scripts/LogicBlock.apex | 110 + .../src/test/resources/scripts/SampleLBPolicy.apex | 345 ++ .../resources/scripts/SampleLBPolicy_WithMap.apex | 430 +++ auth/pom.xml | 48 + 58 files changed, 16041 insertions(+) create mode 100644 auth/cli-codegen/pom.xml create mode 100644 auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CGCliEditor.java create mode 100644 auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java create mode 100644 auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/package-info.java create mode 100644 auth/cli-codegen/src/main/resources/org/onap/policy/apex/auth/clicodegen/cli-editor.stg create mode 100644 auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/StErrorListener.java create mode 100644 auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/TestSTG.java create mode 100644 auth/cli-editor/pom.xml create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexCLIEditorMain.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelHandler.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelProperties.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIArgument.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIArgumentValue.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommand.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommands.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIEditorLoop.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIException.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLILineParser.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIParameterParser.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLIParameters.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/KeywordNode.java create mode 100644 auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/package-info.java create mode 100644 auth/cli-editor/src/main/resources/etc/editor/ApexModelProperties.json create mode 100644 auth/cli-editor/src/main/resources/etc/editor/Commands.json create mode 100644 auth/cli-editor/src/main/resources/examples/scripts/ShellPolicyModel.apex create mode 100644 auth/cli-editor/src/main/resources/examples/scripts/ShellPolicyModelAddSchema.apex create mode 100644 auth/cli-editor/src/main/resources/examples/scripts/TestPolicyAvroEventContext.apex create mode 100644 auth/cli-editor/src/main/resources/examples/scripts/TestPolicyJavaEventContext.apex create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestCLIEditorEventsContext.java create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestCLIEditorOptions.java create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestCLIEditorScripting.java create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestContextAlbums.java create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestFileMacro.java create mode 100644 auth/cli-editor/src/test/java/org/onap/policy/apex/auth/clieditor/TestLogicBlock.java create mode 100644 auth/cli-editor/src/test/resources/compare/AvroSchemaModel_Compare.json create mode 100644 auth/cli-editor/src/test/resources/compare/ContextAlbumsModel_Compare.json create mode 100644 auth/cli-editor/src/test/resources/compare/FileMacroModel_Compare.json create mode 100644 auth/cli-editor/src/test/resources/compare/FileMacro_Compare.log create mode 100644 auth/cli-editor/src/test/resources/compare/FuzzyPolicyModel_Compare.json create mode 100644 auth/cli-editor/src/test/resources/compare/LogicBlockModel_Compare.json create mode 100644 auth/cli-editor/src/test/resources/logback-test.xml create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile0.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile1.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile2.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile3.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile4.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile5.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile6.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile7.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile8.apexmacro create mode 100644 auth/cli-editor/src/test/resources/macros/MacroFile9.apexmacro create mode 100644 auth/cli-editor/src/test/resources/scripts/AvroSchema.apex create mode 100644 auth/cli-editor/src/test/resources/scripts/ContextAlbums.apex create mode 100644 auth/cli-editor/src/test/resources/scripts/FileMacro.apex create mode 100644 auth/cli-editor/src/test/resources/scripts/LogicBlock.apex create mode 100644 auth/cli-editor/src/test/resources/scripts/SampleLBPolicy.apex create mode 100644 auth/cli-editor/src/test/resources/scripts/SampleLBPolicy_WithMap.apex create mode 100644 auth/pom.xml (limited to 'auth') 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 @@ + + + + 4.0.0 + + + org.onap.policy.apex-pdp.auth + auth + 2.0.0-SNAPSHOT + + + cli-codegen + ${project.artifactId} + ST4 based ode Generation module for CLI Editor create commands + + + + org.antlr + ST4 + 4.0.8 + + + \ 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 LS schema LE + */ + 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 + * LS some code LE + * @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 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 infields, final List outfields, final ST logic, final List parameters, + final List 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 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 outputs, final List tasks, final List tsLogic, + final List finalizerLogics, final List 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 + * LS some code LE + * @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 + * LS some code LE + * @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 <sven.van.der.meer@ericsson.com> + */ + +policyModel(name, version, uuid, description, declarations, definitions) ::= << +model create name= version= uuid= description= + +}; separator="\n"> + +}; separator="\n"> + +>> + +schemaDecl(name, version, uuid, description, flavour, schema) ::= << +schema create name= version= uuid= description= flavour= schema= + +>> + + +ctxAlbumDecl(name, version, uuid, description, scope, writable, schemaName, schemaVersion) ::= << +album create name= version= uuid= description= scope= writable= schemaName= schemaVersion= +>> + + +eventDecl(name, version, uuid, description, nameSpace, source, target, fields) ::= << +event create name= version= uuid= description= nameSpace= source= target= +}; separator="\n"> + +>> + +eventDefField(eventName, version, fieldName, fieldSchema, fieldSchemaVersion, optional) ::= << +event parameter create name= version= parName= schemaName= schemaVersion= optional= +>> + + +taskDecl(name, version, uuid, description, infields, outfields, logic, parameters, contextRefs) ::= << +task create name= version= uuid= description= +}; separator="\n"> +}; separator="\n"> + +}; separator="\n"> +}; separator="\n"> +>> + +taskDefInputFields(taskName, version, fieldName, fieldSchema, fieldSchemaVersion) ::= << +task inputfield create name= version= fieldName= schemaName= schemaVersion= +>> + +taskDefOutputFields(taskName, version, fieldName, fieldSchema, fieldSchemaVersion) ::= << +task outputfield create name= version= fieldName= schemaName= schemaVersion= +>> + +taskDefLogic(taskName, version, flavour, logic) ::= << +task logic create name= version= logicFlavour= logic=LS + +LE +>> + +taskDefParameter(name, version, parName, defaultValue) ::= << +task parameter create name= version= parName= defaultValue= +>> + +taskDefCtxRef(name, version, albumName, albumVersion) ::= << +task contextref create name= version= albumName= albumVersion= +>> + + +policyDef(name, version, uuid, description, template, firstState, states) ::= << +policy create name= version= uuid= description= template=