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;
13 import static com.google.common.base.Preconditions.checkState;
15 import ch.qos.logback.classic.Level;
16 import com.google.common.base.Charsets;
17 import com.google.common.base.Preconditions;
18 import com.google.common.collect.Lists;
19 import com.google.common.io.ByteStreams;
20 import com.google.common.io.CharStreams;
21 import com.google.common.io.Files;
23 import java.io.FileFilter;
24 import java.io.IOException;
25 import java.io.InputStream;
26 import java.io.InputStreamReader;
27 import java.util.Collections;
28 import java.util.Comparator;
29 import java.util.List;
30 import java.util.concurrent.TimeUnit;
31 import net.sourceforge.argparse4j.ArgumentParsers;
32 import net.sourceforge.argparse4j.annotation.Arg;
33 import net.sourceforge.argparse4j.inf.ArgumentParser;
34 import net.sourceforge.argparse4j.inf.ArgumentParserException;
35 import org.opendaylight.controller.netconf.util.xml.XmlElement;
36 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
39 import org.w3c.dom.Document;
40 import org.w3c.dom.Element;
41 import org.w3c.dom.Node;
42 import org.w3c.dom.NodeList;
43 import org.xml.sax.SAXException;
45 public final class Main {
47 private static final Logger LOG = LoggerFactory.getLogger(Main.class);
51 @Arg(dest = "schemas-dir")
52 public File schemasDir;
54 @Arg(dest = "devices-count")
55 public int deviceCount;
57 @Arg(dest = "starting-port")
58 public int startingPort;
60 @Arg(dest = "generate-config-connection-timeout")
61 public int generateConfigsTimeout;
63 @Arg(dest = "generate-config-address")
64 public String generateConfigsAddress;
66 @Arg(dest = "distro-folder")
67 public File distroFolder;
69 @Arg(dest = "generate-configs-batch-size")
70 public int generateConfigBatchSize;
81 static ArgumentParser getParser() {
82 final ArgumentParser parser = ArgumentParsers.newArgumentParser("netconf testool");
84 parser.description("Netconf device simulator. Detailed info can be found at https://wiki.opendaylight.org/view/OpenDaylight_Controller:Netconf:Testtool#Building_testtool");
86 parser.addArgument("--device-count")
90 .help("Number of simulated netconf devices to spin")
91 .dest("devices-count");
93 parser.addArgument("--schemas-dir")
95 .help("Directory containing yang schemas to describe simulated devices. Some schemas e.g. netconf monitoring and inet types are included by default")
98 parser.addArgument("--starting-port")
101 .help("First port for simulated device. Each other device will have previous+1 port number")
102 .dest("starting-port");
104 parser.addArgument("--generate-config-connection-timeout")
106 .setDefault((int)TimeUnit.MINUTES.toMillis(30))
107 .help("Timeout to be generated in initial config files")
108 .dest("generate-config-connection-timeout");
110 parser.addArgument("--generate-config-address")
112 .setDefault("127.0.0.1")
113 .help("Address to be placed in generated configs")
114 .dest("generate-config-address");
116 parser.addArgument("--generate-configs-batch-size")
119 .help("Number of connector configs per generated file")
120 .dest("generate-configs-batch-size");
122 parser.addArgument("--distribution-folder")
124 .help("Directory where the karaf distribution for controller is located")
125 .dest("distro-folder");
127 parser.addArgument("--ssh")
130 .help("Whether to use ssh for transport or just pure tcp")
133 parser.addArgument("--exi")
136 .help("Whether to use exi to transport xml content")
139 parser.addArgument("--debug")
142 .help("Whether to use debug log level instead of INFO")
149 checkArgument(deviceCount > 0, "Device count has to be > 0");
150 checkArgument(startingPort > 1023, "Starting port has to be > 1023");
152 if(schemasDir != null) {
153 checkArgument(schemasDir.exists(), "Schemas dir has to exist");
154 checkArgument(schemasDir.isDirectory(), "Schemas dir has to be a directory");
155 checkArgument(schemasDir.canRead(), "Schemas dir has to be readable");
160 public static void main(final String[] args) {
161 final Params params = parseArgs(args, Params.getParser());
164 final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
165 root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
167 final NetconfDeviceSimulator netconfDeviceSimulator = new NetconfDeviceSimulator();
169 final List<Integer> openDevices = netconfDeviceSimulator.start(params);
170 if (openDevices.size() == 0) {
171 LOG.error("Failed to start any simulated devices, exiting...");
174 if(params.distroFolder != null) {
175 final ConfigGenerator configGenerator = new ConfigGenerator(params.distroFolder, openDevices);
176 final List<File> generated = configGenerator.generate(params.ssh, params.generateConfigBatchSize, params.generateConfigsTimeout, params.generateConfigsAddress);
177 configGenerator.updateFeatureFile(generated);
178 configGenerator.changeLoadOrder();
180 } catch (final Exception e) {
181 LOG.error("Unhandled exception", e);
182 netconfDeviceSimulator.close();
187 synchronized (netconfDeviceSimulator) {
189 netconfDeviceSimulator.wait();
190 } catch (final InterruptedException e) {
191 throw new RuntimeException(e);
196 private static Params parseArgs(final String[] args, final ArgumentParser parser) {
197 final Params opt = new Params();
199 parser.parseArgs(args, opt);
201 } catch (final ArgumentParserException e) {
202 parser.handleError(e);
209 private static class ConfigGenerator {
210 public static final String NETCONF_CONNECTOR_XML = "/initial/99-netconf-connector.xml";
211 public static final String NETCONF_CONNECTOR_NAME = "controller-config";
212 public static final String NETCONF_CONNECTOR_PORT = "1830";
213 public static final String NETCONF_CONNECTOR_ADDRESS = "127.0.0.1";
214 public static final String NETCONF_USE_SSH = "false";
215 public static final String SIM_DEVICE_SUFFIX = "-sim-device";
217 private static final String SIM_DEVICE_CFG_PREFIX = "simulated-devices_";
218 private static final String ETC_KARAF_PATH = "etc/";
219 private static final String ETC_OPENDAYLIGHT_KARAF_PATH = ETC_KARAF_PATH + "opendaylight/karaf/";
221 public static final String NETCONF_CONNECTOR_ALL_FEATURE = "odl-netconf-connector-all";
222 private static final String ORG_OPS4J_PAX_URL_MVN_CFG = "org.ops4j.pax.url.mvn.cfg";
224 private final File configDir;
225 private final List<Integer> openDevices;
226 private final List<File> ncFeatureFiles;
227 private final File etcDir;
228 private final File loadOrderCfgFile;
230 public ConfigGenerator(final File directory, final List<Integer> openDevices) {
231 this.configDir = new File(directory, ETC_OPENDAYLIGHT_KARAF_PATH);
232 this.etcDir = new File(directory, ETC_KARAF_PATH);
233 this.loadOrderCfgFile = new File(etcDir, ORG_OPS4J_PAX_URL_MVN_CFG);
234 this.ncFeatureFiles = getFeatureFile(directory, "features-netconf-connector", "xml");
235 this.openDevices = openDevices;
238 public List<File> generate(final boolean useSsh, final int batchSize, final int generateConfigsTimeout, final String address) {
239 if(configDir.exists() == false) {
240 Preconditions.checkState(configDir.mkdirs(), "Unable to create directory " + configDir);
243 for (final File file : configDir.listFiles(new FileFilter() {
245 public boolean accept(final File pathname) {
246 return !pathname.isDirectory() && pathname.getName().startsWith(SIM_DEVICE_CFG_PREFIX);
249 Preconditions.checkState(file.delete(), "Unable to clean previous generated file %s", file);
252 try(InputStream stream = Main.class.getResourceAsStream(NETCONF_CONNECTOR_XML)) {
253 checkNotNull(stream, "Cannot load %s", NETCONF_CONNECTOR_XML);
254 String configBlueprint = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
256 checkState(configBlueprint.contains(NETCONF_CONNECTOR_NAME));
257 checkState(configBlueprint.contains(NETCONF_CONNECTOR_PORT));
258 checkState(configBlueprint.contains(NETCONF_USE_SSH));
259 checkState(configBlueprint.contains(NETCONF_CONNECTOR_ADDRESS));
260 configBlueprint = configBlueprint.replace(NETCONF_CONNECTOR_NAME, "%s");
261 configBlueprint = configBlueprint.replace(NETCONF_CONNECTOR_ADDRESS, "%s");
262 configBlueprint = configBlueprint.replace(NETCONF_CONNECTOR_PORT, "%s");
263 configBlueprint = configBlueprint.replace(NETCONF_USE_SSH, "%s");
265 final String before = configBlueprint.substring(0, configBlueprint.indexOf("<module>"));
266 final String middleBlueprint = configBlueprint.substring(configBlueprint.indexOf("<module>"), configBlueprint.indexOf("</module>"));
267 final String after = configBlueprint.substring(configBlueprint.indexOf("</module>") + "</module>".length());
269 int connectorCount = 0;
270 Integer batchStart = null;
271 StringBuilder b = new StringBuilder();
274 final List<File> generatedConfigs = Lists.newArrayList();
276 for (final Integer openDevice : openDevices) {
277 if(batchStart == null) {
278 batchStart = openDevice;
281 final String name = String.valueOf(openDevice) + SIM_DEVICE_SUFFIX;
282 String configContent = String.format(middleBlueprint, name, address, String.valueOf(openDevice), String.valueOf(!useSsh));
283 configContent = String.format("%s%s%d%s\n%s\n", configContent, "<connection-timeout-millis>", generateConfigsTimeout, "</connection-timeout-millis>", "</module>");
285 b.append(configContent);
287 if(connectorCount == batchSize) {
289 final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevice));
290 generatedConfigs.add(to);
291 Files.write(b.toString(), to, Charsets.UTF_8);
293 b = new StringBuilder();
300 if(connectorCount != 0) {
302 final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevices.get(openDevices.size() - 1)));
303 generatedConfigs.add(to);
304 Files.write(b.toString(), to, Charsets.UTF_8);
307 LOG.info("Config files generated in {}", configDir);
308 return generatedConfigs;
309 } catch (final IOException e) {
310 throw new RuntimeException("Unable to generate config files", e);
315 public void updateFeatureFile(final List<File> generated) {
316 // TODO karaf core contains jaxb for feature files, use that for
319 for (final File featureFile : ncFeatureFiles) {
320 final Document document = XmlUtil.readXmlToDocument(Files
321 .toString(featureFile, Charsets.UTF_8));
322 final NodeList childNodes = document.getDocumentElement().getChildNodes();
324 for (int i = 0; i < childNodes.getLength(); i++) {
325 final Node item = childNodes.item(i);
326 if (item instanceof Element == false) {
329 if (item.getLocalName().equals("feature") == false) {
333 if (NETCONF_CONNECTOR_ALL_FEATURE
334 .equals(((Element) item).getAttribute("name"))) {
335 final Element ncAllFeatureDefinition = (Element) item;
336 // Clean previous generated files
337 for (final XmlElement configfile : XmlElement
338 .fromDomElement(ncAllFeatureDefinition)
339 .getChildElements("configfile")) {
340 ncAllFeatureDefinition.removeChild(configfile.getDomElement());
342 for (final File file : generated) {
343 final Element configfile = document.createElement("configfile");
344 configfile.setTextContent("file:"
345 + ETC_OPENDAYLIGHT_KARAF_PATH
347 configfile.setAttribute(
349 ETC_OPENDAYLIGHT_KARAF_PATH
351 ncAllFeatureDefinition.appendChild(configfile);
356 Files.write(XmlUtil.toString(document), featureFile,Charsets.UTF_8);
357 LOG.info("Feature file {} updated", featureFile);
359 } catch (final IOException e) {
360 throw new RuntimeException("Unable to load features file as a resource");
361 } catch (final SAXException e) {
362 throw new RuntimeException("Unable to parse features file");
367 private static List<File> getFeatureFile(final File distroFolder, final String featureName, final String suffix) {
368 checkExistingDir(distroFolder, String.format("Folder %s does not exist", distroFolder));
370 final File systemDir = checkExistingDir(new File(distroFolder, "system"), String.format("Folder %s does not contain a karaf distro, folder system is missing", distroFolder));
371 final File netconfConnectorFeaturesParentDir = checkExistingDir(new File(systemDir, "org/opendaylight/controller/" + featureName), String.format("Karaf distro in %s does not contain netconf-connector features", distroFolder));
373 // Find newest version for features
374 final File newestVersionDir = Collections.max(
375 Lists.newArrayList(netconfConnectorFeaturesParentDir.listFiles(new FileFilter() {
377 public boolean accept(final File pathname) {
378 return pathname.isDirectory();
380 })), new Comparator<File>() {
382 public int compare(final File o1, final File o2) {
383 return o1.getName().compareTo(o2.getName());
387 return Lists.newArrayList(newestVersionDir.listFiles(new FileFilter() {
389 public boolean accept(final File pathname) {
390 return pathname.getName().contains(featureName)
391 && Files.getFileExtension(pathname.getName()).equals(suffix);
396 private static File checkExistingDir(final File folder, final String msg) {
397 Preconditions.checkArgument(folder.exists(), msg);
398 Preconditions.checkArgument(folder.isDirectory(), msg);
402 public void changeLoadOrder() {
404 Files.write(ByteStreams.toByteArray(getClass().getResourceAsStream("/" +ORG_OPS4J_PAX_URL_MVN_CFG)), loadOrderCfgFile);
405 LOG.info("Load order changed to prefer local bundles/features by rewriting file {}", loadOrderCfgFile);
406 } catch (IOException e) {
407 throw new RuntimeException("Unable to rewrite features file " + loadOrderCfgFile, e);