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.Preconditions;
  15 import com.google.common.base.Stopwatch;
  16 import com.google.common.collect.Lists;
  17 import com.google.common.io.ByteStreams;
  18 import com.google.common.io.CharStreams;
  19 import com.google.common.io.Files;
  20 import java.io.File;
  21 import java.io.FileWriter;
  22 import java.io.IOException;
  23 import java.io.InputStream;
  24 import java.io.InputStreamReader;
  25 import java.nio.charset.StandardCharsets;
  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 javax.xml.bind.JAXBException;
  36 import org.apache.karaf.features.internal.model.ConfigFile;
  37 import org.apache.karaf.features.internal.model.Feature;
  38 import org.apache.karaf.features.internal.model.Features;
  39 import org.apache.karaf.features.internal.model.JaxbUtil;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43
  44 public final class Main {
  45     private static final Logger LOG = LoggerFactory.getLogger(Main.class);
  46
  47     @SuppressWarnings("checkstyle:IllegalCatch")
  48     public static void main(final String[] args) {
  49         final TesttoolParameters params = TesttoolParameters.parseArgs(args, TesttoolParameters.getParser());
  50         params.validate();
  51         final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory
  52             .getLogger(Logger.ROOT_LOGGER_NAME);
  53         root.setLevel(params.debug ? Level.DEBUG : Level.INFO);
  54
  55         final NetconfDeviceSimulator netconfDeviceSimulator = new NetconfDeviceSimulator(params.threadPoolSize);
  56         try {
  57             LOG.debug("Trying to start netconf test-tool with parameters {}", params);
  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
  65                     .getThreadsPayloads(openDevices);
  66                 final ArrayList<Execution> executions = new ArrayList<>();
  67                 for (ArrayList<Execution.DestToPayload> payloads : allThreadsPayloads) {
  68                     executions.add(new Execution(params, payloads));
  69                 }
  70                 final ExecutorService executorService = Executors.newFixedThreadPool(params.threadAmount);
  71                 final Stopwatch time = Stopwatch.createStarted();
  72                 List<Future<Void>> futures = executorService.invokeAll(executions, params.timeOut, TimeUnit.SECONDS);
  73                 int threadNum = 0;
  74                 for (Future<Void> future : futures) {
  75                     threadNum++;
  76                     if (future.isCancelled()) {
  77                         LOG.info("{}. thread timed out.",threadNum);
  78                     } else {
  79                         try {
  80                             future.get();
  81                         } catch (final ExecutionException e) {
  82                             LOG.info("{}. thread failed.", threadNum, e);
  83                         }
  84                     }
  85                 }
  86                 time.stop();
  87                 LOG.info("Time spent with configuration of devices: {}.",time);
  88             }
  89
  90             if (params.distroFolder != null) {
  91                 final ConfigGenerator configGenerator = new ConfigGenerator(params.distroFolder, openDevices);
  92                 final List<File> generated = configGenerator.generate(
  93                         params.ssh, params.generateConfigBatchSize,
  94                         params.generateConfigsTimeout, params.generateConfigsAddress,
  95                         params.devicesPerPort);
  96                 configGenerator.updateFeatureFile(generated);
  97                 configGenerator.changeLoadOrder();
  98             }
  99         } catch (final Exception e) {
 100             LOG.error("Unhandled exception", e);
 101             netconfDeviceSimulator.close();
 102             System.exit(1);
 103         }
 104
 105         // Block main thread
 106         synchronized (netconfDeviceSimulator) {
 107             try {
 108                 netconfDeviceSimulator.wait();
 109             } catch (final InterruptedException e) {
 110                 throw new RuntimeException(e);
 111             }
 112         }
 113     }
 114
 115     static class ConfigGenerator {
 116         public static final String NETCONF_CONNECTOR_XML = "/99-netconf-connector-simulated.xml";
 117         public static final String SIM_DEVICE_SUFFIX = "-sim-device";
 118
 119         private static final String SIM_DEVICE_CFG_PREFIX = "simulated-devices_";
 120         private static final String ETC_KARAF_PATH = "etc/";
 121         private static final String ETC_OPENDAYLIGHT_KARAF_PATH = ETC_KARAF_PATH + "opendaylight/karaf/";
 122
 123         public static final String NETCONF_CONNECTOR_ALL_FEATURE = "odl-netconf-connector-all";
 124         private static final String ORG_OPS4J_PAX_URL_MVN_CFG = "org.ops4j.pax.url.mvn.cfg";
 125
 126         private final File configDir;
 127         private final List<Integer> openDevices;
 128         private final List<File> ncFeatureFiles;
 129         private final File etcDir;
 130         private final File loadOrderCfgFile;
 131
 132         ConfigGenerator(final File directory, final List<Integer> openDevices) {
 133             this.configDir = new File(directory, ETC_OPENDAYLIGHT_KARAF_PATH);
 134             this.etcDir = new File(directory, ETC_KARAF_PATH);
 135             this.loadOrderCfgFile = new File(etcDir, ORG_OPS4J_PAX_URL_MVN_CFG);
 136             this.ncFeatureFiles = getFeatureFile(directory, "features-netconf-connector", "xml");
 137             this.openDevices = openDevices;
 138         }
 139
 140         public List<File> generate(final boolean useSsh, final int batchSize,
 141                                    final int generateConfigsTimeout, final String address,
 142                                    final int devicesPerPort) {
 143             if (!configDir.exists()) {
 144                 Preconditions.checkState(configDir.mkdirs(), "Unable to create directory " + configDir);
 145             }
 146
 147             for (final File file : configDir.listFiles(pathname ->
 148                     !pathname.isDirectory() && pathname.getName().startsWith(SIM_DEVICE_CFG_PREFIX))) {
 149                 Preconditions.checkState(file.delete(), "Unable to clean previous generated file %s", file);
 150             }
 151
 152             try (InputStream stream = Main.class.getResourceAsStream(NETCONF_CONNECTOR_XML)) {
 153                 checkNotNull(stream, "Cannot load %s", NETCONF_CONNECTOR_XML);
 154                 String configBlueprint = CharStreams.toString(new InputStreamReader(stream, StandardCharsets.UTF_8));
 155
 156                 final String before = configBlueprint.substring(0, configBlueprint.indexOf("<module>"));
 157                 final String middleBlueprint = configBlueprint.substring(
 158                     configBlueprint.indexOf("<module>"), configBlueprint.indexOf("</module>"));
 159                 final String after = configBlueprint.substring(
 160                     configBlueprint.indexOf("</module>") + "</module>".length());
 161
 162                 int connectorCount = 0;
 163                 Integer batchStart = null;
 164                 StringBuilder builder = new StringBuilder();
 165                 builder.append(before);
 166
 167                 final List<File> generatedConfigs = Lists.newArrayList();
 168
 169                 for (final Integer openDevice : openDevices) {
 170                     if (batchStart == null) {
 171                         batchStart = openDevice;
 172                     }
 173
 174                     for (int i = 0; i < devicesPerPort; i++) {
 175                         final String name = String.valueOf(openDevice)
 176                             + SIM_DEVICE_SUFFIX + (i == 0 ? "" : "-" + String.valueOf(i));
 177                         String configContent = String.format(
 178                             middleBlueprint, name, address, String.valueOf(openDevice), String.valueOf(!useSsh));
 179                         configContent = String.format(
 180                             "%s%s%d%s\n%s\n", configContent, "<connection-timeout-millis>",
 181                             generateConfigsTimeout, "</connection-timeout-millis>", "</module>");
 182
 183                         builder.append(configContent);
 184                         connectorCount++;
 185                         if (connectorCount == batchSize) {
 186                             builder.append(after);
 187                             final File to = new File(
 188                                 configDir, String.format(SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevice));
 189                             generatedConfigs.add(to);
 190                             Files.write(builder.toString(), to, StandardCharsets.UTF_8);
 191                             connectorCount = 0;
 192                             builder = new StringBuilder();
 193                             builder.append(before);
 194                             batchStart = null;
 195                         }
 196                     }
 197                 }
 198
 199                 // Write remaining
 200                 if (connectorCount != 0) {
 201                     builder.append(after);
 202                     final File to = new File(configDir, String.format(
 203                             SIM_DEVICE_CFG_PREFIX + "%d-%d.xml", batchStart, openDevices.get(openDevices.size() - 1)));
 204                     generatedConfigs.add(to);
 205                     Files.write(builder.toString(), to, StandardCharsets.UTF_8);
 206                 }
 207
 208                 LOG.info("Config files generated in {}", configDir);
 209                 return generatedConfigs;
 210             } catch (final IOException e) {
 211                 throw new RuntimeException("Unable to generate config files", e);
 212             }
 213         }
 214
 215         public void updateFeatureFile(final List<File> generated) {
 216             for (final File fileFeatures : ncFeatureFiles) {
 217                 try {
 218                     final Features f =  JaxbUtil.unmarshal(fileFeatures.toURI().toString(), false);
 219
 220                     for (final Feature feature : f.getFeature()) {
 221                         if (NETCONF_CONNECTOR_ALL_FEATURE.equals(feature.getName())) {
 222                             //Clean all previously generated configFiles
 223                             feature.getConfigfile().clear();
 224
 225                             //Create new configFiles
 226                             for (final File gen : generated) {
 227                                 final ConfigFile cf = new ConfigFile();
 228
 229                                 final String generatedName = ETC_OPENDAYLIGHT_KARAF_PATH + gen.getName();
 230
 231                                 cf.setFinalname(generatedName);
 232                                 cf.setLocation("file:" + generatedName);
 233
 234                                 feature.getConfigfile().add(cf);
 235                             }
 236                         }
 237                     }
 238                     JaxbUtil.marshal(f, new FileWriter(fileFeatures));
 239                     LOG.info("Feature file {} updated", fileFeatures);
 240                 } catch (JAXBException | IOException e) {
 241                     throw new RuntimeException(e);
 242                 }
 243             }
 244         }
 245
 246         private static List<File> getFeatureFile(final File distroFolder, final String featureName,
 247                                                  final String suffix) {
 248             checkExistingDir(distroFolder, String.format("Folder %s does not exist", distroFolder));
 249
 250             final File systemDir = checkExistingDir(new File(distroFolder, "system"),
 251                 String.format("Folder %s does not contain a karaf distro, folder system is missing", distroFolder));
 252
 253             //check if beryllium path exists, if it doesnt check for lithium and fail/succeed after
 254             File netconfConnectorFeaturesParentDir = new File(systemDir, "org/opendaylight/netconf/" + featureName);
 255             if (!netconfConnectorFeaturesParentDir.exists() || !netconfConnectorFeaturesParentDir.isDirectory()) {
 256                 netconfConnectorFeaturesParentDir = checkExistingDir(new File(systemDir,
 257                     "org/opendaylight/controller/" + featureName),
 258                     String.format("Karaf distro in %s does not contain netconf-connector features", distroFolder));
 259             }
 260
 261             // Find newest version for features
 262             final File newestVersionDir = Collections.max(
 263                 Lists.newArrayList(netconfConnectorFeaturesParentDir.listFiles(File::isDirectory)),
 264                 Comparator.comparing(File::getName));
 265
 266             return Lists.newArrayList(newestVersionDir.listFiles(
 267                 pathname -> pathname.getName().contains(featureName)
 268                     && Files.getFileExtension(pathname.getName()).equals(suffix)));
 269         }
 270
 271         private static File checkExistingDir(final File folder, final String msg) {
 272             Preconditions.checkArgument(folder.exists(), msg);
 273             Preconditions.checkArgument(folder.isDirectory(), msg);
 274             return folder;
 275         }
 276
 277         public void changeLoadOrder() {
 278             try {
 279                 Files.write(ByteStreams.toByteArray(getClass().getResourceAsStream(
 280                     "/" + ORG_OPS4J_PAX_URL_MVN_CFG)), loadOrderCfgFile);
 281                 LOG.info("Load order changed to prefer local bundles/features by rewriting file {}", loadOrderCfgFile);
 282             } catch (IOException e) {
 283                 throw new RuntimeException("Unable to rewrite features file " + loadOrderCfgFile, e);
 284             }
 285         }
 286     }
 287 }