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.FileFilter;
  22 import java.io.FileWriter;
  23 import java.io.IOException;
  24 import java.io.InputStream;
  25 import java.io.InputStreamReader;
  26 import java.nio.charset.StandardCharsets;
  27 import java.util.ArrayList;
  28 import java.util.Collections;
  29 import java.util.Comparator;
  30 import java.util.List;
  31 import java.util.concurrent.ExecutionException;
  32 import java.util.concurrent.ExecutorService;
  33 import java.util.concurrent.Executors;
  34 import java.util.concurrent.Future;
  35 import java.util.concurrent.TimeUnit;
  36 import javax.xml.bind.JAXBException;
  37 import org.apache.karaf.features.internal.model.ConfigFile;
  38 import org.apache.karaf.features.internal.model.Feature;
  39 import org.apache.karaf.features.internal.model.Features;
  40 import org.apache.karaf.features.internal.model.JaxbUtil;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44
  45 public final class Main {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(Main.class);
  48
  49     public static void main(final String[] args) {
  50         final TesttoolParameters params = TesttoolParameters.parseArgs(args, TesttoolParameters.getParser());
  51         params.validate();
  52         final ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory.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.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, StandardCharsets.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, StandardCharsets.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, StandardCharsets.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             for (final File fileFeatures : ncFeatureFiles) {
 213                 try {
 214                     final Features f =  JaxbUtil.unmarshal(fileFeatures.toURI().toString(), false);
 215
 216                     for (final Feature feature : f.getFeature()) {
 217                         if (NETCONF_CONNECTOR_ALL_FEATURE.equals(feature.getName())) {
 218                             //Clean all previously generated configFiles
 219                             feature.getConfigfile().clear();
 220
 221                             //Create new configFiles
 222                             for (final File gen : generated) {
 223                                 final ConfigFile cf = new ConfigFile();
 224
 225                                 final String generatedName = ETC_OPENDAYLIGHT_KARAF_PATH + gen.getName();
 226
 227                                 cf.setFinalname(generatedName);
 228                                 cf.setLocation("file:" + generatedName);
 229
 230                                 feature.getConfigfile().add(cf);
 231                                 }
 232                             }
 233                         }
 234                     JaxbUtil.marshal(f, new FileWriter(fileFeatures));
 235                     LOG.info("Feature file {} updated", fileFeatures);
 236                 } catch (JAXBException | IOException e) {
 237                     throw new RuntimeException(e);
 238                 }
 239             }
 240         }
 241
 242
 243         private static List<File> getFeatureFile(final File distroFolder, final String featureName, final String suffix) {
 244             checkExistingDir(distroFolder, String.format("Folder %s does not exist", distroFolder));
 245
 246             final File systemDir = checkExistingDir(new File(distroFolder, "system"), String.format("Folder %s does not contain a karaf distro, folder system is missing", distroFolder));
 247
 248             //check if beryllium path exists, if it doesnt check for lithium and fail/succeed after
 249             File netconfConnectorFeaturesParentDir = new File(systemDir, "org/opendaylight/netconf/" + featureName);
 250             if (!netconfConnectorFeaturesParentDir.exists() || !netconfConnectorFeaturesParentDir.isDirectory()) {
 251                 netconfConnectorFeaturesParentDir = checkExistingDir(new File(systemDir, "org/opendaylight/controller/" + featureName), String.format("Karaf distro in %s does not contain netconf-connector features", distroFolder));
 252             }
 253
 254             // Find newest version for features
 255             final File newestVersionDir = Collections.max(
 256                     Lists.newArrayList(netconfConnectorFeaturesParentDir.listFiles(new FileFilter() {
 257                         @Override
 258                         public boolean accept(final File pathname) {
 259                             return pathname.isDirectory();
 260                         }
 261                     })), new Comparator<File>() {
 262                         @Override
 263                         public int compare(final File o1, final File o2) {
 264                             return o1.getName().compareTo(o2.getName());
 265                         }
 266                     });
 267
 268             return Lists.newArrayList(newestVersionDir.listFiles(new FileFilter() {
 269                 @Override
 270                 public boolean accept(final File pathname) {
 271                     return pathname.getName().contains(featureName)
 272                             && Files.getFileExtension(pathname.getName()).equals(suffix);
 273                 }
 274             }));
 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("/" + ORG_OPS4J_PAX_URL_MVN_CFG)), loadOrderCfgFile);
 286                 LOG.info("Load order changed to prefer local bundles/features by rewriting file {}", loadOrderCfgFile);
 287             } catch (IOException e) {
 288                 throw new RuntimeException("Unable to rewrite features file " + loadOrderCfgFile, e);
 289             }
 290         }
 291     }
 292 }