netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/Main.java

   1 /*
   2  * Copyright (c) 2014 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;
  10
  11 import static com.google.common.base.Preconditions.checkNotNull;
  12
  13 import ch.qos.logback.classic.Level;
  14 import com.google.common.base.Charsets;
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.base.Stopwatch;
  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;
  21 import java.io.File;
  22 import java.io.FileFilter;
  23 import java.io.IOException;
  24 import java.io.InputStream;
  25 import java.io.InputStreamReader;
  26 import java.util.ArrayList;
  27 import java.util.Collections;
  28 import java.util.Comparator;
  29 import java.util.List;
  30 import java.util.concurrent.ExecutionException;
  31 import java.util.concurrent.ExecutorService;
  32 import java.util.concurrent.Executors;
  33 import java.util.concurrent.Future;
  34 import java.util.concurrent.TimeUnit;
  35 import org.opendaylight.controller.config.util.xml.XmlElement;
  36 import org.opendaylight.controller.config.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;
  44
  45
  46 public final class Main {
  47
  48     private static final Logger LOG = LoggerFactory.getLogger(Main.class);
  49
  50     public static void main(final String[] args) {
  51         final TesttoolParameters params = TesttoolParameters.parseArgs(args, TesttoolParameters.getParser());
  52         params.validate();
  53         final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
  54         root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
  55
  56         final NetconfDeviceSimulator netconfDeviceSimulator = new NetconfDeviceSimulator();
  57         try {
  58             final List<Integer> openDevices = netconfDeviceSimulator.start(params);
  59             if (openDevices.size() == 0) {
  60                 LOG.error("Failed to start any simulated devices, exiting...");
  61                 System.exit(1);
  62             }
  63             if (params.controllerDestination != null) {
  64                 final ArrayList<ArrayList<Execution.DestToPayload>> allThreadsPayloads = params.getThreadsPayloads(openDevices);
  65                 final ArrayList<Execution> executions = new ArrayList<>();
  66                 for (ArrayList<Execution.DestToPayload> payloads : allThreadsPayloads) {
  67                     executions.add(new Execution(params, payloads));
  68                 }
  69                 final ExecutorService executorService = Executors.newFixedThreadPool(params.threadAmount);
  70                 final Stopwatch time = Stopwatch.createStarted();
  71                 List<Future<Void>> futures = executorService.invokeAll(executions, params.timeOut, TimeUnit.SECONDS);
  72                 int threadNum = 0;
  73                 for(Future<Void> future : futures){
  74                     threadNum++;
  75                     if (future.isCancelled()) {
  76                         LOG.info("{}. thread timed out.",threadNum);
  77                     } else {
  78                         try {
  79                             future.get();
  80                         } catch (final ExecutionException e) {
  81                             LOG.info("{}. thread failed.", threadNum, e);
  82                         }
  83                     }
  84                 }
  85                 time.stop();
  86                 LOG.info("Time spent with configuration of devices: {}.",time);
  87             }
  88
  89             if (params.distroFolder != null) {
  90                 final ConfigGenerator configGenerator = new ConfigGenerator(params.distroFolder, openDevices);
  91                 final List<File> generated = configGenerator.generate(
  92                         params.ssh, params.generateConfigBatchSize,
  93                         params.generateConfigsTimeout, params.generateConfigsAddress,
  94                         params.devicesPerPort);
  95                 configGenerator.updateFeatureFile(generated);
  96                 configGenerator.changeLoadOrder();
  97             }
  98         } catch (final Exception e) {
  99             LOG.error("Unhandled exception", e);
 100             netconfDeviceSimulator.close();
 101             System.exit(1);
 102         }
 103
 104         // Block main thread
 105         synchronized (netconfDeviceSimulator) {
 106             try {
 107                 netconfDeviceSimulator.wait();
 108             } catch (final InterruptedException e) {
 109                 throw new RuntimeException(e);
 110             }
 111         }
 112     }
 113
 114     static class ConfigGenerator {
 115         public static final String NETCONF_CONNECTOR_XML = "/99-netconf-connector-simulated.xml";
 116         public static final String SIM_DEVICE_SUFFIX = "-sim-device";
 117
 118         private static final String SIM_DEVICE_CFG_PREFIX = "simulated-devices_";
 119         private static final String ETC_KARAF_PATH = "etc/";
 120         private static final String ETC_OPENDAYLIGHT_KARAF_PATH = ETC_KARAF_PATH + "opendaylight/karaf/";
 121
 122         public static final String NETCONF_CONNECTOR_ALL_FEATURE = "odl-netconf-connector-all";
 123         private static final String ORG_OPS4J_PAX_URL_MVN_CFG = "org.ops4j.pax.url.mvn.cfg";
 124
 125         private final File configDir;
 126         private final List<Integer> openDevices;
 127         private final List<File> ncFeatureFiles;
 128         private final File etcDir;
 129         private final File loadOrderCfgFile;
 130
 131         public ConfigGenerator(final File directory, final List<Integer> openDevices) {
 132             this.configDir = new File(directory, ETC_OPENDAYLIGHT_KARAF_PATH);
 133             this.etcDir = new File(directory, ETC_KARAF_PATH);
 134             this.loadOrderCfgFile = new File(etcDir, ORG_OPS4J_PAX_URL_MVN_CFG);
 135             this.ncFeatureFiles = getFeatureFile(directory, "features-netconf-connector", "xml");
 136             this.openDevices = openDevices;
 137         }
 138
 139         public List<File> generate(final boolean useSsh, final int batchSize,
 140                                    final int generateConfigsTimeout, final String address,
 141                                    final int devicesPerPort) {
 142             if (configDir.exists() == false) {
 143                 Preconditions.checkState(configDir.mkdirs(), "Unable to create directory " + configDir);
 144             }
 145
 146             for (final File file : configDir.listFiles(new FileFilter() {
 147                 @Override
 148                 public boolean accept(final File pathname) {
 149                     return !pathname.isDirectory() && pathname.getName().startsWith(SIM_DEVICE_CFG_PREFIX);
 150                 }
 151             })) {
 152                 Preconditions.checkState(file.delete(), "Unable to clean previous generated file %s", file);
 153             }
 154
 155             try (InputStream stream = Main.class.getResourceAsStream(NETCONF_CONNECTOR_XML)) {
 156                 checkNotNull(stream, "Cannot load %s", NETCONF_CONNECTOR_XML);
 157                 String configBlueprint = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
 158
 159                 final String before = configBlueprint.substring(0, configBlueprint.indexOf("<module>"));
 160                 final String middleBlueprint = configBlueprint.substring(configBlueprint.indexOf("<module>"), configBlueprint.indexOf("</module>"));
 161                 final String after = configBlueprint.substring(configBlueprint.indexOf("</module>") + "</module>".length());
 162
 163                 int connectorCount = 0;
 164                 Integer batchStart = null;
 165                 StringBuilder b = new StringBuilder();
 166                 b.append(before);
 167
 168                 final List<File> generatedConfigs = Lists.newArrayList();
 169
 170                 for (final Integer openDevice : openDevices) {
 171                     if (batchStart == null) {
 172                         batchStart = openDevice;
 173                     }
 174
 175                     for (int i = 0; i < devicesPerPort; i++) {
 176                         final String name = String.valueOf(openDevice) + SIM_DEVICE_SUFFIX + (i == 0 ? "" : "-" + String.valueOf(i));
 177                         String configContent = String.format(middleBlueprint, name, address, String.valueOf(openDevice), String.valueOf(!useSsh));
 178                         configContent = String.format("%s%s%d%s\n%s\n", configContent, "<connection-timeout-millis>", generateConfigsTimeout, "</connection-timeout-millis>", "</module>");
 179
 180                         b.append(configContent);
 181                         connectorCount++;
 182                         if (connectorCount == batchSize) {
 183                             b.append(after);
 184                             final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevice));
 185                             generatedConfigs.add(to);
 186                             Files.write(b.toString(), to, Charsets.UTF_8);
 187                             connectorCount = 0;
 188                             b = new StringBuilder();
 189                             b.append(before);
 190                             batchStart = null;
 191                         }
 192                     }
 193                 }
 194
 195                 // Write remaining
 196                 if (connectorCount != 0) {
 197                     b.append(after);
 198                     final File to = new File(configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevices.get(openDevices.size() - 1)));
 199                     generatedConfigs.add(to);
 200                     Files.write(b.toString(), to, Charsets.UTF_8);
 201                 }
 202
 203                 LOG.info("Config files generated in {}", configDir);
 204                 return generatedConfigs;
 205             } catch (final IOException e) {
 206                 throw new RuntimeException("Unable to generate config files", e);
 207             }
 208         }
 209
 210
 211         public void updateFeatureFile(final List<File> generated) {
 212             // TODO karaf core contains jaxb for feature files, use that for
 213             // modification
 214             try {
 215                 for (final File featureFile : ncFeatureFiles) {
 216                     final Document document = XmlUtil.readXmlToDocument(Files
 217                             .toString(featureFile, Charsets.UTF_8));
 218                     final NodeList childNodes = document.getDocumentElement().getChildNodes();
 219
 220                     for (int i = 0; i < childNodes.getLength(); i++) {
 221                         final Node item = childNodes.item(i);
 222                         if (item instanceof Element == false) {
 223                             continue;
 224                         }
 225                         if (item.getLocalName().equals("feature") == false) {
 226                             continue;
 227                         }
 228
 229                         if (NETCONF_CONNECTOR_ALL_FEATURE
 230                                 .equals(((Element) item).getAttribute("name"))) {
 231                             final Element ncAllFeatureDefinition = (Element) item;
 232                             // Clean previous generated files
 233                             for (final XmlElement configfile : XmlElement
 234                                     .fromDomElement(ncAllFeatureDefinition)
 235                                     .getChildElements("configfile")) {
 236                                 ncAllFeatureDefinition.removeChild(configfile.getDomElement());
 237                             }
 238                             for (final File file : generated) {
 239                                 final Element configfile = document.createElement("configfile");
 240                                 configfile.setTextContent("file:"
 241                                         + ETC_OPENDAYLIGHT_KARAF_PATH
 242                                         + file.getName());
 243                                 configfile.setAttribute(
 244                                         "finalname",
 245                                         ETC_OPENDAYLIGHT_KARAF_PATH
 246                                                 + file.getName());
 247                                 ncAllFeatureDefinition.appendChild(configfile);
 248                             }
 249                         }
 250                     }
 251
 252                     Files.write(XmlUtil.toString(document), featureFile, Charsets.UTF_8);
 253                     LOG.info("Feature file {} updated", featureFile);
 254                 }
 255             } catch (final IOException e) {
 256                 throw new RuntimeException("Unable to load features file as a resource");
 257             } catch (final SAXException e) {
 258                 throw new RuntimeException("Unable to parse features file");
 259             }
 260         }
 261
 262
 263         private static List<File> getFeatureFile(final File distroFolder, final String featureName, final String suffix) {
 264             checkExistingDir(distroFolder, String.format("Folder %s does not exist", distroFolder));
 265
 266             final File systemDir = checkExistingDir(new File(distroFolder, "system"), String.format("Folder %s does not contain a karaf distro, folder system is missing", distroFolder));
 267
 268             //check if beryllium path exists, if it doesnt check for lithium and fail/succeed after
 269             File netconfConnectorFeaturesParentDir = new File(systemDir, "org/opendaylight/netconf/" + featureName);
 270             if (!netconfConnectorFeaturesParentDir.exists() || !netconfConnectorFeaturesParentDir.isDirectory()) {
 271                 netconfConnectorFeaturesParentDir = checkExistingDir(new File(systemDir, "org/opendaylight/controller/" + featureName), String.format("Karaf distro in %s does not contain netconf-connector features", distroFolder));
 272             }
 273
 274             // Find newest version for features
 275             final File newestVersionDir = Collections.max(
 276                     Lists.newArrayList(netconfConnectorFeaturesParentDir.listFiles(new FileFilter() {
 277                         @Override
 278                         public boolean accept(final File pathname) {
 279                             return pathname.isDirectory();
 280                         }
 281                     })), new Comparator<File>() {
 282                         @Override
 283                         public int compare(final File o1, final File o2) {
 284                             return o1.getName().compareTo(o2.getName());
 285                         }
 286                     });
 287
 288             return Lists.newArrayList(newestVersionDir.listFiles(new FileFilter() {
 289                 @Override
 290                 public boolean accept(final File pathname) {
 291                     return pathname.getName().contains(featureName)
 292                             && Files.getFileExtension(pathname.getName()).equals(suffix);
 293                 }
 294             }));
 295         }
 296
 297         private static File checkExistingDir(final File folder, final String msg) {
 298             Preconditions.checkArgument(folder.exists(), msg);
 299             Preconditions.checkArgument(folder.isDirectory(), msg);
 300             return folder;
 301         }
 302
 303         public void changeLoadOrder() {
 304             try {
 305                 Files.write(ByteStreams.toByteArray(getClass().getResourceAsStream("/" + ORG_OPS4J_PAX_URL_MVN_CFG)), loadOrderCfgFile);
 306                 LOG.info("Load order changed to prefer local bundles/features by rewriting file {}", loadOrderCfgFile);
 307             } catch (IOException e) {
 308                 throw new RuntimeException("Unable to rewrite features file " + loadOrderCfgFile, e);
 309             }
 310         }
 311     }
 312 }