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 package org.opendaylight.netconf.test.tool.client.stress;
   9
  10 import ch.qos.logback.classic.Level;
  11 import com.google.common.base.Stopwatch;
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.io.IOException;
  14 import java.nio.file.Files;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.Set;
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.concurrent.Executors;
  20 import java.util.concurrent.TimeUnit;
  21 import java.util.concurrent.TimeoutException;
  22 import net.sourceforge.argparse4j.inf.ArgumentParserException;
  23 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  24 import org.opendaylight.netconf.api.messages.NetconfMessage;
  25 import org.opendaylight.netconf.api.xml.XmlUtil;
  26 import org.opendaylight.netconf.client.NetconfClientFactoryImpl;
  27 import org.opendaylight.netconf.client.NetconfClientSessionNegotiatorFactory;
  28 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  29 import org.opendaylight.netconf.client.conf.NetconfClientConfigurationBuilder;
  30 import org.opendaylight.netconf.client.mdsal.NetconfDeviceCommunicator;
  31 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
  32 import org.opendaylight.netconf.client.mdsal.api.RemoteDevice;
  33 import org.opendaylight.netconf.test.tool.TestToolUtils;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.CommitInput;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfigInput;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.crypto.types.rev231228.password.grouping.password.type.CleartextPasswordBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.client.rev231228.netconf.client.initiate.stack.grouping.transport.ssh.ssh.SshClientParametersBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.client.rev231228.netconf.client.initiate.stack.grouping.transport.ssh.ssh.TcpClientParametersBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev231228.ssh.client.grouping.ClientIdentityBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev231228.ssh.client.grouping.client.identity.PasswordBuilder;
  45 import org.opendaylight.yangtools.yang.common.QName;
  46 import org.opendaylight.yangtools.yang.common.Uint16;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49 import org.w3c.dom.Document;
  50 import org.w3c.dom.Element;
  51 import org.xml.sax.SAXException;
  52
  53 public final class StressClient {
  54     private static final Logger LOG = LoggerFactory.getLogger(StressClient.class);
  55
  56     static final RemoteDevice<NetconfDeviceCommunicator> LOGGING_REMOTE_DEVICE = new RemoteDevice<>() {
  57         @Override
  58         public void onRemoteSessionUp(final NetconfSessionPreferences remoteSessionCapabilities,
  59                 final NetconfDeviceCommunicator netconfDeviceCommunicator) {
  60             LOG.info("Session established");
  61         }
  62
  63         @Override
  64         public void onRemoteSessionDown() {
  65             LOG.info("Session down");
  66         }
  67
  68         @Override
  69         public void onNotification(final NetconfMessage notification) {
  70             LOG.info("Notification received: {}", notification);
  71         }
  72     };
  73
  74     static final QName COMMIT_QNAME = QName.create(CommitInput.QNAME, "commit");
  75     public static final NetconfMessage COMMIT_MSG = new NetconfMessage(readString("""
  76         <rpc message-id="commit-batch" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  77             <commit/>
  78         </rpc>"""));
  79
  80     static final QName EDIT_QNAME = QName.create(EditConfigInput.QNAME, "edit-config");
  81     static final Document EDIT_CANDIDATE_BLUEPRINT = readString("""
  82         <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  83             <edit-config>
  84                 <target>
  85                     <candidate/>
  86                 </target>
  87                 <default-operation>none</default-operation>
  88                 <config/>
  89             </edit-config>
  90         </rpc>""");
  91     static final Document EDIT_RUNNING_BLUEPRINT  = readString("""
  92         <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  93             <edit-config>
  94                 <target>
  95                     <running/>
  96                 </target>
  97                 <default-operation>none</default-operation>
  98                 <config/>
  99             </edit-config>
 100         </rpc>""");
 101
 102     private static Document readString(final String str) {
 103         try {
 104             return XmlUtil.readXmlToDocument(str);
 105         } catch (SAXException | IOException e) {
 106             throw new ExceptionInInitializerError(e);
 107         }
 108     }
 109
 110     private static final String MSG_ID_PLACEHOLDER_REGEX = "\\{MSG_ID\\}";
 111     private static final String PHYS_ADDR_PLACEHOLDER = "{PHYS_ADDR}";
 112
 113     private static long macStart = 0xAABBCCDD0000L;
 114
 115     private static Parameters params;
 116
 117     private StressClient() {
 118         // Hidden on purpose
 119     }
 120
 121     public static void main(final String[] args) throws ExecutionException, InterruptedException, TimeoutException {
 122         if (initParameters(args)) {
 123             return;
 124         }
 125         params.validate();
 126
 127         final var root = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
 128         root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
 129
 130         final int threadAmount = params.threadAmount;
 131         LOG.info("thread amount: {}", threadAmount);
 132         final int requestsPerThread = params.editCount / params.threadAmount;
 133         LOG.info("requestsPerThread: {}", requestsPerThread);
 134         final int leftoverRequests = params.editCount % params.threadAmount;
 135         LOG.info("leftoverRequests: {}", leftoverRequests);
 136
 137         LOG.info("Preparing messages");
 138         // Prepare all msgs up front
 139         final var allPreparedMessages = new ArrayList<List<NetconfMessage>>(threadAmount);
 140         for (int i = 0; i < threadAmount; i++) {
 141             if (i != threadAmount - 1) {
 142                 allPreparedMessages.add(new ArrayList<>(requestsPerThread));
 143             } else {
 144                 allPreparedMessages.add(new ArrayList<>(requestsPerThread + leftoverRequests));
 145             }
 146         }
 147
 148
 149         final String editContentString;
 150         try {
 151             editContentString = Files.readString(params.editContent.toPath());
 152         } catch (final IOException e) {
 153             throw new IllegalArgumentException("Cannot read content of " + params.editContent, e);
 154         }
 155
 156         for (int i = 0; i < threadAmount; i++) {
 157             final var preparedMessages = allPreparedMessages.get(i);
 158             int padding = 0;
 159             if (i == threadAmount - 1) {
 160                 padding = leftoverRequests;
 161             }
 162             for (int j = 0; j < requestsPerThread + padding; j++) {
 163                 LOG.debug("id: {}", i * requestsPerThread + j);
 164                 preparedMessages.add(prepareMessage(i * requestsPerThread + j, editContentString));
 165             }
 166         }
 167
 168         final var netconfClientFactory = new NetconfClientFactoryImpl();
 169
 170         final var callables = new ArrayList<StressClientCallable>(threadAmount);
 171         for (var messages : allPreparedMessages) {
 172             callables.add(new StressClientCallable(params, netconfClientFactory, getBaseConfiguration(), messages));
 173         }
 174
 175         final var executorService = Executors.newFixedThreadPool(threadAmount);
 176
 177         LOG.info("Starting stress test");
 178         final var sw = Stopwatch.createStarted();
 179         final var futures = executorService.invokeAll(callables);
 180         for (var future : futures) {
 181             future.get(4L, TimeUnit.MINUTES);
 182         }
 183         executorService.shutdownNow();
 184         sw.stop();
 185
 186         LOG.info("FINISHED. Execution time: {}", sw);
 187         LOG.info("Requests per second: {}", params.editCount * 1000.0 / sw.elapsed(TimeUnit.MILLISECONDS));
 188
 189         // Cleanup
 190         netconfClientFactory.close();
 191     }
 192
 193     static NetconfMessage prepareMessage(final int id, final String editContentString) {
 194         final Document msg = XmlUtil.createDocumentCopy(
 195             params.candidateDatastore ? EDIT_CANDIDATE_BLUEPRINT : EDIT_RUNNING_BLUEPRINT);
 196         msg.getDocumentElement().setAttribute("message-id", Integer.toString(id));
 197         final NetconfMessage netconfMessage = new NetconfMessage(msg);
 198
 199         final Element editContentElement;
 200         try {
 201             // Insert message id where needed
 202             String specificEditContent = editContentString.replaceAll(MSG_ID_PLACEHOLDER_REGEX, Integer.toString(id));
 203
 204             final var sb = new StringBuilder(specificEditContent);
 205             int idx = sb.indexOf(PHYS_ADDR_PLACEHOLDER);
 206             while (idx != -1) {
 207                 sb.replace(idx, idx + PHYS_ADDR_PLACEHOLDER.length(), TestToolUtils.getMac(macStart++));
 208                 idx = sb.indexOf(PHYS_ADDR_PLACEHOLDER);
 209             }
 210             specificEditContent = sb.toString();
 211
 212             editContentElement = XmlUtil.readXmlToElement(specificEditContent);
 213             final var config = ((Element) msg.getDocumentElement().getElementsByTagName("edit-config").item(0))
 214                     .getElementsByTagName("config").item(0);
 215             config.appendChild(msg.importNode(editContentElement, true));
 216         } catch (final IOException | SAXException e) {
 217             throw new IllegalArgumentException("Edit content file is unreadable", e);
 218         }
 219
 220         return netconfMessage;
 221     }
 222
 223     @SuppressFBWarnings(value = "DM_EXIT", justification = "Exit from CLI with error without throwing an exception")
 224     private static boolean initParameters(final String[] args) {
 225         final var parser = Parameters.getParser();
 226         params = new Parameters();
 227         try {
 228             parser.parseArgs(args, args);
 229         } catch (ArgumentParserException e) {
 230             parser.handleError(e);
 231             System.exit(1);
 232             return true;
 233         }
 234         return false;
 235     }
 236
 237     private static NetconfClientConfiguration getBaseConfiguration() {
 238         final var confBuilder = NetconfClientConfigurationBuilder.create()
 239             .withProtocol(params.ssh ? NetconfClientConfiguration.NetconfClientProtocol.SSH
 240                 : NetconfClientConfiguration.NetconfClientProtocol.TCP)
 241             .withConnectionTimeoutMillis(20000L)
 242             .withOdlHelloCapabilities(getCapabilities().stream().map(Uri::new).toList())
 243             .withTcpParameters(new TcpClientParametersBuilder()
 244                 .setRemoteAddress(new Host(IetfInetUtil.ipAddressFor(params.ip)))
 245                 .setRemotePort(new PortNumber(Uint16.valueOf(params.port))).build());
 246         if (params.ssh) {
 247             confBuilder.withSshParameters(new SshClientParametersBuilder()
 248                 .setClientIdentity(new ClientIdentityBuilder()
 249                     .setUsername(params.username)
 250                     .setPassword(new PasswordBuilder()
 251                         .setPasswordType(
 252                             new CleartextPasswordBuilder().setCleartextPassword(params.password).build())
 253                         .build())
 254                     .build())
 255                 .build());
 256         }
 257         if (params.tcpHeader != null) {
 258             final String header = params.tcpHeader.replace("\"", "").trim() + "\n";
 259             confBuilder.withAdditionalHeader(
 260                 new NetconfHelloMessageAdditionalHeader(null, null, null, null, null) {
 261                     @Override
 262                     public String toFormattedString() {
 263                         LOG.debug("Sending TCP header {}", header);
 264                         return header;
 265                     }
 266                 });
 267         }
 268         return confBuilder.build();
 269     }
 270
 271     private static Set<String> getCapabilities() {
 272         if (params.exi) {
 273             return params.legacyFraming
 274                 // EXI + ]]gt;]]gt; framing.
 275                 ? NetconfClientSessionNegotiatorFactory.LEGACY_EXI_CLIENT_CAPABILITIES
 276                 // EXI + chunked framing
 277                 : NetconfClientSessionNegotiatorFactory.EXI_CLIENT_CAPABILITIES;
 278         }
 279         return params.legacyFraming
 280             // ]]gt;]]gt; framing.
 281             ? NetconfClientSessionNegotiatorFactory.LEGACY_FRAMING_CLIENT_CAPABILITIES
 282             // Chunked framing
 283             : NetconfClientSessionNegotiatorFactory.DEFAULT_CLIENT_CAPABILITIES;
 284     }
 285 }