From 2b21188b82e21eb87c4e79a6f31beff9325ab2ea Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 27 Sep 2018 14:29:21 +0100 Subject: Add unit test for Apex command line tools THere was no unit test for the command line tools. This review adds unit test and also fixes a few small bugs that showed up when uit test was run. Issue-ID: POLICY-1034 Change-Id: Ic19aacdb168fb5a6faa0cd83ed22ccfcedaa51f5 Signed-off-by: liamfallon --- .../apex/tools/simple/wsclient/Application.java | 217 -------------------- .../apex/tools/simple/wsclient/WsClientMain.java | 223 +++++++++++++++++++++ 2 files changed, 223 insertions(+), 217 deletions(-) delete mode 100644 tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/Application.java create mode 100644 tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/WsClientMain.java (limited to 'tools/simple-wsclient/src/main/java/org') diff --git a/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/Application.java b/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/Application.java deleted file mode 100644 index e0b819f60..000000000 --- a/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/Application.java +++ /dev/null @@ -1,217 +0,0 @@ -/*- - * ============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.tools.simple.wsclient; - -import java.io.IOException; -import java.io.PrintStream; -import java.net.URISyntaxException; -import java.nio.channels.NotYetConnectedException; - -import org.apache.commons.cli.CommandLine; -import org.apache.commons.cli.HelpFormatter; -import org.apache.commons.lang3.Validate; -import org.onap.policy.apex.tools.common.CliOptions; -import org.onap.policy.apex.tools.common.CliParser; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Simple console application with main method. - * - * @author Sven van der Meer (sven.van.der.meer@ericsson.com) - */ -public final class Application { - // Get a reference to the logger - private static final Logger LOGGER = LoggerFactory.getLogger(Application.class); - - // Input and output streams - private static final PrintStream OUT_STREAM = System.out; - private static final PrintStream ERR_STREAM = System.err; - - /** - * Private constructor prevents subclassing. - */ - private Application() { - // Prevent subclassing - } - - /** - * The main method for the WS applications. - * - * @param args command line argument s - */ - public static void main(final String[] args) { - String appName = "ws-simple-echo"; - String appDescr = "receives events from APEX via WS and prints them to standard out"; - boolean console = false; - - final CliParser cli = new CliParser(); - cli.addOption(CliOptions.HELP); - cli.addOption(CliOptions.VERSION); - cli.addOption(CliOptions.CONSOLE); - cli.addOption(CliOptions.SERVER); - cli.addOption(CliOptions.PORT); - - final CommandLine cmd = cli.parseCli(args); - - if (cmd.hasOption('c') || cmd.hasOption("console")) { - appName = "ws-simple-console"; - appDescr = "takes events from stdin and sends via WS to APEX"; - console = true; - } - - // help is an exit option, print usage and exit - if (cmd.hasOption('h') || cmd.hasOption("help")) { - final HelpFormatter formatter = new HelpFormatter(); - OUT_STREAM.println(appName + " v" + cli.getAppVersion() + " - " + appDescr); - formatter.printHelp(appName, cli.getOptions()); - OUT_STREAM.println(); - return; - } - - // version is an exit option, print version and exit - if (cmd.hasOption('v') || cmd.hasOption("version")) { - OUT_STREAM.println(appName + " " + cli.getAppVersion()); - OUT_STREAM.println(); - return; - } - - runConsoleOrEcho(appName, console, cmd); - } - - /** - * Run the console or echo. - * @param appName the application name - * @param console if true, run the console otherwise run echo - * @param cmd the command line to run - */ - private static void runConsoleOrEcho(String appName, boolean console, final CommandLine cmd) { - String server = cmd.getOptionValue('s'); - if (server == null) { - server = cmd.getOptionValue("server"); - } - if (server == null) { - server = "localhost"; - } - - String port = cmd.getOptionValue('p'); - if (port == null) { - port = cmd.getOptionValue("port"); - } - if (port == null) { - port = "8887"; - } - - if (console) { - runConsole(server, port, appName); - } else { - runEcho(server, port, appName); - } - } - - /** - * Runs the simple echo client. - * - * @param server the server, must not be blank - * @param port the port, must not be blank - * @param appName the application name, must not be blank - */ - public static void runEcho(final String server, final String port, final String appName) { - Validate.notBlank(server); - Validate.notBlank(port); - Validate.notBlank(appName); - - OUT_STREAM.println(); - OUT_STREAM.println(appName + ": starting simple event echo"); - OUT_STREAM.println(" --> server: " + server); - OUT_STREAM.println(" --> port: " + port); - OUT_STREAM.println(); - OUT_STREAM.println("Once started, the application will simply print out all received events to standard out."); - OUT_STREAM.println("Each received event will be prefixed by '---' and suffixed by '===='"); - OUT_STREAM.println(); - OUT_STREAM.println(); - - try { - final SimpleEcho simpleEcho = new SimpleEcho(server, port, appName, OUT_STREAM, ERR_STREAM); - simpleEcho.connect(); - } catch (final URISyntaxException uex) { - String message = appName + ": URI exception, could not create URI from server and port settings"; - ERR_STREAM.println(message); - LOGGER.warn(message, uex); - } catch (final NullPointerException nex) { - String message = appName + ": null pointer, server or port were null"; - ERR_STREAM.println(message); - LOGGER.warn(message, nex); - } catch (final IllegalArgumentException iex) { - String message = appName + ": illegal argument, server or port were blank"; - ERR_STREAM.println(message); - LOGGER.warn(message, iex); - } - } - - /** - * Runs the simple console. - * - * @param server the server, must not be blank - * @param port the port, must not be blank - * @param appName the application name, must not be blank - */ - public static void runConsole(final String server, final String port, final String appName) { - Validate.notBlank(server); - Validate.notBlank(port); - Validate.notBlank(appName); - - OUT_STREAM.println(); - OUT_STREAM.println(appName + ": starting simple event console"); - OUT_STREAM.println(" --> server: " + server); - OUT_STREAM.println(" --> port: " + port); - OUT_STREAM.println(); - OUT_STREAM.println(" - terminate the application typing 'exit' or using 'CTRL+C'"); - OUT_STREAM.println(" - events are created by a non-blank starting line and terminated by a blank line"); - OUT_STREAM.println(); - OUT_STREAM.println(); - - try { - final SimpleConsole simpleConsole = new SimpleConsole(server, port, appName, OUT_STREAM, ERR_STREAM); - simpleConsole.runClient(); - } catch (final URISyntaxException uex) { - String message = appName + ": URI exception, could not create URI from server and port settings"; - ERR_STREAM.println(message); - LOGGER.warn(message, uex); - } catch (final NullPointerException nex) { - String message = appName + ": null pointer, server or port were null"; - ERR_STREAM.println(message); - LOGGER.warn(message, nex); - } catch (final IllegalArgumentException iex) { - String message = appName + ": illegal argument, server or port were blank"; - ERR_STREAM.println(message); - LOGGER.warn(message, iex); - } catch (final NotYetConnectedException nex) { - String message = appName + ": not yet connected, connection to server took too long"; - ERR_STREAM.println(message); - LOGGER.warn(message, nex); - } catch (final IOException ioe) { - String message = appName + ": IO exception, something went wrong on the standard input"; - ERR_STREAM.println(message); - LOGGER.warn(message, ioe); - } - } -} diff --git a/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/WsClientMain.java b/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/WsClientMain.java new file mode 100644 index 000000000..9376cad4b --- /dev/null +++ b/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/WsClientMain.java @@ -0,0 +1,223 @@ +/*- + * ============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.tools.simple.wsclient; + +import java.io.IOException; +import java.io.PrintStream; +import java.net.URISyntaxException; +import java.nio.channels.NotYetConnectedException; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.lang3.Validate; +import org.onap.policy.apex.tools.common.CliOptions; +import org.onap.policy.apex.tools.common.CliParser; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Simple console application with main method. + * + * @author Sven van der Meer (sven.van.der.meer@ericsson.com) + */ +public final class WsClientMain { + // Get a reference to the logger + private static final Logger LOGGER = LoggerFactory.getLogger(WsClientMain.class); + + /** + * Run the command. + * + * @param args the command line arguments + * @param outStream stream for output + */ + WsClientMain(final String[] args, final PrintStream outStream) { + String appName = "ws-simple-echo"; + String appDescr = "receives events from APEX via WS and prints them to standard out"; + boolean console = false; + + final CliParser cli = new CliParser(); + cli.addOption(CliOptions.HELP); + cli.addOption(CliOptions.VERSION); + cli.addOption(CliOptions.CONSOLE); + cli.addOption(CliOptions.SERVER); + cli.addOption(CliOptions.PORT); + + final CommandLine cmd = cli.parseCli(args); + + if (cmd.hasOption('c') || cmd.hasOption("console")) { + appName = "ws-simple-console"; + appDescr = "takes events from stdin and sends via WS to APEX"; + console = true; + } + + // help is an exit option, print usage and exit + if (cmd.hasOption('h') || cmd.hasOption("help")) { + final HelpFormatter formatter = new HelpFormatter(); + outStream.println(appName + " v" + cli.getAppVersion() + " - " + appDescr); + formatter.printHelp(appName, cli.getOptions()); + outStream.println(); + return; + } + + // version is an exit option, print version and exit + if (cmd.hasOption('v') || cmd.hasOption("version")) { + outStream.println(appName + " " + cli.getAppVersion()); + outStream.println(); + return; + } + + runConsoleOrEcho(appName, console, cmd, outStream); + } + + /** + * Run the console or echo. + * + * @param appName the application name + * @param console if true, run the console otherwise run echo + * @param cmd the command line to run + * @param outStream stream for output + */ + private static void runConsoleOrEcho(String appName, boolean console, final CommandLine cmd, + final PrintStream outStream) { + String server = cmd.getOptionValue('s'); + if (server == null) { + server = cmd.getOptionValue("server"); + } + if (server == null) { + server = "localhost"; + } + + String port = cmd.getOptionValue('p'); + if (port == null) { + port = cmd.getOptionValue("port"); + } + if (port == null) { + port = "8887"; + } + + if (console) { + runConsole(server, port, appName, outStream); + } else { + runEcho(server, port, appName, outStream); + } + } + + /** + * Runs the simple echo client. + * + * @param server the server, must not be blank + * @param port the port, must not be blank + * @param appName the application name, must not be blank + * @param outStream stream for output + */ + public static void runEcho(final String server, final String port, final String appName, + final PrintStream outStream) { + Validate.notBlank(server); + Validate.notBlank(port); + Validate.notBlank(appName); + + outStream.println(); + outStream.println(appName + ": starting simple event echo"); + outStream.println(" --> server: " + server); + outStream.println(" --> port: " + port); + outStream.println(); + outStream.println("Once started, the application will simply print out all received events to standard out."); + outStream.println("Each received event will be prefixed by '---' and suffixed by '===='"); + outStream.println(); + outStream.println(); + + try { + final SimpleEcho simpleEcho = new SimpleEcho(server, port, appName, outStream, outStream); + simpleEcho.connect(); + } catch (final URISyntaxException uex) { + String message = appName + ": URI exception, could not create URI from server and port settings"; + outStream.println(message); + LOGGER.warn(message, uex); + } catch (final NullPointerException nex) { + String message = appName + ": null pointer, server or port were null"; + outStream.println(message); + LOGGER.warn(message, nex); + } catch (final IllegalArgumentException iex) { + String message = appName + ": illegal argument, server or port were blank"; + outStream.println(message); + LOGGER.warn(message, iex); + } + } + + /** + * Runs the simple console. + * + * @param server the server, must not be blank + * @param port the port, must not be blank + * @param appName the application name, must not be blank + * @param outStream stream for output + */ + public static void runConsole(final String server, final String port, final String appName, + final PrintStream outStream) { + Validate.notBlank(server); + Validate.notBlank(port); + Validate.notBlank(appName); + + outStream.println(); + outStream.println(appName + ": starting simple event console"); + outStream.println(" --> server: " + server); + outStream.println(" --> port: " + port); + outStream.println(); + outStream.println(" - terminate the application typing 'exit' or using 'CTRL+C'"); + outStream.println(" - events are created by a non-blank starting line and terminated by a blank line"); + outStream.println(); + outStream.println(); + + try { + final SimpleConsole simpleConsole = new SimpleConsole(server, port, appName, outStream, outStream); + simpleConsole.runClient(); + } catch (final URISyntaxException uex) { + String message = appName + ": URI exception, could not create URI from server and port settings"; + outStream.println(message); + LOGGER.warn(message, uex); + } catch (final NullPointerException nex) { + String message = appName + ": null pointer, server or port were null"; + outStream.println(message); + LOGGER.warn(message, nex); + } catch (final IllegalArgumentException iex) { + String message = appName + ": illegal argument, server or port were blank"; + outStream.println(message); + LOGGER.warn(message, iex); + } catch (final NotYetConnectedException nex) { + String message = appName + ": not yet connected, connection to server took too long"; + outStream.println(message); + LOGGER.warn(message, nex); + } catch (final IOException ioe) { + String message = appName + ": IO exception, something went wrong on the standard input"; + outStream.println(message); + LOGGER.warn(message, ioe); + } + } + + /** + * The main method for the WS applications. + * + * @param args command line argument s + */ + public static void main(final String[] args) { + new WsClientMain(args, System.out); + } +} -- cgit 1.2.3-korg