2 * Copyright (c) 2014 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.controller.netconf.test.tool;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static com.google.common.base.Preconditions.checkNotNull;
14 import ch.qos.logback.classic.Level;
15 import com.google.common.base.Charsets;
16 import com.google.common.base.Preconditions;
17 import com.google.common.collect.Lists;
18 import com.google.common.io.ByteStreams;
19 import com.google.common.io.CharStreams;
20 import com.google.common.io.Files;
22 import java.io.FileFilter;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import java.io.InputStreamReader;
26 import java.util.Collections;
27 import java.util.Comparator;
28 import java.util.List;
29 import java.util.concurrent.TimeUnit;
30 import net.sourceforge.argparse4j.ArgumentParsers;
31 import net.sourceforge.argparse4j.annotation.Arg;
32 import net.sourceforge.argparse4j.inf.ArgumentParser;
33 import net.sourceforge.argparse4j.inf.ArgumentParserException;
34 import org.opendaylight.controller.netconf.util.xml.XmlElement;
35 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38 import org.w3c.dom.Document;
39 import org.w3c.dom.Element;
40 import org.w3c.dom.Node;
41 import org.w3c.dom.NodeList;
42 import org.xml.sax.SAXException;
44 public final class Main {
46 private static final Logger LOG = LoggerFactory.getLogger(Main.class);
48 public static class Params {
50 @Arg(dest = "schemas-dir")
51 public File schemasDir;
53 @Arg(dest = "devices-count")
54 public int deviceCount;
56 @Arg(dest = "starting-port")
57 public int startingPort;
59 @Arg(dest = "generate-config-connection-timeout")
60 public int generateConfigsTimeout;
62 @Arg(dest = "generate-config-address")
63 public String generateConfigsAddress;
65 @Arg(dest = "distro-folder")
66 public File distroFolder;
68 @Arg(dest = "generate-configs-batch-size")
69 public int generateConfigBatchSize;
80 @Arg(dest = "notification-file")
81 public File notificationFile;
83 static ArgumentParser getParser() {
84 final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf testool");
86 parser.description("Netconf device simulator. Detailed info can be found at https://wiki.opendaylight.org/view/OpenDaylight_Controller:Netconf:Testtool#Building_testtool");
88 parser.addArgument("--device-count")
92 .help("Number of simulated netconf devices to spin")
93 .dest("devices-count");
95 parser.addArgument("--schemas-dir")
97 .help("Directory containing yang schemas to describe simulated devices. Some schemas e.g. netconf monitoring and inet types are included by default")
100 parser.addArgument("--notification-file")
102 .help("Xml file containing notifications that should be sent to clients after create subscription is called")
103 .dest("notification-file");
105 parser.addArgument("--starting-port")
108 .help("First port for simulated device. Each other device will have previous+1 port number")
109 .dest("starting-port");
111 parser.addArgument("--generate-config-connection-timeout")
113 .setDefault((int)TimeUnit.MINUTES.toMillis(30))
114 .help("Timeout to be generated in initial config files")
115 .dest("generate-config-connection-timeout");
117 parser.addArgument("--generate-config-address")
119 .setDefault("127.0.0.1")
120 .help("Address to be placed in generated configs")
121 .dest("generate-config-address");
123 parser.addArgument("--generate-configs-batch-size")
126 .help("Number of connector configs per generated file")
127 .dest("generate-configs-batch-size");
129 parser.addArgument("--distribution-folder")
131 .help("Directory where the karaf distribution for controller is located")
132 .dest("distro-folder");
134 parser.addArgument("--ssh")
137 .help("Whether to use ssh for transport or just pure tcp")
140 parser.addArgument("--exi")
143 .help("Whether to use exi to transport xml content")
146 parser.addArgument("--debug")
149 .help("Whether to use debug log level instead of INFO")
156 checkArgument(deviceCount > 0, "Device count has to be > 0");
157 checkArgument(startingPort > 1023, "Starting port has to be > 1023");
159 if(schemasDir != null) {
160 checkArgument(schemasDir.exists(), "Schemas dir has to exist");
161 checkArgument(schemasDir.isDirectory(), "Schemas dir has to be a directory");
162 checkArgument(schemasDir.canRead(), "Schemas dir has to be readable");
167 public static void main(final String[] args) {
168 final Params params = parseArgs(args, Params.getParser());
171 final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
172 root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
174 final NetconfDeviceSimulator netconfDeviceSimulator = new NetconfDeviceSimulator();
176 final List<Integer> openDevices = netconfDeviceSimulator.start(params);
177 if (openDevices.size() == 0) {
178 LOG.error("Failed to start any simulated devices, exiting...");
181 if(params.distroFolder != null) {
182 final ConfigGenerator configGenerator = new ConfigGenerator(params.distroFolder, openDevices);
183 final List<File> generated = configGenerator.generate(params.ssh, params.generateConfigBatchSize, params.generateConfigsTimeout, params.generateConfigsAddress);
184 configGenerator.updateFeatureFile(generated);
185 configGenerator.changeLoadOrder();
187 } catch (final Exception e) {
188 LOG.error("Unhandled exception", e);
189 netconfDeviceSimulator.close();
194 synchronized (netconfDeviceSimulator) {
196 netconfDeviceSimulator.wait();
197 } catch (final InterruptedException e) {
198 throw new RuntimeException(e);
203 private static Params parseArgs(final String[] args, final ArgumentParser parser) {
204 final Params opt = new Params();
206 parser.parseArgs(args, opt);
208 } catch (final ArgumentParserException e) {
209 parser.handleError(e);
216 private static class ConfigGenerator {
217 public static final String NETCONF_CONNECTOR_XML = "/99-netconf-connector-simulated.xml";
218 public static final String SIM_DEVICE_SUFFIX = "-sim-device";
220 private static final String SIM_DEVICE_CFG_PREFIX = "simulated-devices_";
221 private static final String ETC_KARAF_PATH = "etc/";
222 private static final String ETC_OPENDAYLIGHT_KARAF_PATH = ETC_KARAF_PATH + "opendaylight/karaf/";
224 public static final String NETCONF_CONNECTOR_ALL_FEATURE = "odl-netconf-connector-all";
225 private static final String ORG_OPS4J_PAX_URL_MVN_CFG = "org.ops4j.pax.url.mvn.cfg";
227 private final File configDir;
228 private final List<Integer> openDevices;
229 private final List<File> ncFeatureFiles;
230 private final File etcDir;
231 private final File loadOrderCfgFile;
233 public ConfigGenerator(final File directory, final List<Integer> openDevices) {
234 this.configDir = new File(directory, ETC_OPENDAYLIGHT_KARAF_PATH);
235 this.etcDir = new File(directory, ETC_KARAF_PATH);
236 this.loadOrderCfgFile = new File(etcDir, ORG_OPS4J_PAX_URL_MVN_CFG);
237 this.ncFeatureFiles = getFeatureFile(directory, "features-netconf-connector", "xml");
238 this.openDevices = openDevices;
241 public List<File> generate(final boolean useSsh, final int batchSize, final int generateConfigsTimeout, final String address) {
242 if(configDir.exists() == false) {
243 Preconditions.checkState(configDir.mkdirs(), "Unable to create directory " + configDir);
246 for (final File file : configDir.listFiles(new FileFilter() {
248 public boolean accept(final File pathname) {
249 return !pathname.isDirectory() && pathname.getName().startsWith(SIM_DEVICE_CFG_PREFIX);
252 Preconditions.checkState(file.delete(), "Unable to clean previous generated file %s", file);
255 try(InputStream stream = Main.class.getResourceAsStream(NETCONF_CONNECTOR_XML)) {
256 checkNotNull(stream, "Cannot load %s", NETCONF_CONNECTOR_XML);
257 String configBlueprint = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
259 final String before = configBlueprint.substring(0, configBlueprint.indexOf("<module>"));
260 final String middleBlueprint = configBlueprint.substring(configBlueprint.indexOf("<module>"), configBlueprint.indexOf("</module>"));
261 final String after = configBlueprint.substring(configBlueprint.indexOf("</module>") + "</module>".length());
263 int connectorCount = 0;
264 Integer batchStart = null;
265 StringBuilder b = new StringBuilder();
268 final List<File> generatedConfigs = Lists.newArrayList();
270 for (final Integer openDevice : openDevices) {
271 if(batchStart == null) {
272 batchStart = openDevice;
275 final String name = String.valueOf(openDevice) + SIM_DEVICE_SUFFIX;
276 String configContent = String.format(middleBlueprint, name, address, String.valueOf(openDevice), String.valueOf(!useSsh));
277 configContent = String.format("%s%s%d%s\n%s\n", configContent, "<connection-timeout-millis>", generateConfigsTimeout, "</connection-timeout-millis>", "</module>");
279 b.append(configContent);
281 if(connectorCount == batchSize) {
283 final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevice));
284 generatedConfigs.add(to);
285 Files.write(b.toString(), to, Charsets.UTF_8);
287 b = new StringBuilder();
294 if(connectorCount != 0) {
296 final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevices.get(openDevices.size() - 1)));
297 generatedConfigs.add(to);
298 Files.write(b.toString(), to, Charsets.UTF_8);
301 LOG.info("Config files generated in {}", configDir);
302 return generatedConfigs;
303 } catch (final IOException e) {
304 throw new RuntimeException("Unable to generate config files", e);
309 public void updateFeatureFile(final List<File> generated) {
310 // TODO karaf core contains jaxb for feature files, use that for
313 for (final File featureFile : ncFeatureFiles) {
314 final Document document = XmlUtil.readXmlToDocument(Files
315 .toString(featureFile, Charsets.UTF_8));
316 final NodeList childNodes = document.getDocumentElement().getChildNodes();
318 for (int i = 0; i < childNodes.getLength(); i++) {
319 final Node item = childNodes.item(i);
320 if (item instanceof Element == false) {
323 if (item.getLocalName().equals("feature") == false) {
327 if (NETCONF_CONNECTOR_ALL_FEATURE
328 .equals(((Element) item).getAttribute("name"))) {
329 final Element ncAllFeatureDefinition = (Element) item;
330 // Clean previous generated files
331 for (final XmlElement configfile : XmlElement
332 .fromDomElement(ncAllFeatureDefinition)
333 .getChildElements("configfile")) {
334 ncAllFeatureDefinition.removeChild(configfile.getDomElement());
336 for (final File file : generated) {
337 final Element configfile = document.createElement("configfile");
338 configfile.setTextContent("file:"
339 + ETC_OPENDAYLIGHT_KARAF_PATH
341 configfile.setAttribute(
343 ETC_OPENDAYLIGHT_KARAF_PATH
345 ncAllFeatureDefinition.appendChild(configfile);
350 Files.write(XmlUtil.toString(document), featureFile,Charsets.UTF_8);
351 LOG.info("Feature file {} updated", featureFile);
353 } catch (final IOException e) {
354 throw new RuntimeException("Unable to load features file as a resource");
355 } catch (final SAXException e) {
356 throw new RuntimeException("Unable to parse features file");
361 private static List<File> getFeatureFile(final File distroFolder, final String featureName, final String suffix) {
362 checkExistingDir(distroFolder, String.format("Folder %s does not exist", distroFolder));
364 final File systemDir = checkExistingDir(new File(distroFolder, "system"), String.format("Folder %s does not contain a karaf distro, folder system is missing", distroFolder));
365 final File netconfConnectorFeaturesParentDir = checkExistingDir(new File(systemDir, "org/opendaylight/controller/" + featureName), String.format("Karaf distro in %s does not contain netconf-connector features", distroFolder));
367 // Find newest version for features
368 final File newestVersionDir = Collections.max(
369 Lists.newArrayList(netconfConnectorFeaturesParentDir.listFiles(new FileFilter() {
371 public boolean accept(final File pathname) {
372 return pathname.isDirectory();
374 })), new Comparator<File>() {
376 public int compare(final File o1, final File o2) {
377 return o1.getName().compareTo(o2.getName());
381 return Lists.newArrayList(newestVersionDir.listFiles(new FileFilter() {
383 public boolean accept(final File pathname) {
384 return pathname.getName().contains(featureName)
385 && Files.getFileExtension(pathname.getName()).equals(suffix);
390 private static File checkExistingDir(final File folder, final String msg) {
391 Preconditions.checkArgument(folder.exists(), msg);
392 Preconditions.checkArgument(folder.isDirectory(), msg);
396 public void changeLoadOrder() {
398 Files.write(ByteStreams.toByteArray(getClass().getResourceAsStream("/" +ORG_OPS4J_PAX_URL_MVN_CFG)), loadOrderCfgFile);
399 LOG.info("Load order changed to prefer local bundles/features by rewriting file {}", loadOrderCfgFile);
400 } catch (IOException e) {
401 throw new RuntimeException("Unable to rewrite features file " + loadOrderCfgFile, e);