Display default values in help section of testtool
[netconf.git] / netconf / tools / netconf-testtool / src / main / java / org / opendaylight / netconf / test / tool / TesttoolParameters.java
index 0ad0f1831c8d5dd3b4606b518c9d537c55301554..c6c48d1cd663f277ba8b8a3416809ce05cf265e7 100644 (file)
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.test.tool;
 
 import static com.google.common.base.Preconditions.checkArgument;
 
-import com.google.common.base.Charsets;
-import com.google.common.base.Preconditions;
-import com.google.common.io.CharStreams;
-import com.google.common.io.Files;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.util.ArrayList;
+import java.lang.reflect.Field;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
+import java.util.StringJoiner;
 import java.util.concurrent.TimeUnit;
-import java.util.regex.Pattern;
 import net.sourceforge.argparse4j.ArgumentParsers;
 import net.sourceforge.argparse4j.annotation.Arg;
 import net.sourceforge.argparse4j.inf.ArgumentParser;
 import net.sourceforge.argparse4j.inf.ArgumentParserException;
+import org.opendaylight.yangtools.yang.common.YangConstants;
 
-public class TesttoolParameters {
-
-    private static final String HOST_KEY = "{HOST}";
-    private static final String PORT_KEY = "{PORT}";
-    private static final String SSH = "{SSH}";
-    private static final String ADDRESS_PORT = "{ADDRESS:PORT}";
-    private static final String dest = "http://{ADDRESS:PORT}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/{PORT}-sim-device";
-
-    private static final String RESOURCE = "/config-template.xml";
-    private InputStream stream;
-
-    @Arg(dest = "edit-content")
-    public File editContent;
+@SuppressFBWarnings({"DM_EXIT"})
+public final class TesttoolParameters {
 
     @Arg(dest = "async")
     public boolean async;
-
     @Arg(dest = "thread-amount")
     public int threadAmount;
-
     @Arg(dest = "throttle")
     public int throttle;
-
-    @Arg(dest = "auth")
-    public ArrayList<String> auth;
-
-    @Arg(dest = "controller-destination")
-    public String controllerDestination;
-
+    @Arg(dest = "controller-auth-username")
+    public String controllerAuthUsername;
+    @Arg(dest = "controller-auth-password")
+    public String controllerAuthPassword;
+    @Arg(dest = "controller-ip")
+    public String controllerIp;
+    @Arg(dest = "controller-port")
+    public Integer controllerPort;
     @Arg(dest = "schemas-dir")
     public File schemasDir;
-
     @Arg(dest = "devices-count")
     public int deviceCount;
-
     @Arg(dest = "devices-per-port")
     public int devicesPerPort;
-
     @Arg(dest = "starting-port")
     public int startingPort;
-
     @Arg(dest = "generate-config-connection-timeout")
     public int generateConfigsTimeout;
-
     @Arg(dest = "generate-config-address")
     public String generateConfigsAddress;
-
     @Arg(dest = "distro-folder")
     public File distroFolder;
-
     @Arg(dest = "generate-configs-batch-size")
     public int generateConfigBatchSize;
-
     @Arg(dest = "ssh")
     public boolean ssh;
-
     @Arg(dest = "exi")
-    public boolean exi;
-
+    public boolean exi = true;
     @Arg(dest = "debug")
     public boolean debug;
-
     @Arg(dest = "notification-file")
     public File notificationFile;
-
     @Arg(dest = "md-sal")
     public boolean mdSal;
-
     @Arg(dest = "initial-config-xml-file")
     public File initialConfigXMLFile;
-
     @Arg(dest = "time-out")
     public long timeOut;
-
     @Arg(dest = "ip")
     public String ip;
-
     @Arg(dest = "thread-pool-size")
     public int threadPoolSize;
+    @Arg(dest = "rpc-config")
+    public File rpcConfig;
 
+    @SuppressWarnings("checkstyle:lineLength")
     static ArgumentParser getParser() {
-        final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf testtool");
+        final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf testtool").defaultHelp(true);
 
         parser.description("netconf testtool");
 
@@ -118,7 +89,7 @@ public class TesttoolParameters {
 
         parser.addArgument("--async-requests")
                 .type(Boolean.class)
-                .setDefault(false)
+                .setDefault(Boolean.FALSE)
                 .dest("async");
 
         parser.addArgument("--thread-amount")
@@ -130,22 +101,37 @@ public class TesttoolParameters {
         parser.addArgument("--throttle")
                 .type(Integer.class)
                 .setDefault(5000)
-                .help("Maximum amount of async requests that can be open at a time, " +
-                        "with mutltiple threads this gets divided among all threads")
+                .help("Maximum amount of async requests that can be open at a time, "
+                        "with mutltiple threads this gets divided among all threads")
                 .dest("throttle");
 
-        parser.addArgument("--auth")
-                .nargs(2)
-                .help("Username and password for HTTP basic authentication in order username password.")
-                .dest("auth");
+        parser.addArgument("--controller-auth-username")
+                .type(String.class)
+                .setDefault("admin")
+                .help("Username for HTTP basic authentication to destination controller.")
+                .dest("controller-auth-username");
+
+        parser.addArgument("--controller-auth-password")
+                .type(String.class)
+                .setDefault("admin")
+                .help("Password for HTTP basic authentication to destination controller.")
+                .dest("controller-auth-password");
 
-        parser.addArgument("--controller-destination")
+        parser.addArgument("--controller-ip")
                 .type(String.class)
-                .help("Ip address and port of controller. Must be in following format <ip>:<port> "+
-                      "if available it will be used for spawning netconf connectors via topology configuration as "+
-                      "a part of URI. Example (http://<controller destination>/restconf/config/network-topology:network-topology/topology/topology-netconf/node/<node-id>)"+
-                      "otherwise it will just start simulated devices and skip the execution of PUT requests")
-                .dest("controller-destination");
+                .help("Ip of controller if available it will be used for spawning netconf connectors via topology"
+                        + " configuration as a part of"
+                        + " URI(http://<controller-ip>:<controller-port>/rests/data/...)"
+                        + " otherwise it will just start simulated devices and skip the execution of PATCH requests")
+                .dest("controller-ip");
+
+        parser.addArgument("--controller-port")
+                .type(Integer.class)
+                .help("Port of controller if available it will be used for spawning netconf connectors via topology "
+                        + "configuration as a part of"
+                        + " URI(http://<controller-ip>:<controller-port>/rests/data/...) "
+                        + "otherwise it will just start simulated devices and skip the execution of PATCH requests")
+                .dest("controller-port");
 
         parser.addArgument("--device-count")
                 .type(Integer.class)
@@ -156,7 +142,7 @@ public class TesttoolParameters {
         parser.addArgument("--devices-per-port")
                 .type(Integer.class)
                 .setDefault(1)
-                .help("Amount of config files generated per port to spoof more devices then are actually running")
+                .help("Amount of config files generated per port to spoof more devices than are actually running")
                 .dest("devices-per-port");
 
         parser.addArgument("--schemas-dir")
@@ -194,7 +180,7 @@ public class TesttoolParameters {
 
         parser.addArgument("--generate-configs-batch-size")
                 .type(Integer.class)
-                .setDefault(4000)
+                .setDefault(1)
                 .help("Number of connector configs per generated file")
                 .dest("generate-configs-batch-size");
 
@@ -205,40 +191,40 @@ public class TesttoolParameters {
 
         parser.addArgument("--ssh")
                 .type(Boolean.class)
-                .setDefault(true)
+                .setDefault(Boolean.TRUE)
                 .help("Whether to use ssh for transport or just pure tcp")
                 .dest("ssh");
 
         parser.addArgument("--exi")
                 .type(Boolean.class)
-                .setDefault(true)
+                .setDefault(Boolean.TRUE)
                 .help("Whether to use exi to transport xml content")
                 .dest("exi");
 
         parser.addArgument("--debug")
                 .type(Boolean.class)
-                .setDefault(false)
+                .setDefault(Boolean.FALSE)
                 .help("Whether to use debug log level instead of INFO")
                 .dest("debug");
 
         parser.addArgument("--md-sal")
                 .type(Boolean.class)
-                .setDefault(false)
+                .setDefault(Boolean.FALSE)
                 .help("Whether to use md-sal datastore instead of default simulated datastore.")
                 .dest("md-sal");
 
         parser.addArgument("--time-out")
                 .type(long.class)
                 .setDefault(20)
-                .help("the maximum time in seconds for executing each PUT request")
+                .help("the maximum time in seconds for executing each PATCH request")
                 .dest("time-out");
 
-        parser.addArgument("-ip")
+        parser.addArgument("--ip")
                 .type(String.class)
                 .setDefault("0.0.0.0")
-                .help("Ip address which will be used for creating a socket address." +
-                        "It can either be a machine name, such as " +
-                        "java.sun.com, or a textual representation of its IP address.")
+                .help("Ip address which will be used for creating a socket address."
+                        + "It can either be a machine name, such as "
+                        "java.sun.com, or a textual representation of its IP address.")
                 .dest("ip");
 
         parser.addArgument("--thread-pool-size")
@@ -246,11 +232,16 @@ public class TesttoolParameters {
                 .setDefault(8)
                 .help("The number of threads to keep in the pool, when creating a device simulator. Even if they are idle.")
                 .dest("thread-pool-size");
+        parser.addArgument("--rpc-config")
+                .type(File.class)
+                .help("Rpc config file. It can be used to define custom rpc behavior, or override the default one."
+                    + "Usable for testing buggy device behavior.")
+                .dest("rpc-config");
 
         return parser;
     }
 
-    public static TesttoolParameters parseArgs(final String[] args, final ArgumentParser parser) {
+    static TesttoolParameters parseArgs(final String[] args, final ArgumentParser parser) {
         final TesttoolParameters opt = new TesttoolParameters();
         try {
             parser.parseArgs(args, opt);
@@ -263,72 +254,58 @@ public class TesttoolParameters {
         return null;
     }
 
+    @SuppressWarnings("checkstyle:regexpSinglelineJava")
     void validate() {
-        if (editContent == null) {
-            stream = TesttoolParameters.class.getResourceAsStream(RESOURCE);
+        if (controllerIp != null) {
+            //FIXME Ip validation
+            checkArgument(controllerPort != null, "Controller port is missing");
+            //FIXME Is there specific bound
+            checkArgument(controllerPort >= 0, "Controller port should be non-negative integer");
+            checkArgument(controllerPort < 65354, "Controller port should be less than 65354");
         } else {
-            Preconditions.checkArgument(!editContent.isDirectory(), "Edit content file is a dir");
-            Preconditions.checkArgument(editContent.canRead(), "Edit content file is unreadable");
-        }
-
-        if (controllerDestination != null) {
-            Preconditions.checkArgument(controllerDestination.contains(":"), "Controller Destination needs to be in a following format <ip>:<port>");
-            String[] parts = controllerDestination.split(Pattern.quote(":"));
-            Preconditions.checkArgument(Integer.parseInt(parts[1]) > 0, "Port =< 0");
+            checkArgument(controllerPort == null, "Controller ip is missing");
         }
 
         checkArgument(deviceCount > 0, "Device count has to be > 0");
         checkArgument(startingPort > 1023, "Starting port has to be > 1023");
-        checkArgument(devicesPerPort > 0, "Atleast one device per port needed");
+        checkArgument(devicesPerPort > 0, "At least one device per port needed");
 
         if (schemasDir != null) {
             checkArgument(schemasDir.exists(), "Schemas dir has to exist");
             checkArgument(schemasDir.isDirectory(), "Schemas dir has to be a directory");
             checkArgument(schemasDir.canRead(), "Schemas dir has to be readable");
-        }
-    }
 
-    public ArrayList<ArrayList<Execution.DestToPayload>> getThreadsPayloads(List<Integer> openDevices) {
-        final String editContentString;
-        try {
-            if(stream == null)
-            {
-                editContentString = Files.toString(editContent, Charsets.UTF_8);
-            } else {
-                editContentString = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
+            final File[] filesArray = schemasDir.listFiles();
+            final List<File> files = filesArray != null ? Arrays.asList(filesArray) : Collections.emptyList();
+            for (final File file : files) {
+                checkArgument(file.canRead(), "Files in schemas dir has to be readable");
+                checkArgument(file.getName().endsWith(YangConstants.RFC6020_YANG_FILE_EXTENSION),
+                        "Files in schemas dir has to be YANG files");
             }
-        } catch (final IOException e) {
-            throw new IllegalArgumentException("Cannot read content of " + editContent);
         }
-
-        final ArrayList<ArrayList<Execution.DestToPayload>> allThreadsPayloads = new ArrayList<>();
-        for (int i = 0; i < threadAmount; i++) {
-            final ArrayList<Execution.DestToPayload> payloads = new ArrayList<>();
-            for (int j = 0; j < openDevices.size(); j++) {
-                final StringBuilder destBuilder = new StringBuilder(dest);
-                destBuilder.replace(destBuilder.indexOf(ADDRESS_PORT), destBuilder.indexOf(ADDRESS_PORT) + ADDRESS_PORT.length(), controllerDestination)
-                        .replace(destBuilder.indexOf(PORT_KEY), destBuilder.indexOf(PORT_KEY) + PORT_KEY.length(), Integer.toString(openDevices.get(j)));
-                payloads.add(new Execution.DestToPayload(destBuilder.toString(), prepareMessage(openDevices.get(j), editContentString)));
-            }
-            allThreadsPayloads.add(payloads);
+        if (rpcConfig != null) {
+            checkArgument(rpcConfig.exists(), "Rpc config file has to exist");
+            checkArgument(!rpcConfig.isDirectory(), "Rpc config file can't be a directory");
+            checkArgument(rpcConfig.canRead(), "Rpc config file to be readable");
         }
-
-        return allThreadsPayloads;
     }
 
-    private String prepareMessage(final int openDevice, final String editContentString) {
-        StringBuilder messageBuilder = new StringBuilder(editContentString);
+    @Override
+    public String toString() {
+        final List<Field> fields = Arrays.asList(this.getClass().getDeclaredFields());
+        final StringJoiner joiner = new StringJoiner(", \n", "TesttoolParameters{", "}\n");
+        fields.stream()
+                .filter(field -> field.getAnnotation(Arg.class) != null)
+                .map(this::getFieldString)
+                .forEach(joiner::add);
+        return joiner.toString();
+    }
 
-        if (editContentString.contains(HOST_KEY)) {
-            messageBuilder.replace(messageBuilder.indexOf(HOST_KEY), messageBuilder.indexOf(HOST_KEY) + HOST_KEY.length(), generateConfigsAddress);
-        }
-        if (editContentString.contains(PORT_KEY)) {
-            while (messageBuilder.indexOf(PORT_KEY) != -1)
-                messageBuilder.replace(messageBuilder.indexOf(PORT_KEY), messageBuilder.indexOf(PORT_KEY) + PORT_KEY.length(), Integer.toString(openDevice));
-        }
-        if (editContentString.contains(SSH)) {
-            messageBuilder.replace(messageBuilder.indexOf(SSH), messageBuilder.indexOf(SSH) + SSH.length(), Boolean.toString(ssh));
+    private String getFieldString(final Field field) {
+        try {
+            return field.getName() + "='" + field.get(this) + "'";
+        } catch (final IllegalAccessException e) {
+            return field.getName() + "= UNKNOWN";
         }
-        return messageBuilder.toString();
     }
 }