netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/client/stress/Parameters.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netconf.test.tool.client.stress;
  10
  11 import com.google.common.base.Preconditions;
  12 import java.io.File;
  13 import java.net.InetAddress;
  14 import java.net.InetSocketAddress;
  15 import java.net.UnknownHostException;
  16 import net.sourceforge.argparse4j.ArgumentParsers;
  17 import net.sourceforge.argparse4j.annotation.Arg;
  18 import net.sourceforge.argparse4j.inf.ArgumentParser;
  19
  20 public class Parameters {
  21
  22     @Arg(dest = "ip")
  23     public String ip;
  24
  25     @Arg(dest = "port")
  26     public int port;
  27
  28     @Arg(dest = "edit-count")
  29     public int editCount;
  30
  31     @Arg(dest = "edit-content")
  32     public File editContent;
  33
  34     @Arg(dest = "edit-batch-size")
  35     public int editBatchSize;
  36
  37     @Arg(dest = "candidate-datastore")
  38     public boolean candidateDatastore;
  39
  40     @Arg(dest = "debug")
  41     public boolean debug;
  42
  43     @Arg(dest = "legacy-framing")
  44     public boolean legacyFraming;
  45
  46     @Arg(dest = "exi")
  47     public boolean exi;
  48
  49     @Arg(dest = "async")
  50     public boolean async;
  51
  52     @Arg(dest = "ssh")
  53     public boolean ssh;
  54
  55     @Arg(dest = "username")
  56     public String username;
  57
  58     @Arg(dest = "password")
  59     public String password;
  60
  61     @Arg(dest = "msg-timeout")
  62     public long msgTimeout;
  63
  64     @Arg(dest = "tcp-header")
  65     public String tcpHeader;
  66
  67     @Arg(dest = "thread-amount")
  68     public int threadAmount;
  69
  70     @Arg(dest = "concurrent-message-limit")
  71     public int concurrentMessageLimit;
  72
  73     static ArgumentParser getParser() {
  74         final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf stress client");
  75
  76         parser.description("Netconf stress client");
  77
  78         parser.addArgument("--ip")
  79                 .type(String.class)
  80                 .setDefault("127.0.0.1")
  81                 .type(String.class)
  82                 .help("Netconf server IP")
  83                 .dest("ip");
  84
  85         parser.addArgument("--port")
  86                 .type(Integer.class)
  87                 .setDefault(2830)
  88                 .type(Integer.class)
  89                 .help("Netconf server port")
  90                 .dest("port");
  91
  92         parser.addArgument("--edits")
  93                 .type(Integer.class)
  94                 .setDefault(50000)
  95                 .type(Integer.class)
  96                 .help("Netconf edit rpcs to be sent")
  97                 .dest("edit-count");
  98
  99         parser.addArgument("--edit-content")
 100                 .type(File.class)
 101                 .setDefault(new File("edit.txt"))
 102                 .type(File.class)
 103                 .dest("edit-content");
 104
 105         parser.addArgument("--edit-batch-size")
 106                 .type(Integer.class)
 107                 .required(false)
 108                 .setDefault(-1)
 109                 .dest("edit-batch-size");
 110
 111         parser.addArgument("--candidate-datastore")
 112                 .type(Boolean.class)
 113                 .required(false)
 114                 .setDefault(true)
 115                 .help("Edit candidate or running datastore. Defaults to candidate.")
 116                 .dest("candidate-datastore");
 117
 118         parser.addArgument("--debug")
 119                 .type(Boolean.class)
 120                 .setDefault(false)
 121                 .help("Whether to use debug log level instead of INFO")
 122                 .dest("debug");
 123
 124         parser.addArgument("--legacy-framing")
 125                 .type(Boolean.class)
 126                 .setDefault(false)
 127                 .dest("legacy-framing");
 128
 129         parser.addArgument("--exi")
 130                 .type(Boolean.class)
 131                 .setDefault(false)
 132                 .dest("exi");
 133
 134         parser.addArgument("--async-requests")
 135                 .type(Boolean.class)
 136                 .setDefault(true)
 137                 .dest("async");
 138
 139         parser.addArgument("--msg-timeout")
 140                 .type(Integer.class)
 141                 .setDefault(60)
 142                 .dest("msg-timeout");
 143
 144         parser.addArgument("--ssh")
 145                 .type(Boolean.class)
 146                 .setDefault(false)
 147                 .dest("ssh");
 148
 149         parser.addArgument("--username")
 150                 .type(String.class)
 151                 .setDefault("admin")
 152                 .dest("username");
 153
 154         parser.addArgument("--password")
 155                 .type(String.class)
 156                 .setDefault("admin")
 157                 .dest("password");
 158
 159         parser.addArgument("--tcp-header")
 160                 .type(String.class)
 161                 .required(false)
 162                 .dest("tcp-header");
 163
 164         parser.addArgument("--thread-amount")
 165                 .type(Integer.class)
 166                 .setDefault(1)
 167                 .dest("thread-amount");
 168
 169         parser.addArgument("--concurrent-message-limit")
 170                 .type(Integer.class)
 171                 .setDefault(0)
 172                 .help("Number of rpc messages that can be sent before receiving reply to them.")
 173                 .dest("concurrent-message-limit");
 174
 175         return parser;
 176     }
 177
 178     void validate() {
 179         Preconditions.checkArgument(port > 0, "Port =< 0");
 180         Preconditions.checkArgument(editCount > 0, "Edit count =< 0");
 181         if (editBatchSize == -1) {
 182             editBatchSize = editCount;
 183         } else {
 184             Preconditions.checkArgument(editBatchSize <= editCount, "Edit count =< 0");
 185         }
 186
 187         Preconditions.checkArgument(editContent.exists(), "Edit content file missing");
 188         Preconditions.checkArgument(!editContent.isDirectory(), "Edit content file is a dir");
 189         Preconditions.checkArgument(editContent.canRead(), "Edit content file is unreadable");
 190         Preconditions.checkArgument(threadAmount > 0, "Parameter thread-amount must be greater than 0");
 191         Preconditions.checkArgument(msgTimeout >= 0, "Parameter msg-timeout must be greater than 0");
 192     }
 193
 194     public InetSocketAddress getInetAddress() {
 195         try {
 196             return new InetSocketAddress(InetAddress.getByName(ip), port);
 197         } catch (final UnknownHostException e) {
 198             throw new IllegalArgumentException("Unknown ip", e);
 199         }
 200     }
 201 }