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