2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.test.tool.client.stress;
11 import ch.qos.logback.classic.Level;
12 import com.google.common.base.Charsets;
13 import com.google.common.base.Stopwatch;
14 import com.google.common.io.Files;
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.util.ArrayList;
20 import java.util.List;
21 import java.util.concurrent.ExecutionException;
22 import java.util.concurrent.ExecutorService;
23 import java.util.concurrent.Executors;
24 import java.util.concurrent.Future;
25 import java.util.concurrent.TimeUnit;
26 import java.util.concurrent.TimeoutException;
27 import net.sourceforge.argparse4j.inf.ArgumentParser;
28 import net.sourceforge.argparse4j.inf.ArgumentParserException;
29 import org.opendaylight.controller.config.util.xml.XmlUtil;
30 import org.opendaylight.netconf.api.NetconfMessage;
31 import org.opendaylight.netconf.client.NetconfClientDispatcherImpl;
32 import org.opendaylight.netconf.nettyutil.handler.ssh.client.AsyncSshHandler;
33 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
34 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
35 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
36 import org.opendaylight.netconf.test.tool.TestToolUtils;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.CommitInput;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfigInput;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import org.w3c.dom.Document;
43 import org.w3c.dom.Element;
44 import org.w3c.dom.Node;
45 import org.xml.sax.SAXException;
47 public final class StressClient {
49 private static final Logger LOG = LoggerFactory.getLogger(StressClient.class);
51 static final QName COMMIT_QNAME = QName.create(CommitInput.QNAME, "commit");
52 public static final NetconfMessage COMMIT_MSG;
56 COMMIT_MSG = new NetconfMessage(XmlUtil.readXmlToDocument("<rpc message-id=\"commit-batch\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n" +
59 } catch (SAXException | IOException e) {
60 throw new ExceptionInInitializerError(e);
64 static final QName EDIT_QNAME = QName.create(EditConfigInput.QNAME, "edit-config");
65 static final org.w3c.dom.Document editCandidateBlueprint;
66 static final org.w3c.dom.Document editRunningBlueprint;
70 editCandidateBlueprint = XmlUtil.readXmlToDocument(
71 "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n" +
72 " <edit-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n" +
76 " <default-operation>none</default-operation>" +
81 editRunningBlueprint = XmlUtil.readXmlToDocument(
82 "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n" +
83 " <edit-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n" +
87 " <default-operation>none</default-operation>" +
91 } catch (SAXException | IOException e) {
92 throw new ExceptionInInitializerError(e);
96 private static final String MSG_ID_PLACEHOLDER_REGEX = "\\{MSG_ID\\}";
97 private static final String PHYS_ADDR_PLACEHOLDER = "{PHYS_ADDR}";
99 private static long macStart = 0xAABBCCDD0000L;
101 private static Parameters params;
103 public static void main(final String[] args) {
105 params = parseArgs(args, Parameters.getParser());
108 final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
109 root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
111 final int threadAmount = params.threadAmount;
112 LOG.info("thread amount: " + threadAmount);
113 final int requestsPerThread = params.editCount / params.threadAmount;
114 LOG.info("requestsPerThread: " + requestsPerThread);
115 final int leftoverRequests = params.editCount % params.threadAmount;
116 LOG.info("leftoverRequests: " + leftoverRequests);
119 LOG.info("Preparing messages");
120 // Prepare all msgs up front
121 final List<List<NetconfMessage>> allPreparedMessages = new ArrayList<>(threadAmount);
122 for (int i = 0; i < threadAmount; i++) {
123 if (i != threadAmount - 1) {
124 allPreparedMessages.add(new ArrayList<NetconfMessage>(requestsPerThread));
126 allPreparedMessages.add(new ArrayList<NetconfMessage>(requestsPerThread + leftoverRequests));
131 final String editContentString;
133 editContentString = Files.toString(params.editContent, Charsets.UTF_8);
134 } catch (final IOException e) {
135 throw new IllegalArgumentException("Cannot read content of " + params.editContent);
138 for (int i = 0; i < threadAmount; i++) {
139 final List<NetconfMessage> preparedMessages = allPreparedMessages.get(i);
141 if (i == threadAmount - 1) {
142 padding = leftoverRequests;
144 for (int j = 0; j < requestsPerThread + padding; j++) {
145 LOG.debug("id: " + (i * requestsPerThread + j));
146 preparedMessages.add(prepareMessage(i * requestsPerThread + j, editContentString));
150 final NioEventLoopGroup nioGroup = new NioEventLoopGroup();
151 final Timer timer = new HashedWheelTimer();
153 final NetconfClientDispatcherImpl netconfClientDispatcher = configureClientDispatcher(params, nioGroup, timer);
155 final List<StressClientCallable> callables = new ArrayList<>(threadAmount);
156 for (final List<NetconfMessage> messages : allPreparedMessages) {
157 callables.add(new StressClientCallable(params, netconfClientDispatcher, messages));
160 final ExecutorService executorService = Executors.newFixedThreadPool(threadAmount);
162 LOG.info("Starting stress test");
163 final Stopwatch started = Stopwatch.createStarted();
165 final List<Future<Boolean>> futures = executorService.invokeAll(callables);
166 for (final Future<Boolean> future : futures) {
168 future.get(4L, TimeUnit.MINUTES);
169 } catch (ExecutionException | TimeoutException e) {
170 throw new RuntimeException(e);
173 executorService.shutdownNow();
174 } catch (final InterruptedException e) {
175 throw new RuntimeException("Unable to execute requests", e);
179 LOG.info("FINISHED. Execution time: {}", started);
180 LOG.info("Requests per second: {}", (params.editCount * 1000.0 / started.elapsed(TimeUnit.MILLISECONDS)));
185 nioGroup.shutdownGracefully().get(20L, TimeUnit.SECONDS);
186 } catch (InterruptedException | ExecutionException | TimeoutException e) {
187 LOG.warn("Unable to close executor properly", e);
189 //stop the underlying ssh thread that gets spawned if we use ssh
191 AsyncSshHandler.DEFAULT_CLIENT.stop();
195 static NetconfMessage prepareMessage(final int id, final String editContentString) {
196 final Document msg = XmlUtil.createDocumentCopy(params.candidateDatastore ? editCandidateBlueprint : editRunningBlueprint);
197 msg.getDocumentElement().setAttribute("message-id", Integer.toString(id));
198 final NetconfMessage netconfMessage = new NetconfMessage(msg);
200 final Element editContentElement;
202 // Insert message id where needed
203 String specificEditContent = editContentString.replaceAll(MSG_ID_PLACEHOLDER_REGEX, Integer.toString(id));
205 final StringBuilder stringBuilder = new StringBuilder(specificEditContent);
206 int idx = stringBuilder.indexOf(PHYS_ADDR_PLACEHOLDER);
208 stringBuilder.replace(idx, idx + PHYS_ADDR_PLACEHOLDER.length(), TestToolUtils.getMac(macStart++));
209 idx = stringBuilder.indexOf(PHYS_ADDR_PLACEHOLDER);
211 specificEditContent = stringBuilder.toString();
213 editContentElement = XmlUtil.readXmlToElement(specificEditContent);
214 final Node config = ((Element) msg.getDocumentElement().getElementsByTagName("edit-config").item(0)).
215 getElementsByTagName("config").item(0);
216 config.appendChild(msg.importNode(editContentElement, true));
217 } catch (final IOException | SAXException e) {
218 throw new IllegalArgumentException("Edit content file is unreadable", e);
221 return netconfMessage;
224 private static NetconfClientDispatcherImpl configureClientDispatcher(final Parameters params, final NioEventLoopGroup nioGroup, final Timer timer) {
225 final NetconfClientDispatcherImpl netconfClientDispatcher;
227 if(params.legacyFraming) {
228 netconfClientDispatcher= ConfigurableClientDispatcher.createLegacyExi(nioGroup, nioGroup, timer);
230 netconfClientDispatcher = ConfigurableClientDispatcher.createChunkedExi(nioGroup, nioGroup, timer);
233 if(params.legacyFraming) {
234 netconfClientDispatcher = ConfigurableClientDispatcher.createLegacy(nioGroup, nioGroup, timer);
236 netconfClientDispatcher = ConfigurableClientDispatcher.createChunked(nioGroup, nioGroup, timer);
239 return netconfClientDispatcher;
242 private static Parameters parseArgs(final String[] args, final ArgumentParser parser) {
243 final Parameters opt = new Parameters();
245 parser.parseArgs(args, opt);
247 } catch (final ArgumentParserException e) {
248 parser.handleError(e);
256 static class LoggingRemoteDevice implements RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> {
258 public void onRemoteSessionUp(final NetconfSessionPreferences remoteSessionCapabilities, final NetconfDeviceCommunicator netconfDeviceCommunicator) {
259 LOG.info("Session established");
263 public void onRemoteSessionDown() {
264 LOG.info("Session down");
268 public void onRemoteSessionFailed(final Throwable throwable) {
269 LOG.info("Session failed");
273 public void onNotification(final NetconfMessage notification) {
274 LOG.info("Notification received: {}", notification.toString());