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