diff options
author | a.sreekumar <ajith.sreekumar@est.tech> | 2019-07-24 09:35:31 +0000 |
---|---|---|
committer | a.sreekumar <ajith.sreekumar@est.tech> | 2019-07-24 09:35:31 +0000 |
commit | a86ba140b1e100a2db2b04fc5f4f55bbb8eace42 (patch) | |
tree | f969bfdca22f9777b205d441d876e29fc8aa65d3 /auth/cli-editor/src/main/java | |
parent | 9e4e4474ee079176b26ed0af7105a4b23540d585 (diff) |
Extend APEX CLIEditor to generate policy in ToscaServiceTemplate format
Currently apex CLIEditor is used to generate a json policy model from
apex CLI language (.apex) file.
As per the new LifeCycle API, the policies are expected to be defined
as ToscaServiceTemplate. Hence, the current CLIEditor is extended to
generate the policies in ToscaServiceTemplate way.
Change-Id: I2eb5d5b146643d40b623e329a2a63d6bb0c1fb42
Issue-ID: POLICY-1885
Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
Diffstat (limited to 'auth/cli-editor/src/main/java')
8 files changed, 544 insertions, 385 deletions
diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexCommandLineEditorMain.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexCommandLineEditorMain.java index fc9424357..9258b45b8 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexCommandLineEditorMain.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexCommandLineEditorMain.java @@ -1,19 +1,20 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * 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========================================================= */ @@ -24,7 +25,7 @@ import java.io.IOException; import java.util.Arrays; import java.util.Set; import java.util.TreeSet; - +import org.onap.policy.apex.auth.clieditor.utils.CliUtils; import org.onap.policy.apex.model.utilities.json.JsonHandler; import org.slf4j.ext.XLogger; import org.slf4j.ext.XLoggerFactory; @@ -64,7 +65,7 @@ public class ApexCommandLineEditorMain { parameters = parser.parse(args); if (parameters.isHelpSet()) { - parser.help(ApexCommandLineEditorMain.class.getName()); + CliUtils.help(ApexCommandLineEditorMain.class.getName(), parser.getOptions()); return; } parameters.validate(); @@ -165,7 +166,7 @@ public class ApexCommandLineEditorMain { /** * Get the number of errors encountered in command processing. - * + * * @return the number of errors */ public int getErrorCount() { @@ -174,7 +175,7 @@ public class ApexCommandLineEditorMain { /** * Sets the number of errors encountered in command processing. - * + * * @param errorCount the number of errors */ public void setErrorCount(final int errorCount) { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineEditorLoop.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineEditorLoop.java index e95acedcd..b4f31b9e8 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineEditorLoop.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineEditorLoop.java @@ -1,19 +1,20 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * 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========================================================= */ @@ -38,7 +39,6 @@ import java.util.List; import java.util.Map.Entry; import java.util.Properties; import java.util.TreeMap; - import org.apache.commons.lang3.tuple.MutablePair; import org.apache.commons.lang3.tuple.Pair; import org.onap.policy.apex.model.modelapi.ApexApiResult; @@ -120,7 +120,7 @@ public class CommandLineEditorLoop { } // Get the output model - if (!parameters.isSuppressModelOutputSet()) { + if (!parameters.isSuppressModelOutput()) { final String modelString = modelHandler.writeModelToString(writer); if (parameters.checkSetOutputModelFileName()) { @@ -138,7 +138,7 @@ public class CommandLineEditorLoop { /** * Check if the command processing loop has come to an end. - * + * * @param executionStatus a pair containing the result of the last command and the accumulated error count * @param parameters the input parameters for command execution * @return true if the command processing loop should exit @@ -153,7 +153,7 @@ public class CommandLineEditorLoop { /** * Process the incoming commands one by one. - * + * * @param parameters the parameters to the CLI editor * @param reader the reader to read the logic block from * @param writer the writer to write results and error messages on @@ -178,7 +178,7 @@ public class CommandLineEditorLoop { line = expandMacroFile(parameters, line); } - if (parameters.isEchoSet()) { + if (parameters.isEcho()) { writer.println(line); } @@ -221,7 +221,7 @@ public class CommandLineEditorLoop { /** * Read a logic block, a block of program logic for a policy. - * + * * @param parameters the parameters to the CLI editor * @param reader the reader to read the logic block from * @param writer the writer to write results and error messages on @@ -244,7 +244,7 @@ public class CommandLineEditorLoop { logicLine = expandMacroFile(parameters, logicLine); } - if (parameters.isEchoSet()) { + if (parameters.isEcho()) { writer.println(logicLine); } @@ -549,7 +549,7 @@ public class CommandLineEditorLoop { /** * This method reads in the file from a file macro statement, expands the macro, and replaces the Macro tag in the * line with the file contents. - * + * * @param parameters The parameters for the CLI editor * @param line The line with the macro keyword in it * @return the expanded line diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameterParser.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameterParser.java index 3465a6dd8..d630d89a5 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameterParser.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameterParser.java @@ -1,19 +1,20 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * 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========================================================= */ @@ -22,10 +23,10 @@ package org.onap.policy.apex.auth.clieditor; import java.nio.file.Paths; import java.util.Arrays; - +import java.util.Properties; +import lombok.Getter; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.DefaultParser; -import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; @@ -35,17 +36,20 @@ import org.apache.commons.cli.ParseException; * * @author Liam Fallon (liam.fallon@ericsson.com) */ +@Getter public class CommandLineParameterParser { - private static final int MAX_HELP_LINE_LENGTH = 120; // Apache Commons CLI options private final Options options; + private Properties optionVariableMap; /** * Construct the options for the CLI editor. */ public CommandLineParameterParser() { options = new Options(); + optionVariableMap = new Properties(); + options.addOption(Option.builder("h").longOpt("help").desc("outputs the usage of this command").required(false) .type(Boolean.class).build()); options.addOption(Option.builder("m").longOpt("metadata-file").desc("name of the command metadata file to use") @@ -92,6 +96,21 @@ public class CommandLineParameterParser { * @return the CLI parameters */ public CommandLineParameters parse(final String[] args) { + CommandLine commandLine = parseDefault(args); + final CommandLineParameters parameters = new CommandLineParameters(); + parseSingleLetterOptions(commandLine, parameters); + parseDoubleLetterOptions(commandLine, parameters); + + return parameters; + } + + /** + * Parse the command line options using default parser. + * + * @param args The arguments + * @return the CLI parameters + */ + protected CommandLine parseDefault(final String[] args) { CommandLine commandLine = null; try { commandLine = new DefaultParser().parse(options, args); @@ -99,41 +118,40 @@ public class CommandLineParameterParser { throw new CommandLineException("invalid command line arguments specified : " + e.getMessage()); } - final CommandLineParameters parameters = new CommandLineParameters(); final String[] remainingArgs = commandLine.getArgs(); if (remainingArgs.length > 0) { throw new CommandLineException( "too many command line arguments specified : " + Arrays.toString(remainingArgs)); } - - parseSIngleLetterOptions(commandLine, parameters); - parseDoubleLetterOptions(commandLine, parameters); - - return parameters; + return commandLine; } /** * Parse options with just a single letter. - * + * * @param commandLine the command line * @param parameters the parsed parameters */ - private void parseDoubleLetterOptions(CommandLine commandLine, final CommandLineParameters parameters) { + protected void parseDoubleLetterOptions(CommandLine commandLine, final CommandLineParameters parameters) { if (commandLine.hasOption("nl")) { parameters.setSuppressLog(true); + optionVariableMap.setProperty("nl", "suppressLog"); } if (commandLine.hasOption("nm")) { parameters.setSuppressModelOutput(true); + optionVariableMap.setProperty("nm", "suppressModelOutput"); } if (commandLine.hasOption("if")) { parameters.setIgnoreCommandFailuresSet(true); parameters.setIgnoreCommandFailures(Boolean.valueOf(commandLine.getOptionValue("if"))); + optionVariableMap.setProperty("if", "ignoreCommandFailures"); } else { parameters.setIgnoreCommandFailuresSet(false); } if (commandLine.hasOption("wd")) { parameters.setWorkingDirectory(commandLine.getOptionValue("wd")); + optionVariableMap.setProperty("wd", "workingDirectory"); } else { parameters.setWorkingDirectory(Paths.get("").toAbsolutePath().toString()); } @@ -141,41 +159,39 @@ public class CommandLineParameterParser { /** * Parse options with two letters. - * + * * @param commandLine the command line * @param parameters the parsed parameters */ - private void parseSIngleLetterOptions(CommandLine commandLine, final CommandLineParameters parameters) { + protected void parseSingleLetterOptions(CommandLine commandLine, final CommandLineParameters parameters) { if (commandLine.hasOption('h')) { - parameters.setHelp(true); + parameters.setHelpSet(true); + optionVariableMap.setProperty("h", "helpSet"); } if (commandLine.hasOption('m')) { parameters.setMetadataFileName(commandLine.getOptionValue('m')); + optionVariableMap.setProperty("m", "metadataFileName"); } if (commandLine.hasOption('a')) { - parameters.setApexPorpertiesFileName(commandLine.getOptionValue('a')); + parameters.setApexPropertiesFileName(commandLine.getOptionValue('a')); + optionVariableMap.setProperty("a", "apexPropertiesFileName"); } if (commandLine.hasOption('c')) { parameters.setCommandFileName(commandLine.getOptionValue('c')); + optionVariableMap.setProperty("c", "commandFileName"); } if (commandLine.hasOption('l')) { parameters.setLogFileName(commandLine.getOptionValue('l')); + optionVariableMap.setProperty("l", "logFileName"); } if (commandLine.hasOption('i')) { parameters.setInputModelFileName(commandLine.getOptionValue('i')); + optionVariableMap.setProperty("i", "inputModelFileName"); } if (commandLine.hasOption('o')) { parameters.setOutputModelFileName(commandLine.getOptionValue('o')); + optionVariableMap.setProperty("o", "outputModelFileName"); } } - /** - * Print help information. - * - * @param mainClassName the main class name - */ - public void help(final String mainClassName) { - final HelpFormatter helpFormatter = new HelpFormatter(); - helpFormatter.printHelp(MAX_HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, ""); - } } diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java index 01eeb6162..87c7a0828 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,7 +28,9 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; - +import lombok.Getter; +import lombok.Setter; +import org.onap.policy.apex.auth.clieditor.utils.CliUtils; import org.onap.policy.common.utils.resources.ResourceUtils; /** @@ -35,9 +38,9 @@ import org.onap.policy.common.utils.resources.ResourceUtils; * * @author Liam Fallon (liam.fallon@ericsson.com) */ +@Setter +@Getter public class CommandLineParameters { - // Recurring string constants - private static final String OF_TYPE_TAG = " of type "; // Default location of the command definition meta data in JSON private static final String JSON_COMMAND_METADATA_RESOURCE = "etc/editor/Commands.json"; @@ -62,26 +65,26 @@ public class CommandLineParameters { * Validates the command line parameters. */ public void validate() { - validateReadableFile("Metadata File", metadataFileName); - validateReadableFile("Properties File", apexPropertiesFileName); - validateReadableFile("Command File", commandFileName); - validateReadableFile("Input Model File", inputModelFileName); - validateWritableFile("Output Model File", outputModelFileName); - validateWritableFile("Log File", logFileName); - validateWritableDirectory("Working Directory", workingDirectory); - - if (isSuppressLogSet()) { + CliUtils.validateReadableFile("Metadata File", metadataFileName); + CliUtils.validateReadableFile("Properties File", apexPropertiesFileName); + CliUtils.validateReadableFile("Command File", commandFileName); + CliUtils.validateReadableFile("Input Model File", inputModelFileName); + CliUtils.validateWritableFile("Output Model File", outputModelFileName); + CliUtils.validateWritableFile("Log File", logFileName); + CliUtils.validateWritableDirectory("Working Directory", workingDirectory); + + if (isSuppressLog()) { setEcho(false); } else { if (checkSetCommandFileName()) { setEcho(true); - if (!checkSetIgnoreCommandFailures()) { - setIgnoreCommandFailures(false); + if (!isIgnoreCommandFailuresSet()) { + setIgnoreCommandFailuresSet(false); } } else { setEcho(false); - if (!checkSetIgnoreCommandFailures()) { - setIgnoreCommandFailures(true); + if (!isIgnoreCommandFailuresSet()) { + setIgnoreCommandFailuresSet(true); } } } @@ -163,7 +166,7 @@ public class CommandLineParameters { */ public OutputStream getOutputStream() throws IOException { // Check if log suppression is active, if so, consume all output on a byte array output stream - if (isSuppressLogSet()) { + if (isSuppressLog()) { return new ByteArrayOutputStream(); } @@ -175,117 +178,6 @@ public class CommandLineParameters { } /** - * Validate that a file is readable. - * - * @param fileTag the file tag, a tag used for information and error messages - * @param fileName the file name to check - */ - private void validateReadableFile(final String fileTag, final String fileName) { - if (fileName == null) { - return; - } - final File theFile = new File(fileName); - final String prefixExceptionMessage = "File " + fileName + OF_TYPE_TAG + fileTag; - - if (!theFile.exists()) { - throw new CommandLineException(prefixExceptionMessage + " does not exist"); - } - if (!theFile.isFile()) { - throw new CommandLineException(prefixExceptionMessage + " is not a normal file"); - } - if (!theFile.canRead()) { - throw new CommandLineException(prefixExceptionMessage + " is ureadable"); - } - } - - /** - * Validate that a file is writable. - * - * @param fileTag the file tag, a tag used for information and error messages - * @param fileName the file name to check - */ - private void validateWritableFile(final String fileTag, final String fileName) { - if (fileName == null) { - return; - } - final File theFile = new File(fileName); - final String prefixExceptionMessage = "File " + fileName + OF_TYPE_TAG + fileTag; - if (theFile.exists()) { - if (!theFile.isFile()) { - throw new CommandLineException(prefixExceptionMessage + " is not a normal file"); - } - if (!theFile.canWrite()) { - throw new CommandLineException(prefixExceptionMessage + " cannot be written"); - } - } else { - try { - theFile.createNewFile(); - } catch (final IOException e) { - throw new CommandLineException(prefixExceptionMessage + " cannot be created: ", e); - } - } - } - - /** - * Validate that a directory exists and is writable. - * - * @param directoryTag the directory tag, a tag used for information and error messages - * @param directoryName the directory name to check - */ - private void validateWritableDirectory(final String directoryTag, final String directoryName) { - if (directoryName == null) { - return; - } - final File theDirectory = new File(directoryName); - final String prefixExceptionMessage = "directory " + directoryName + OF_TYPE_TAG + directoryTag; - - if (theDirectory.exists()) { - if (!theDirectory.isDirectory()) { - throw new CommandLineException(prefixExceptionMessage + " is not a directory"); - } - if (!theDirectory.canWrite()) { - throw new CommandLineException(prefixExceptionMessage + " cannot be written"); - } - } - } - - /** - * Checks if help is set. - * - * @return true, if help is set - */ - public boolean isHelpSet() { - return helpSet; - } - - /** - * Sets whether the help flag is set or not. - * - * @param isHelpSet the value of the help flag - */ - public void setHelp(final boolean isHelpSet) { - this.helpSet = isHelpSet; - } - - /** - * Gets the file name of the command metadata file for the editor commands. - * - * @return the file name of the command metadata file for the editor commands - */ - public String getMetadataFileName() { - return metadataFileName; - } - - /** - * Sets the file name of the command metadata file for the editor commands. - * - * @param metadataFileName the file name of the command metadata file for the editor commands - */ - public void setMetadataFileName(final String metadataFileName) { - this.metadataFileName = metadataFileName.trim(); - } - - /** * Check if the file name of the command metadata file for the editor commands is set. * * @return true, if the file name of the command metadata file for the editor commands is set @@ -295,28 +187,6 @@ public class CommandLineParameters { } /** - * Gets the file name of the file containing properties that are used for command default - * values. - * - * @return the file name of the file containing properties that are used for command default - * values - */ - public String getApexPorpertiesFileName() { - return apexPropertiesFileName; - } - - /** - * Sets the file name of the file containing properties that are used for command default - * values. - * - * @param apexPorpertiesFileName the file name of the file containing properties that are used - * for command default values - */ - public void setApexPorpertiesFileName(final String apexPorpertiesFileName) { - apexPropertiesFileName = apexPorpertiesFileName.trim(); - } - - /** * Check if the file name of the file containing properties that are used for command default * values is set. * @@ -328,25 +198,6 @@ public class CommandLineParameters { } /** - * Gets the name of the file containing commands to be streamed into the CLI editor. - * - * @return the name of the file containing commands to be streamed into the CLI editor - */ - public String getCommandFileName() { - return commandFileName; - } - - /** - * Sets the name of the file containing commands to be streamed into the CLI editor. - * - * @param commandFileName the name of the file containing commands to be streamed into the CLI - * editor - */ - public void setCommandFileName(final String commandFileName) { - this.commandFileName = commandFileName.trim(); - } - - /** * Check if the name of the file containing commands to be streamed into the CLI editor is set. * * @return true, if the name of the file containing commands to be streamed into the CLI editor @@ -357,28 +208,6 @@ public class CommandLineParameters { } /** - * Gets the name of the file containing the Apex model that will be used to initialize the Apex - * model in the CLI editor. - * - * @return the name of the file containing the Apex model that will be used to initialize the - * Apex model in the CLI editor - */ - public String getInputModelFileName() { - return inputModelFileName; - } - - /** - * Sets the name of the file containing the Apex model that will be used to initialize the Apex - * model in the CLI editor. - * - * @param inputModelFileName the name of the file containing the Apex model that will be used to - * initialize the Apex model in the CLI editor - */ - public void setInputModelFileName(final String inputModelFileName) { - this.inputModelFileName = inputModelFileName.trim(); - } - - /** * Check if the name of the file containing the Apex model that will be used to initialize the * Apex model in the CLI editor is set. * @@ -390,26 +219,6 @@ public class CommandLineParameters { } /** - * Gets the name of the file that the Apex CLI editor will save the Apex model to when it exits. - * - * @return the name of the file that the Apex CLI editor will save the Apex model to when it - * exits - */ - public String getOutputModelFileName() { - return outputModelFileName; - } - - /** - * Sets the name of the file that the Apex CLI editor will save the Apex model to when it exits. - * - * @param outputModelFileName the name of the file that the Apex CLI editor will save the Apex - * model to when it exits - */ - public void setOutputModelFileName(final String outputModelFileName) { - this.outputModelFileName = outputModelFileName.trim(); - } - - /** * Check if the name of the file that the Apex CLI editor will save the Apex model to when it * exits is set. * @@ -421,43 +230,6 @@ public class CommandLineParameters { } /** - * Gets the working directory that is the root for CLI editor macro includes. - * - * @return the CLI editor working directory - */ - public String getWorkingDirectory() { - return workingDirectory; - } - - /** - * Sets the working directory that is the root for CLI editor macro includes. - * - * @param workingDirectory the CLI editor working directory - */ - public void setWorkingDirectory(final String workingDirectory) { - this.workingDirectory = workingDirectory.trim(); - } - - /** - * Gets the name of the file to which the Apex CLI editor will log commands and responses. - * - * @return the name of the file to which the Apex CLI editor will log commands and responses - */ - public String getLogFileName() { - return logFileName; - } - - /** - * Sets the name of the file to which the Apex CLI editor will log commands and responses. - * - * @param logFileName the name of the file to which the Apex CLI editor will log commands and - * responses - */ - public void setLogFileName(final String logFileName) { - this.logFileName = logFileName.trim(); - } - - /** * Check if the name of the file to which the Apex CLI editor will log commands and responses is * set. * @@ -469,98 +241,6 @@ public class CommandLineParameters { } /** - * Checks if the Apex CLI editor is set to echo commands that have been entered. - * - * @return true, if the Apex CLI editor is set to echo commands that have been entered - */ - public boolean isEchoSet() { - return echo; - } - - /** - * Sets whether the Apex CLI editor should echo commands that have been entered. - * - * @param echo true, if the Apex CLI editor should echo commands that have been entered - */ - public void setEcho(final boolean echo) { - this.echo = echo; - } - - /** - * Checks whether the Apex CLI editor is set to suppress logging of command output. - * - * @return true, if the Apex CLI editor is set to suppress logging of command output. - */ - public boolean isSuppressLogSet() { - return suppressLog; - } - - /** - * Sets whether the Apex CLI editor should suppress logging of command output. - * - * @param suppressLog true, if the Apex CLI editor should suppress logging of command output - */ - public void setSuppressLog(final boolean suppressLog) { - this.suppressLog = suppressLog; - } - - /** - * Checks whether the Apex CLI editor is set to suppress output of its Apex model on exit. - * - * @return true, if checks if the Apex CLI editor is set to suppress output of its Apex model on - * exit - */ - public boolean isSuppressModelOutputSet() { - return suppressModelOutput; - } - - /** - * Sets whether the Apex CLI editor should suppress output of its Apex model on exit. - * - * @param suppressModelOutput true, if the Apex CLI editor should suppress output of its Apex - * model on exit - */ - public void setSuppressModelOutput(final boolean suppressModelOutput) { - this.suppressModelOutput = suppressModelOutput; - } - - /** - * Check if the command failures flag is set. - * - * @return true if the command failures flag has been set - */ - public boolean checkSetIgnoreCommandFailures() { - return ignoreCommandFailuresSet; - } - - /** - * Checks if the command failures flag is set. - * - * @param ignoreCommandFailuresSet true if the command failures flag has been set - */ - public void setIgnoreCommandFailuresSet(final boolean ignoreCommandFailuresSet) { - this.ignoreCommandFailuresSet = ignoreCommandFailuresSet; - } - - /** - * Checks if command failures should be ignored and command execution continue. - * - * @return true if command failures should be ignored - */ - public boolean isIgnoreCommandFailures() { - return ignoreCommandFailures; - } - - /** - * Sets if command errors should be ignored and command execution continue. - * - * @param ignoreCommandFailures true if command errors should be ignored - */ - public void setIgnoreCommandFailures(final boolean ignoreCommandFailures) { - this.ignoreCommandFailures = ignoreCommandFailures; - } - - /** * {@inheritDoc}. */ @Override diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaEditorMain.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaEditorMain.java new file mode 100644 index 000000000..8d4fd8b86 --- /dev/null +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaEditorMain.java @@ -0,0 +1,110 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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.clieditor.tosca; + +import java.io.File; +import java.io.IOException; +import java.util.Arrays; +import java.util.List; +import lombok.Getter; +import org.onap.policy.apex.auth.clieditor.ApexCommandLineEditorMain; +import org.onap.policy.apex.auth.clieditor.CommandLineParameters; +import org.onap.policy.apex.auth.clieditor.utils.CliUtils; +import org.onap.policy.common.utils.coder.CoderException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This class initiates an Apex CLI Tosca editor. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +public class ApexCliToscaEditorMain { + + private static final Logger LOGGER = LoggerFactory.getLogger(ApexCliToscaEditorMain.class); + + @Getter + private boolean failure; + private ApexCliToscaParameters parameters; + private ApexCommandLineEditorMain apexCliEditor; + + /** + * Instantiates the Apex CLI Tosca editor. + * + * @param args the command line arguments + */ + public ApexCliToscaEditorMain(final String[] args) { + final String argumentString = Arrays.toString(args); + LOGGER.info("Starting Apex CLI Tosca editor with arguments - {}", argumentString); + + final ApexCliToscaParameterParser parser = new ApexCliToscaParameterParser(); + parameters = parser.parse(args); + if (parameters.isHelpSet()) { + CliUtils.help(ApexCliToscaEditorMain.class.getName(), parser.getOptions()); + return; + } + parameters.validate(); + + String policyModelFilePath = null; + try { + final File tempModelFile = File.createTempFile("policyModel",".json"); + policyModelFilePath = tempModelFile.getAbsolutePath(); + } catch (IOException e) { + LOGGER.error("Cannot create the policy model temp file.", e); + } + + List<String> cliArgsList = CliUtils.generateArgumentsForCliEditor(parameters, parser.getOptionVariableMap(), + CommandLineParameters.class); + cliArgsList.add("-o"); + cliArgsList.add(policyModelFilePath); + String[] cliArgs = cliArgsList.toArray(new String[cliArgsList.size()]); + + apexCliEditor = new ApexCommandLineEditorMain(cliArgs); + if (apexCliEditor.getErrorCount() == 0) { + LOGGER.info("Apex CLI editor completed execution. Creating the ToscaPolicy using the tosca template" + + "skeleton file, config file, and policy model created."); + + // Create the ToscaPolicy using the tosca template skeleton file, config file, and policy model created. + try { + CliUtils.createToscaServiceTemplate(parameters, policyModelFilePath); + LOGGER.info("Apex CLI Tosca editor completed execution."); + } catch (IOException | CoderException e) { + failure = true; + LOGGER.error("Failed to create the ToscaPolicy using the generated policy model, apex config file and" + + " the tosca template skeleton file."); + } + } else { + failure = true; + LOGGER.error("execution of Apex command line editor failed: {} command execution failure(s) occurred", + apexCliEditor.getErrorCount()); + } + + } + + /** + * The main method, kicks off the cli tosca editor. + * + * @param args the arguments + */ + public static void main(final String[] args) { + new ApexCliToscaEditorMain(args); + } +} diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameterParser.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameterParser.java new file mode 100644 index 000000000..d5c66858f --- /dev/null +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameterParser.java @@ -0,0 +1,74 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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.clieditor.tosca; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.Option; +import org.onap.policy.apex.auth.clieditor.CommandLineParameterParser; + +/** + * This class reads and handles command line parameters to the Apex CLI Tosca editor. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +public class ApexCliToscaParameterParser extends CommandLineParameterParser { + + /** + * Construct the options for the CLI editor. + */ + public ApexCliToscaParameterParser() { + getOptions().addOption(Option.builder("ac").longOpt("apex-config-file") + .desc("name of the file containing apex configuration details").hasArg() + .argName("APEX_CONFIG_FILE").required(false).type(String.class).build()); + getOptions().addOption(Option.builder("t").longOpt("tosca-template-file") + .desc("name of the input file containing tosca template which needs to be updated with policy").hasArg() + .argName("TOSCA_TEMPLATE_FILE").required(false).type(String.class).build()); + getOptions().addOption(Option.builder("ot").longOpt("output-tosca-file") + .desc("name of a file that will contain the output model for the editor").hasArg() + .argName("OUTPUT_TOSCA_FILE").required(false).type(String.class).build()); + } + + /** + * Parse the command line options. + * + * @param args The arguments + * @return the CLI parameters + */ + @Override + public ApexCliToscaParameters parse(final String[] args) { + CommandLine commandLine = parseDefault(args); + final ApexCliToscaParameters parameters = new ApexCliToscaParameters(); + parseSingleLetterOptions(commandLine, parameters); + parseDoubleLetterOptions(commandLine, parameters); + + if (commandLine.hasOption("ac")) { + parameters.setApexConfigFileName(commandLine.getOptionValue("ac")); + } + if (commandLine.hasOption("t")) { + parameters.setInputToscaTemplateFileName(commandLine.getOptionValue("t")); + } + if (commandLine.hasOption("ot")) { + parameters.setOutputToscaPolicyFileName(commandLine.getOptionValue("ot")); + } + return parameters; + } + +} diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameters.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameters.java new file mode 100644 index 000000000..49f790c5d --- /dev/null +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/tosca/ApexCliToscaParameters.java @@ -0,0 +1,57 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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.clieditor.tosca; + +import lombok.Getter; +import lombok.Setter; +import org.onap.policy.apex.auth.clieditor.CommandLineException; +import org.onap.policy.apex.auth.clieditor.CommandLineParameters; +import org.onap.policy.apex.auth.clieditor.utils.CliUtils; + +/** + * This class reads and handles command line parameters to the Apex CLI Tosca editor. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ + +@Setter +@Getter +public class ApexCliToscaParameters extends CommandLineParameters { + + // The cli tosca editor parameters + private String apexConfigFileName = null; + private String inputToscaTemplateFileName = null; + private String outputToscaPolicyFileName = null; + + /** + * Validates the command line parameters. + */ + @Override + public void validate() { + if ((null == apexConfigFileName) || (null == inputToscaTemplateFileName) || (null == getCommandFileName())) { + throw new CommandLineException("Insufficient arguments provided."); + } + super.validate(); + CliUtils.validateReadableFile("Apex Config File", apexConfigFileName); + CliUtils.validateReadableFile("Input Tosca Template File", inputToscaTemplateFileName); + CliUtils.validateWritableFile("Output Tosca Policy File", outputToscaPolicyFileName); + } +} diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/utils/CliUtils.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/utils/CliUtils.java new file mode 100644 index 000000000..2454f39fa --- /dev/null +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/utils/CliUtils.java @@ -0,0 +1,221 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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.clieditor.utils; + +import com.google.gson.JsonObject; +import java.beans.PropertyDescriptor; +import java.io.File; +import java.io.IOException; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.List; +import java.util.Map.Entry; +import java.util.Properties; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Options; +import org.apache.commons.lang3.StringUtils; +import org.onap.policy.apex.auth.clieditor.CommandLineException; +import org.onap.policy.apex.auth.clieditor.CommandLineParameters; +import org.onap.policy.apex.auth.clieditor.tosca.ApexCliToscaParameters; +import org.onap.policy.common.utils.coder.CoderException; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.common.utils.resources.TextFileUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This class contains the utility methods specifically for Apex CLI Editor. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +public class CliUtils { + + private CliUtils() { + // This class cannot be initialized + } + + private static final Logger LOGGER = LoggerFactory.getLogger(CliUtils.class); + + // Recurring string constants + private static final String OF_TYPE_TAG = " of type "; + private static final int MAX_HELP_LINE_LENGTH = 120; + + /** + * Method to create apex policy in tosca service template. + * + * @param parameters containing paths to the apex config and tosca template skeleton file + * @param policyModelFilePath path of apex policy model + */ + public static void createToscaServiceTemplate(ApexCliToscaParameters parameters, String policyModelFilePath) + throws IOException, CoderException { + final StandardCoder standardCoder = new StandardCoder(); + String apexConfig = TextFileUtils.getTextFileAsString(parameters.getApexConfigFileName()); + JsonObject apexConfigJson = standardCoder.decode(apexConfig, JsonObject.class); + String policyModel = TextFileUtils.getTextFileAsString(policyModelFilePath); + JsonObject policyModelJson = standardCoder.decode(policyModel, JsonObject.class); + String toscaTemplate = TextFileUtils.getTextFileAsString(parameters.getInputToscaTemplateFileName()); + JsonObject toscaTemplateJson = standardCoder.decode(toscaTemplate, JsonObject.class); + + JsonObject engineServiceParameters = apexConfigJson.get("engineServiceParameters").getAsJsonObject(); + engineServiceParameters.add("policy_type_impl", policyModelJson); + JsonObject toscaPolicyProperties = toscaTemplateJson.get("topology_template").getAsJsonObject(); + JsonObject toscaPolicy = toscaPolicyProperties.get("policies").getAsJsonArray().get(0).getAsJsonObject(); + JsonObject toscaProperties = toscaPolicy.get(toscaPolicy.keySet().toArray()[0].toString()).getAsJsonObject() + .get("properties").getAsJsonObject(); + toscaProperties.add("content", apexConfigJson); + + final String toscaPolicyString = standardCoder.encode(toscaTemplateJson); + final String toscaPolicyFileName = parameters.getOutputToscaPolicyFileName(); + if (StringUtils.isNotBlank(toscaPolicyFileName)) { + TextFileUtils.putStringAsTextFile(toscaPolicyString, toscaPolicyFileName); + } else { + LOGGER.debug("Output file name not specified. Resulting tosca policy is {}", toscaPolicyString); + } + } + + /** + * Validate that a file is readable. + * + * @param fileTag the file tag, a tag used for information and error messages + * @param fileName the file name to check + */ + public static void validateReadableFile(final String fileTag, final String fileName) { + if (fileName == null) { + return; + } + final File theFile = new File(fileName); + final String prefixExceptionMessage = "File " + fileName + OF_TYPE_TAG + fileTag; + + if (!theFile.exists()) { + throw new CommandLineException(prefixExceptionMessage + " does not exist"); + } + if (!theFile.isFile()) { + throw new CommandLineException(prefixExceptionMessage + " is not a normal file"); + } + if (!theFile.canRead()) { + throw new CommandLineException(prefixExceptionMessage + " is ureadable"); + } + } + + /** + * Validate that a file is writable. + * + * @param fileTag the file tag, a tag used for information and error messages + * @param fileName the file name to check + */ + public static void validateWritableFile(final String fileTag, final String fileName) { + if (fileName == null) { + return; + } + final File theFile = new File(fileName); + final String prefixExceptionMessage = "File " + fileName + OF_TYPE_TAG + fileTag; + if (theFile.exists()) { + if (!theFile.isFile()) { + throw new CommandLineException(prefixExceptionMessage + " is not a normal file"); + } + if (!theFile.canWrite()) { + throw new CommandLineException(prefixExceptionMessage + " cannot be written"); + } + } else { + try { + if (theFile.createNewFile()) { + LOGGER.info("File {} does not exist. New file created.", fileName); + } + } catch (final IOException e) { + throw new CommandLineException(prefixExceptionMessage + " cannot be created: ", e); + } + } + } + + /** + * Validate that a directory exists and is writable. + * + * @param directoryTag the directory tag, a tag used for information and error messages + * @param directoryName the directory name to check + */ + public static void validateWritableDirectory(final String directoryTag, final String directoryName) { + if (directoryName == null) { + return; + } + final File theDirectory = new File(directoryName); + final String prefixExceptionMessage = "directory " + directoryName + OF_TYPE_TAG + directoryTag; + + if (theDirectory.exists()) { + if (!theDirectory.isDirectory()) { + throw new CommandLineException(prefixExceptionMessage + " is not a directory"); + } + if (!theDirectory.canWrite()) { + throw new CommandLineException(prefixExceptionMessage + " cannot be written"); + } + } else { + if (!theDirectory.mkdir()) { + throw new CommandLineException(prefixExceptionMessage + " doesn't exist and cannot be created."); + } + } + } + + /** + * Print help information. + * + * @param mainClassName the main class name + * @param options the options for cli editor + */ + public static void help(final String mainClassName, Options options) { + final HelpFormatter helpFormatter = new HelpFormatter(); + helpFormatter.printHelp(MAX_HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, ""); + } + + /** + * Method to generate arguments required for APEX CLI editor. + * + * @param parameters the command line parameters + * @param optionVariableMap the properties object containing the option and corresponding variable name + * @param class1 the class type in which the variable names has to be looked for + * @return list of arguments + */ + public static List<String> generateArgumentsForCliEditor(CommandLineParameters parameters, + Properties optionVariableMap, Class<?> class1) { + + List<String> cliArgsList = new ArrayList<>(); + PropertyDescriptor pd; + Method getter; + Object argValue; + + for (Entry<Object, Object> entry : optionVariableMap.entrySet()) { + try { + pd = new PropertyDescriptor(entry.getValue().toString(), class1); + getter = pd.getReadMethod(); + argValue = getter.invoke(parameters); + String key = entry.getKey().toString(); + + if (argValue instanceof String && !key.equals("o")) { + cliArgsList.add("-" + key); + cliArgsList.add(argValue.toString()); + } else if (argValue instanceof Boolean && (Boolean)argValue) { + cliArgsList.add("-" + key); + } + } catch (Exception e) { + LOGGER.error("Invalid getter method for the argument specfied.", e); + } + } + return cliArgsList; + } +} |