Adjust to yangtools-2.0.0/odlparent-3.0.0 changes
[netconf.git] / netconf / tools / netconf-testtool / src / main / java / org / opendaylight / netconf / test / tool / TesttoolParameters.java
index 1d8eda8f7891298dce5769734490bd3d44925c61..dde89e478c94064545a7480840103b3a8ff2a8a9 100644 (file)
@@ -10,18 +10,24 @@ 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 java.io.BufferedReader;
 import java.io.File;
+import java.io.FileReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.lang.reflect.Field;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
+import java.util.StringJoiner;
 import java.util.concurrent.TimeUnit;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import net.sourceforge.argparse4j.ArgumentParsers;
 import net.sourceforge.argparse4j.annotation.Arg;
@@ -32,9 +38,13 @@ 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 TCP_ONLY = "{TCP_ONLY}";
     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/";
+    private static final String DEST =
+        "http://{ADDRESS:PORT}/restconf/config/network-topology:network-topology/topology/topology-netconf/";
+    private static final Pattern YANG_FILENAME_PATTERN = Pattern
+        .compile("(?<name>.*)@(?<revision>\\d{4}-\\d{2}-\\d{2})\\.yang");
+    private static final Pattern DATE_PATTERN = Pattern.compile("(\\d{4}-\\d{2}-\\d{2})");
 
     private static final String RESOURCE = "/config-template.json";
     @Arg(dest = "edit-content")
@@ -80,7 +90,14 @@ public class TesttoolParameters {
     @Arg(dest = "time-out")
     public long timeOut;
     private InputStream stream;
-
+    @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");
 
@@ -98,13 +115,14 @@ public class TesttoolParameters {
         parser.addArgument("--thread-amount")
                 .type(Integer.class)
                 .setDefault(1)
-                .dest("thread-amount");
+                .dest("thread-amount")
+                .help("The number of threads to use for configuring devices.");
 
         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")
@@ -114,10 +132,10 @@ public class TesttoolParameters {
 
         parser.addArgument("--controller-destination")
                 .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")
+                .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");
 
         parser.addArgument("--device-count")
@@ -206,6 +224,25 @@ public class TesttoolParameters {
                 .help("the maximum time in seconds for executing each PUT request")
                 .dest("time-out");
 
+        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.")
+                .dest("ip");
+
+        parser.addArgument("--thread-pool-size")
+                .type(Integer.class)
+                .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;
     }
 
@@ -241,6 +278,7 @@ public class TesttoolParameters {
         return payloadBuilder.toString();
     }
 
+    @SuppressWarnings("checkstyle:regexpSinglelineJava")
     void validate() {
         if (editContent == null) {
             stream = TesttoolParameters.class.getResourceAsStream(RESOURCE);
@@ -250,8 +288,9 @@ public class TesttoolParameters {
         }
 
         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(controllerDestination.contains(":"),
+                "Controller Destination needs to be in a following format <ip>:<port>");
+            final String[] parts = controllerDestination.split(Pattern.quote(":"));
             Preconditions.checkArgument(Integer.parseInt(parts[1]) > 0, "Port =< 0");
         }
 
@@ -263,6 +302,41 @@ public class TesttoolParameters {
             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");
+
+            final List<File> files = Arrays.asList(schemasDir.listFiles());
+            for (final File file : files) {
+                final Matcher matcher = YANG_FILENAME_PATTERN.matcher(file.getName());
+                if (!matcher.matches()) {
+                    final BufferedReader reader;
+                    try {
+                        reader = new BufferedReader(new FileReader(file));
+                        String line = reader.readLine();
+                        while (!DATE_PATTERN.matcher(line).find()) {
+                            line = reader.readLine();
+                        }
+                        final Matcher m = DATE_PATTERN.matcher(line);
+
+                        if (m.find()) {
+                            String moduleName = file.getAbsolutePath();
+                            if (file.getName().endsWith(".yang")) {
+                                moduleName = moduleName.substring(0, moduleName.length() - 5);
+                            }
+                            final String revision = m.group(1);
+                            final String correctName = moduleName + "@" + revision + ".yang";
+                            final File correctNameFile = new File(correctName);
+                            file.renameTo(correctNameFile);
+                        }
+                    } catch (final IOException e) {
+                        // print error to console (test tool is running from console)
+                        e.printStackTrace();
+                    }
+                }
+            }
+        }
+        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");
         }
     }
 
@@ -270,15 +344,16 @@ public class TesttoolParameters {
         final String editContentString;
         try {
             if (stream == null) {
-                editContentString = Files.toString(editContent, Charsets.UTF_8);
+                editContentString = Files.toString(editContent, StandardCharsets.UTF_8);
             } else {
-                editContentString = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
+                editContentString = CharStreams.toString(new InputStreamReader(stream, StandardCharsets.UTF_8));
             }
         } catch (final IOException e) {
-            throw new IllegalArgumentException("Cannot read content of " + editContent);
+            throw new IllegalArgumentException("Cannot read content of " + editContent, e);
         }
 
-        int from, to;
+        int from;
+        int to;
         Iterator<Integer> iterator;
 
         final ArrayList<ArrayList<Execution.DestToPayload>> allThreadsPayloads = new ArrayList<>();
@@ -289,21 +364,25 @@ public class TesttoolParameters {
             final int leftoverBatchedRequests = (batchedRequests) % threadAmount;
             final int leftoverRequests = openDevices.size() - (batchedRequests * generateConfigBatchSize);
 
-            final StringBuilder destBuilder = new StringBuilder(dest);
-            destBuilder.replace(destBuilder.indexOf(ADDRESS_PORT), destBuilder.indexOf(ADDRESS_PORT) + ADDRESS_PORT.length(), controllerDestination);
+            final StringBuilder destBuilder = new StringBuilder(DEST);
+            destBuilder.replace(destBuilder.indexOf(ADDRESS_PORT),
+                destBuilder.indexOf(ADDRESS_PORT) + ADDRESS_PORT.length(),
+                controllerDestination);
 
             for (int l = 0; l < threadAmount; l++) {
                 from = l * (batchedRequests * batchedRequestsPerThread);
                 to = from + (batchedRequests * batchedRequestsPerThread);
                 iterator = openDevices.subList(from, to).iterator();
-                allThreadsPayloads.add(createBatchedPayloads(batchedRequestsPerThread, iterator, editContentString, destBuilder.toString()));
+                allThreadsPayloads.add(createBatchedPayloads(batchedRequestsPerThread, iterator, editContentString,
+                    destBuilder.toString()));
             }
             ArrayList<Execution.DestToPayload> payloads = null;
             if (leftoverBatchedRequests > 0) {
                 from = threadAmount * (batchedRequests * batchedRequestsPerThread);
                 to = from + (batchedRequests * batchedRequestsPerThread);
                 iterator = openDevices.subList(from, to).iterator();
-                payloads = createBatchedPayloads(leftoverBatchedRequests, iterator, editContentString, destBuilder.toString());
+                payloads = createBatchedPayloads(leftoverBatchedRequests, iterator, editContentString,
+                    destBuilder.toString());
             }
             String payload = "";
 
@@ -311,7 +390,8 @@ public class TesttoolParameters {
                 from = openDevices.size() - leftoverRequests;
                 to = openDevices.size();
                 iterator = openDevices.subList(from, to).iterator();
-                final StringBuilder payloadBuilder = new StringBuilder(prepareMessage(iterator.next(), editContentString));
+                final StringBuilder payloadBuilder = new StringBuilder(
+                    prepareMessage(iterator.next(), editContentString));
                 payload += modifyMessage(payloadBuilder, j, leftoverRequests);
             }
             if (leftoverRequests > 0 || leftoverBatchedRequests > 0) {
@@ -343,44 +423,74 @@ public class TesttoolParameters {
     }
 
     private String prepareMessage(final int openDevice, final String editContentString) {
-        StringBuilder messageBuilder = new StringBuilder(editContentString);
+        final StringBuilder messageBuilder = new StringBuilder(editContentString);
 
         if (editContentString.contains(HOST_KEY)) {
-            messageBuilder.replace(messageBuilder.indexOf(HOST_KEY), messageBuilder.indexOf(HOST_KEY) + HOST_KEY.length(), generateConfigsAddress);
+            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));
+            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));
+        if (editContentString.contains(TCP_ONLY)) {
+            messageBuilder.replace(messageBuilder.indexOf(TCP_ONLY),
+                messageBuilder.indexOf(TCP_ONLY) + TCP_ONLY.length(),
+                Boolean.toString(!ssh));
         }
         return messageBuilder.toString();
     }
 
-    private ArrayList<Execution.DestToPayload> createPayloads(final Iterator<Integer> openDevices, final String editContentString) {
+    private ArrayList<Execution.DestToPayload> createPayloads(final Iterator<Integer> openDevices,
+                                                              final String editContentString) {
         final ArrayList<Execution.DestToPayload> payloads = new ArrayList<>();
 
         while (openDevices.hasNext()) {
-            final StringBuilder destBuilder = new StringBuilder(dest);
-            destBuilder.replace(destBuilder.indexOf(ADDRESS_PORT), destBuilder.indexOf(ADDRESS_PORT) + ADDRESS_PORT.length(), controllerDestination);
-            payloads.add(new Execution.DestToPayload(destBuilder.toString(), prepareMessage(openDevices.next(), editContentString)));
+            final StringBuilder destBuilder = new StringBuilder(DEST);
+            destBuilder.replace(destBuilder.indexOf(ADDRESS_PORT),
+                destBuilder.indexOf(ADDRESS_PORT) + ADDRESS_PORT.length(), controllerDestination);
+            payloads.add(new Execution.DestToPayload(
+                destBuilder.toString(), prepareMessage(openDevices.next(), editContentString)));
         }
         return payloads;
     }
 
-    private ArrayList<Execution.DestToPayload> createBatchedPayloads(final int batchedRequestsCount, final Iterator<Integer> openDevices, final String editContentString,
-                                                                     final String destination) {
+    private ArrayList<Execution.DestToPayload> createBatchedPayloads(final int batchedRequestsCount,
+            final Iterator<Integer> openDevices, final String editContentString, final String destination) {
         final ArrayList<Execution.DestToPayload> payloads = new ArrayList<>();
 
         for (int i = 0; i < batchedRequestsCount; i++) {
             String payload = "";
             for (int j = 0; j < generateConfigBatchSize; j++) {
-                final StringBuilder payloadBuilder = new StringBuilder(prepareMessage(openDevices.next(), editContentString));
+                final StringBuilder payloadBuilder = new StringBuilder(
+                    prepareMessage(openDevices.next(), editContentString));
                 payload += modifyMessage(payloadBuilder, j, generateConfigBatchSize);
             }
             payloads.add(new Execution.DestToPayload(destination, payload));
         }
         return payloads;
     }
+
+    @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();
+    }
+
+    private String getFieldString(final Field field) {
+        try {
+            return field.getName() + "='" + field.get(this) + "'";
+        } catch (final IllegalAccessException e) {
+            return field.getName() + "= UNKNOWN";
+        }
+    }
 }