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 package org.opendaylight.netconf.test.tool.client.stress;
   9
  10 import com.google.common.base.Preconditions;
  11 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  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     @SuppressFBWarnings("PA_PUBLIC_PRIMITIVE_ATTRIBUTE")
  36     public int editBatchSize;
  37
  38     @Arg(dest = "candidate-datastore")
  39     public boolean candidateDatastore;
  40
  41     @Arg(dest = "debug")
  42     public boolean debug;
  43
  44     @Arg(dest = "legacy-framing")
  45     public boolean legacyFraming;
  46
  47     @Arg(dest = "exi")
  48     public boolean exi;
  49
  50     @Arg(dest = "async")
  51     public boolean async;
  52
  53     @Arg(dest = "ssh")
  54     public boolean ssh;
  55
  56     @Arg(dest = "username")
  57     public String username;
  58
  59     @Arg(dest = "password")
  60     public String password;
  61
  62     @Arg(dest = "msg-timeout")
  63     public long msgTimeout;
  64
  65     @Arg(dest = "tcp-header")
  66     public String tcpHeader;
  67
  68     @Arg(dest = "thread-amount")
  69     public int threadAmount;
  70
  71     @Arg(dest = "concurrent-message-limit")
  72     public int concurrentMessageLimit;
  73
  74     static ArgumentParser getParser() {
  75         final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf stress client");
  76
  77         parser.description("Netconf stress client");
  78
  79         parser.addArgument("--ip")
  80                 .type(String.class)
  81                 .setDefault("127.0.0.1")
  82                 .type(String.class)
  83                 .help("Netconf server IP")
  84                 .dest("ip");
  85
  86         parser.addArgument("--port")
  87                 .type(Integer.class)
  88                 .setDefault(2830)
  89                 .type(Integer.class)
  90                 .help("Netconf server port")
  91                 .dest("port");
  92
  93         parser.addArgument("--edits")
  94                 .type(Integer.class)
  95                 .setDefault(50000)
  96                 .type(Integer.class)
  97                 .help("Netconf edit rpcs to be sent")
  98                 .dest("edit-count");
  99
 100         parser.addArgument("--edit-content")
 101                 .type(File.class)
 102                 .setDefault(new File("edit.txt"))
 103                 .type(File.class)
 104                 .dest("edit-content");
 105
 106         parser.addArgument("--edit-batch-size")
 107                 .type(Integer.class)
 108                 .required(false)
 109                 .setDefault(-1)
 110                 .dest("edit-batch-size");
 111
 112         parser.addArgument("--candidate-datastore")
 113                 .type(Boolean.class)
 114                 .required(false)
 115                 .setDefault(Boolean.TRUE)
 116                 .help("Edit candidate or running datastore. Defaults to candidate.")
 117                 .dest("candidate-datastore");
 118
 119         parser.addArgument("--debug")
 120                 .type(Boolean.class)
 121                 .setDefault(Boolean.FALSE)
 122                 .help("Whether to use debug log level instead of INFO")
 123                 .dest("debug");
 124
 125         parser.addArgument("--legacy-framing")
 126                 .type(Boolean.class)
 127                 .setDefault(Boolean.FALSE)
 128                 .dest("legacy-framing");
 129
 130         parser.addArgument("--exi")
 131                 .type(Boolean.class)
 132                 .setDefault(Boolean.FALSE)
 133                 .dest("exi");
 134
 135         parser.addArgument("--async-requests")
 136                 .type(Boolean.class)
 137                 .setDefault(Boolean.TRUE)
 138                 .dest("async");
 139
 140         parser.addArgument("--msg-timeout")
 141                 .type(Integer.class)
 142                 .setDefault(60)
 143                 .dest("msg-timeout");
 144
 145         parser.addArgument("--ssh")
 146                 .type(Boolean.class)
 147                 .setDefault(Boolean.FALSE)
 148                 .dest("ssh");
 149
 150         parser.addArgument("--username")
 151                 .type(String.class)
 152                 .setDefault("admin")
 153                 .dest("username");
 154
 155         parser.addArgument("--password")
 156                 .type(String.class)
 157                 .setDefault("admin")
 158                 .dest("password");
 159
 160         parser.addArgument("--tcp-header")
 161                 .type(String.class)
 162                 .required(false)
 163                 .dest("tcp-header");
 164
 165         parser.addArgument("--thread-amount")
 166                 .type(Integer.class)
 167                 .setDefault(1)
 168                 .dest("thread-amount");
 169
 170         parser.addArgument("--concurrent-message-limit")
 171                 .type(Integer.class)
 172                 .setDefault(0)
 173                 .help("Number of rpc messages that can be sent before receiving reply to them.")
 174                 .dest("concurrent-message-limit");
 175
 176         return parser;
 177     }
 178
 179     void validate() {
 180         Preconditions.checkArgument(port > 0, "Port =< 0");
 181         Preconditions.checkArgument(editCount > 0, "Edit count =< 0");
 182         if (editBatchSize == -1) {
 183             editBatchSize = editCount;
 184         } else {
 185             Preconditions.checkArgument(editBatchSize <= editCount, "Edit count =< 0");
 186         }
 187
 188         Preconditions.checkArgument(editContent.exists(), "Edit content file missing");
 189         Preconditions.checkArgument(!editContent.isDirectory(), "Edit content file is a dir");
 190         Preconditions.checkArgument(editContent.canRead(), "Edit content file is unreadable");
 191         Preconditions.checkArgument(threadAmount > 0, "Parameter thread-amount must be greater than 0");
 192         Preconditions.checkArgument(msgTimeout >= 0, "Parameter msg-timeout must be greater than 0");
 193     }
 194
 195     public InetSocketAddress getInetAddress() {
 196         try {
 197             return new InetSocketAddress(InetAddress.getByName(ip), port);
 198         } catch (final UnknownHostException e) {
 199             throw new IllegalArgumentException("Unknown ip", e);
 200         }
 201     }
 202 }