netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/client/stress/StressClient.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 ch.qos.logback.classic.Level;
  12 import com.google.common.base.Stopwatch;
  13 import com.google.common.io.Files;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import io.netty.channel.nio.NioEventLoopGroup;
  16 import io.netty.util.HashedWheelTimer;
  17 import io.netty.util.Timer;
  18 import java.io.IOException;
  19 import java.nio.charset.StandardCharsets;
  20 import java.util.ArrayList;
  21 import java.util.List;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.ExecutorService;
  24 import java.util.concurrent.Executors;
  25 import java.util.concurrent.Future;
  26 import java.util.concurrent.TimeUnit;
  27 import java.util.concurrent.TimeoutException;
  28 import net.sourceforge.argparse4j.inf.ArgumentParser;
  29 import net.sourceforge.argparse4j.inf.ArgumentParserException;
  30 import org.opendaylight.netconf.api.NetconfMessage;
  31 import org.opendaylight.netconf.api.xml.XmlUtil;
  32 import org.opendaylight.netconf.client.NetconfClientDispatcherImpl;
  33 import org.opendaylight.netconf.nettyutil.handler.ssh.client.AsyncSshHandler;
  34 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
  35 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  36 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  37 import org.opendaylight.netconf.test.tool.TestToolUtils;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.CommitInput;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfigInput;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43 import org.w3c.dom.Document;
  44 import org.w3c.dom.Element;
  45 import org.w3c.dom.Node;
  46 import org.xml.sax.SAXException;
  47
  48 @SuppressFBWarnings("DM_EXIT")
  49 public final class StressClient {
  50
  51     private static final Logger LOG = LoggerFactory.getLogger(StressClient.class);
  52
  53     static final QName COMMIT_QNAME = QName.create(CommitInput.QNAME, "commit");
  54     public static final NetconfMessage COMMIT_MSG;
  55
  56     static {
  57         try {
  58             COMMIT_MSG = new NetconfMessage(XmlUtil.readXmlToDocument(
  59                 "<rpc message-id=\"commit-batch\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
  60                     + "    <commit/>\n"
  61                     + "</rpc>"));
  62         } catch (final SAXException | IOException e) {
  63             throw new ExceptionInInitializerError(e);
  64         }
  65     }
  66
  67     static final QName EDIT_QNAME = QName.create(EditConfigInput.QNAME, "edit-config");
  68     static final org.w3c.dom.Document EDIT_CANDIDATE_BLUEPRINT;
  69     static final org.w3c.dom.Document EDIT_RUNNING_BLUEPRINT;
  70
  71     static {
  72         try {
  73             EDIT_CANDIDATE_BLUEPRINT = XmlUtil.readXmlToDocument(
  74                     "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
  75                             + "    <edit-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
  76                             + "        <target>\n"
  77                             + "            <candidate/>\n"
  78                             + "        </target>\n"
  79                             + "        <default-operation>none</default-operation>"
  80                             + "        <config/>\n"
  81                             + "    </edit-config>\n"
  82                             + "</rpc>");
  83
  84             EDIT_RUNNING_BLUEPRINT = XmlUtil.readXmlToDocument(
  85                     "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
  86                             + "    <edit-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
  87                             + "        <target>\n"
  88                             + "            <running/>\n"
  89                             + "        </target>\n"
  90                             + "        <default-operation>none</default-operation>"
  91                             + "        <config/>\n"
  92                             + "    </edit-config>\n"
  93                             + "</rpc>");
  94         } catch (SAXException | IOException e) {
  95             throw new ExceptionInInitializerError(e);
  96         }
  97     }
  98
  99     private static final String MSG_ID_PLACEHOLDER_REGEX = "\\{MSG_ID\\}";
 100     private static final String PHYS_ADDR_PLACEHOLDER = "{PHYS_ADDR}";
 101
 102     private static long macStart = 0xAABBCCDD0000L;
 103
 104     private static Parameters params;
 105
 106     private StressClient() {
 107
 108     }
 109
 110     public static void main(final String[] args) {
 111
 112         params = parseArgs(args, Parameters.getParser());
 113         params.validate();
 114
 115         final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory
 116             .getLogger(Logger.ROOT_LOGGER_NAME);
 117         root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
 118
 119         final int threadAmount = params.threadAmount;
 120         LOG.info("thread amount: {}", threadAmount);
 121         final int requestsPerThread = params.editCount / params.threadAmount;
 122         LOG.info("requestsPerThread: {}", requestsPerThread);
 123         final int leftoverRequests = params.editCount % params.threadAmount;
 124         LOG.info("leftoverRequests: {}", leftoverRequests);
 125
 126         LOG.info("Preparing messages");
 127         // Prepare all msgs up front
 128         final List<List<NetconfMessage>> allPreparedMessages = new ArrayList<>(threadAmount);
 129         for (int i = 0; i < threadAmount; i++) {
 130             if (i != threadAmount - 1) {
 131                 allPreparedMessages.add(new ArrayList<>(requestsPerThread));
 132             } else {
 133                 allPreparedMessages.add(new ArrayList<>(requestsPerThread + leftoverRequests));
 134             }
 135         }
 136
 137
 138         final String editContentString;
 139         try {
 140             editContentString = Files.asCharSource(params.editContent, StandardCharsets.UTF_8).read();
 141         } catch (final IOException e) {
 142             throw new IllegalArgumentException("Cannot read content of " + params.editContent, e);
 143         }
 144
 145         for (int i = 0; i < threadAmount; i++) {
 146             final List<NetconfMessage> preparedMessages = allPreparedMessages.get(i);
 147             int padding = 0;
 148             if (i == threadAmount - 1) {
 149                 padding = leftoverRequests;
 150             }
 151             for (int j = 0; j < requestsPerThread + padding; j++) {
 152                 LOG.debug("id: {}", i * requestsPerThread + j);
 153                 preparedMessages.add(prepareMessage(i * requestsPerThread + j, editContentString));
 154             }
 155         }
 156
 157         final NioEventLoopGroup nioGroup = new NioEventLoopGroup();
 158         final Timer timer = new HashedWheelTimer();
 159
 160         final NetconfClientDispatcherImpl netconfClientDispatcher = configureClientDispatcher(nioGroup, timer);
 161
 162         final List<StressClientCallable> callables = new ArrayList<>(threadAmount);
 163         for (final List<NetconfMessage> messages : allPreparedMessages) {
 164             callables.add(new StressClientCallable(params, netconfClientDispatcher, messages));
 165         }
 166
 167         final ExecutorService executorService = Executors.newFixedThreadPool(threadAmount);
 168
 169         LOG.info("Starting stress test");
 170         final Stopwatch started = Stopwatch.createStarted();
 171         try {
 172             final List<Future<Boolean>> futures = executorService.invokeAll(callables);
 173             for (final Future<Boolean> future : futures) {
 174                 try {
 175                     future.get(4L, TimeUnit.MINUTES);
 176                 } catch (ExecutionException | TimeoutException e) {
 177                     throw new IllegalStateException(e);
 178                 }
 179             }
 180             executorService.shutdownNow();
 181         } catch (final InterruptedException e) {
 182             throw new IllegalStateException("Unable to execute requests", e);
 183         }
 184         started.stop();
 185
 186         LOG.info("FINISHED. Execution time: {}", started);
 187         LOG.info("Requests per second: {}", params.editCount * 1000.0 / started.elapsed(TimeUnit.MILLISECONDS));
 188
 189         // Cleanup
 190         timer.stop();
 191         try {
 192             nioGroup.shutdownGracefully().get(20L, TimeUnit.SECONDS);
 193         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 194             LOG.warn("Unable to close executor properly", e);
 195         }
 196         //stop the underlying ssh thread that gets spawned if we use ssh
 197         if (params.ssh) {
 198             AsyncSshHandler.DEFAULT_CLIENT.stop();
 199         }
 200     }
 201
 202     static NetconfMessage prepareMessage(final int id, final String editContentString) {
 203         final Document msg = XmlUtil.createDocumentCopy(
 204             params.candidateDatastore ? EDIT_CANDIDATE_BLUEPRINT : EDIT_RUNNING_BLUEPRINT);
 205         msg.getDocumentElement().setAttribute("message-id", Integer.toString(id));
 206         final NetconfMessage netconfMessage = new NetconfMessage(msg);
 207
 208         final Element editContentElement;
 209         try {
 210             // Insert message id where needed
 211             String specificEditContent = editContentString.replaceAll(MSG_ID_PLACEHOLDER_REGEX, Integer.toString(id));
 212
 213             final StringBuilder stringBuilder = new StringBuilder(specificEditContent);
 214             int idx = stringBuilder.indexOf(PHYS_ADDR_PLACEHOLDER);
 215             while (idx != -1) {
 216                 stringBuilder.replace(idx, idx + PHYS_ADDR_PLACEHOLDER.length(), TestToolUtils.getMac(macStart++));
 217                 idx = stringBuilder.indexOf(PHYS_ADDR_PLACEHOLDER);
 218             }
 219             specificEditContent = stringBuilder.toString();
 220
 221             editContentElement = XmlUtil.readXmlToElement(specificEditContent);
 222             final Node config = ((Element) msg.getDocumentElement().getElementsByTagName("edit-config").item(0))
 223                     .getElementsByTagName("config").item(0);
 224             config.appendChild(msg.importNode(editContentElement, true));
 225         } catch (final IOException | SAXException e) {
 226             throw new IllegalArgumentException("Edit content file is unreadable", e);
 227         }
 228
 229         return netconfMessage;
 230     }
 231
 232     private static NetconfClientDispatcherImpl configureClientDispatcher(final NioEventLoopGroup nioGroup,
 233             final Timer timer) {
 234         final NetconfClientDispatcherImpl netconfClientDispatcher;
 235         if (params.exi) {
 236             if (params.legacyFraming) {
 237                 netconfClientDispatcher = ConfigurableClientDispatcher.createLegacyExi(nioGroup, nioGroup, timer);
 238             } else {
 239                 netconfClientDispatcher = ConfigurableClientDispatcher.createChunkedExi(nioGroup, nioGroup, timer);
 240             }
 241         } else if (params.legacyFraming) {
 242             netconfClientDispatcher = ConfigurableClientDispatcher.createLegacy(nioGroup, nioGroup, timer);
 243         } else {
 244             netconfClientDispatcher = ConfigurableClientDispatcher.createChunked(nioGroup, nioGroup, timer);
 245         }
 246         return netconfClientDispatcher;
 247     }
 248
 249     private static Parameters parseArgs(final String[] args, final ArgumentParser parser) {
 250         final Parameters opt = new Parameters();
 251         try {
 252             parser.parseArgs(args, opt);
 253             return opt;
 254         } catch (final ArgumentParserException e) {
 255             parser.handleError(e);
 256         }
 257
 258         System.exit(1);
 259         return null;
 260     }
 261
 262     static class LoggingRemoteDevice
 263             implements RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> {
 264         @Override
 265         public void onRemoteSessionUp(final NetconfSessionPreferences remoteSessionCapabilities,
 266                                       final NetconfDeviceCommunicator netconfDeviceCommunicator) {
 267             LOG.info("Session established");
 268         }
 269
 270         @Override
 271         public void onRemoteSessionDown() {
 272             LOG.info("Session down");
 273         }
 274
 275         @Override
 276         public void onRemoteSessionFailed(final Throwable throwable) {
 277             LOG.info("Session failed");
 278         }
 279
 280         @Override
 281         public void onNotification(final NetconfMessage notification) {
 282             LOG.info("Notification received: {}", notification.toString());
 283         }
 284     }
 285
 286 }