netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/NetconfDeviceSimulator.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 com.google.common.base.MoreObjects.ToStringHelper;
  12 import com.google.common.base.Optional;
  13 import com.google.common.collect.Collections2;
  14 import com.google.common.collect.Lists;
  15 import com.google.common.collect.Sets;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  18 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  19 import io.netty.channel.Channel;
  20 import io.netty.channel.ChannelFuture;
  21 import io.netty.channel.local.LocalAddress;
  22 import io.netty.channel.nio.NioEventLoopGroup;
  23 import io.netty.util.HashedWheelTimer;
  24 import java.io.Closeable;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.net.BindException;
  28 import java.net.Inet4Address;
  29 import java.net.InetSocketAddress;
  30 import java.net.UnknownHostException;
  31 import java.nio.channels.AsynchronousChannelGroup;
  32 import java.nio.file.Files;
  33 import java.nio.file.Path;
  34 import java.util.List;
  35 import java.util.Set;
  36 import java.util.concurrent.ExecutionException;
  37 import java.util.concurrent.ExecutorService;
  38 import java.util.concurrent.Executors;
  39 import java.util.concurrent.ScheduledExecutorService;
  40 import org.apache.sshd.common.keyprovider.KeyPairProvider;
  41 import org.apache.sshd.common.util.security.SecurityUtils;
  42 import org.apache.sshd.common.util.threads.ThreadUtils;
  43 import org.opendaylight.netconf.api.capability.BasicCapability;
  44 import org.opendaylight.netconf.api.capability.Capability;
  45 import org.opendaylight.netconf.api.capability.YangModuleCapability;
  46 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
  47 import org.opendaylight.netconf.impl.NetconfServerDispatcherImpl;
  48 import org.opendaylight.netconf.impl.NetconfServerSessionNegotiatorFactory;
  49 import org.opendaylight.netconf.impl.ServerChannelInitializer;
  50 import org.opendaylight.netconf.impl.SessionIdProvider;
  51 import org.opendaylight.netconf.impl.osgi.AggregatedNetconfOperationServiceFactory;
  52 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  53 import org.opendaylight.netconf.ssh.SshProxyServer;
  54 import org.opendaylight.netconf.ssh.SshProxyServerConfiguration;
  55 import org.opendaylight.netconf.ssh.SshProxyServerConfigurationBuilder;
  56 import org.opendaylight.netconf.test.tool.config.Configuration;
  57 import org.opendaylight.netconf.test.tool.customrpc.SettableOperationProvider;
  58 import org.opendaylight.netconf.test.tool.monitoring.NetconfMonitoringOperationService;
  59 import org.opendaylight.netconf.test.tool.monitoring.NetconfMonitoringOperationServiceFactory;
  60 import org.opendaylight.netconf.test.tool.operations.DefaultOperationsCreator;
  61 import org.opendaylight.netconf.test.tool.operations.OperationsProvider;
  62 import org.opendaylight.netconf.test.tool.rpchandler.SettableOperationRpcProvider;
  63 import org.opendaylight.netconf.test.tool.schemacache.SchemaSourceCache;
  64 import org.opendaylight.yangtools.yang.common.Revision;
  65 import org.opendaylight.yangtools.yang.model.api.Module;
  66 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  67 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  68 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceFilter;
  69 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
  70 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  71 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  72 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
  73 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
  74 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  75 import org.opendaylight.yangtools.yang.model.repo.util.FilesystemSchemaSourceCache;
  76 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
  77 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.TextToASTTransformer;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81 @SuppressFBWarnings("DM_DEFAULT_ENCODING")
  82 public class NetconfDeviceSimulator implements Closeable {
  83
  84     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSimulator.class);
  85
  86     private final NioEventLoopGroup nettyThreadgroup;
  87     private final HashedWheelTimer hashedWheelTimer;
  88     private final List<Channel> devicesChannels = Lists.newArrayList();
  89     private final List<SshProxyServer> sshWrappers = Lists.newArrayList();
  90     private final ScheduledExecutorService minaTimerExecutor;
  91     private final ExecutorService nioExecutor;
  92     private final Configuration configuration;
  93     private SchemaContext schemaContext;
  94
  95     private boolean sendFakeSchema = false;
  96
  97     public NetconfDeviceSimulator(final Configuration configuration) {
  98         this.configuration = configuration;
  99         this.nettyThreadgroup = new NioEventLoopGroup();
 100         this.hashedWheelTimer = new HashedWheelTimer();
 101         this.minaTimerExecutor = Executors.newScheduledThreadPool(configuration.getThreadPoolSize(),
 102                 new ThreadFactoryBuilder().setNameFormat("netconf-ssh-server-mina-timers-%d").build());
 103         this.nioExecutor = ThreadUtils
 104                 .newFixedThreadPool("netconf-ssh-server-nio-group", configuration.getThreadPoolSize());
 105     }
 106
 107     private NetconfServerDispatcherImpl createDispatcher(final Set<Capability> capabilities,
 108             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
 109
 110         final Set<Capability> transformedCapabilities = Sets.newHashSet(Collections2.transform(capabilities, input -> {
 111             if (sendFakeSchema) {
 112                 sendFakeSchema = false;
 113                 return new FakeCapability((YangModuleCapability) input);
 114             } else {
 115                 return input;
 116             }
 117         }));
 118         transformedCapabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
 119         final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
 120         final SessionIdProvider idProvider = new SessionIdProvider();
 121
 122         final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
 123             sourceProvider, transformedCapabilities, monitoringService1, idProvider);
 124
 125         final Set<String> serverCapabilities = configuration.getCapabilities();
 126
 127         final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
 128                 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
 129                 configuration.getGenerateConfigsTimeout(),
 130                 monitoringService1, serverCapabilities);
 131
 132         final ServerChannelInitializer serverChannelInitializer =
 133             new ServerChannelInitializer(serverNegotiatorFactory);
 134         return new NetconfServerDispatcherImpl(serverChannelInitializer, nettyThreadgroup, nettyThreadgroup);
 135     }
 136
 137     private NetconfOperationServiceFactory createOperationServiceFactory(
 138             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider,
 139             final Set<Capability> transformedCapabilities, final NetconfMonitoringService monitoringService1,
 140             final SessionIdProvider idProvider) {
 141         final AggregatedNetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory =
 142             new AggregatedNetconfOperationServiceFactory();
 143
 144         final NetconfOperationServiceFactory operationProvider;
 145         if (configuration.isMdSal()) {
 146             LOG.info("using MdsalOperationProvider.");
 147             operationProvider = new MdsalOperationProvider(
 148                 idProvider, transformedCapabilities, schemaContext, sourceProvider);
 149         } else if (configuration.isXmlConfigurationProvided()) {
 150             LOG.info("using SimulatedOperationProvider.");
 151             operationProvider = new SimulatedOperationProvider(idProvider, transformedCapabilities,
 152                     Optional.fromNullable(configuration.getNotificationFile()),
 153                     Optional.fromNullable(configuration.getInitialConfigXMLFile()));
 154         } else {
 155             LOG.info("using OperationsProvider.");
 156             operationProvider = new OperationsProvider(idProvider, transformedCapabilities,
 157                 configuration.getOperationsCreator() != null ? configuration.getOperationsCreator()
 158                     : DefaultOperationsCreator.getDefaultOperationServiceCreator(idProvider.getCurrentSessionId()));
 159         }
 160
 161
 162         final NetconfMonitoringOperationServiceFactory monitoringService =
 163                 new NetconfMonitoringOperationServiceFactory(
 164                         new NetconfMonitoringOperationService(monitoringService1));
 165         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(operationProvider);
 166         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(monitoringService);
 167         if (configuration.getRpcConfigFile() != null) {
 168             final SettableOperationProvider settableService =
 169                     new SettableOperationProvider(configuration.getRpcConfigFile());
 170             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 171         } else {
 172             final SettableOperationRpcProvider settableService =
 173                     new SettableOperationRpcProvider(configuration.getRpcHandler());
 174             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 175         }
 176         return aggregatedNetconfOperationServiceFactory;
 177     }
 178
 179     public List<Integer> start() {
 180         LOG.info("Starting {}, {} simulated devices starting on port {}",
 181                 configuration.getDeviceCount(), configuration.isSsh() ? "SSH" : "TCP", configuration.getStartingPort());
 182
 183         final SharedSchemaRepository schemaRepo = new SharedSchemaRepository("netconf-simulator");
 184         final Set<Capability> capabilities = parseSchemasToModuleCapabilities(schemaRepo);
 185
 186         final NetconfServerDispatcherImpl dispatcher = createDispatcher(capabilities,
 187             sourceIdentifier -> schemaRepo.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class));
 188
 189         int currentPort = configuration.getStartingPort();
 190
 191         final List<Integer> openDevices = Lists.newArrayList();
 192
 193         // Generate key to temp folder
 194         final KeyPairProvider keyPairProvider = getPemGeneratorHostKeyProvider();
 195
 196         final AsynchronousChannelGroup group;
 197         try {
 198             group = AsynchronousChannelGroup.withThreadPool(nioExecutor);
 199         } catch (final IOException e) {
 200             throw new IllegalStateException("Failed to create group", e);
 201         }
 202
 203         for (int i = 0; i < configuration.getDeviceCount(); i++) {
 204             if (currentPort > 65535) {
 205                 LOG.warn("Port cannot be greater than 65535, stopping further attempts.");
 206                 break;
 207             }
 208             final InetSocketAddress address = getAddress(configuration.getIp(), currentPort);
 209
 210             final ChannelFuture server;
 211             if (configuration.isSsh()) {
 212                 final InetSocketAddress bindingAddress = InetSocketAddress.createUnresolved("0.0.0.0", currentPort);
 213                 final LocalAddress tcpLocalAddress = new LocalAddress(address.toString());
 214
 215                 server = dispatcher.createLocalServer(tcpLocalAddress);
 216                 try {
 217                     final SshProxyServer sshServer = new SshProxyServer(
 218                         minaTimerExecutor, nettyThreadgroup, group);
 219                     sshServer.bind(getSshConfiguration(bindingAddress, tcpLocalAddress, keyPairProvider));
 220                     sshWrappers.add(sshServer);
 221                 } catch (final BindException e) {
 222                     LOG.warn("Cannot start simulated device on {}, port already in use. Skipping.", address);
 223                     // Close local server and continue
 224                     server.cancel(true);
 225                     if (server.isDone()) {
 226                         server.channel().close();
 227                     }
 228                     continue;
 229                 } catch (final IOException e) {
 230                     LOG.warn("Cannot start simulated device on {} due to IOException.", address, e);
 231                     break;
 232                 } finally {
 233                     currentPort++;
 234                 }
 235
 236                 try {
 237                     server.get();
 238                 } catch (final InterruptedException e) {
 239                     throw new RuntimeException(e);
 240                 } catch (final ExecutionException e) {
 241                     LOG.warn("Cannot start ssh simulated device on {}, skipping", address, e);
 242                     continue;
 243                 }
 244
 245                 LOG.debug("Simulated SSH device started on {}", address);
 246
 247             } else {
 248                 server = dispatcher.createServer(address);
 249                 currentPort++;
 250
 251                 try {
 252                     server.get();
 253                 } catch (final InterruptedException e) {
 254                     throw new RuntimeException(e);
 255                 } catch (final ExecutionException e) {
 256                     LOG.warn("Cannot start tcp simulated device on {}, skipping", address, e);
 257                     continue;
 258                 }
 259
 260                 LOG.debug("Simulated TCP device started on {}", address);
 261             }
 262
 263             devicesChannels.add(server.channel());
 264             openDevices.add(currentPort - 1);
 265         }
 266
 267         if (openDevices.size() == configuration.getDeviceCount()) {
 268             LOG.info("All simulated devices started successfully from port {} to {}",
 269                     configuration.getStartingPort(), currentPort - 1);
 270         } else if (openDevices.size() == 0) {
 271             LOG.warn("No simulated devices started.");
 272         } else {
 273             LOG.warn("Not all simulated devices started successfully. Started devices ar on ports {}", openDevices);
 274         }
 275
 276         return openDevices;
 277     }
 278
 279     private SshProxyServerConfiguration getSshConfiguration(final InetSocketAddress bindingAddress,
 280             final LocalAddress tcpLocalAddress, final KeyPairProvider keyPairProvider) {
 281         return new SshProxyServerConfigurationBuilder()
 282                 .setBindingAddress(bindingAddress)
 283                 .setLocalAddress(tcpLocalAddress)
 284                 .setAuthenticator(configuration.getAuthProvider())
 285                 .setPublickeyAuthenticator(configuration.getPublickeyAuthenticator())
 286                 .setKeyPairProvider(keyPairProvider)
 287                 .setIdleTimeout(Integer.MAX_VALUE)
 288                 .createSshProxyServerConfiguration();
 289     }
 290
 291     private static KeyPairProvider getPemGeneratorHostKeyProvider() {
 292         try {
 293             final Path tempFile = Files.createTempFile("tempKeyNetconfTest", "suffix");
 294             return SecurityUtils.createGeneratorHostKeyProvider(tempFile.toAbsolutePath());
 295         } catch (final IOException e) {
 296             LOG.error("Unable to generate PEM key", e);
 297             throw new RuntimeException(e);
 298         }
 299     }
 300
 301     private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
 302         final Set<SourceIdentifier> loadedSources = Sets.newHashSet();
 303         consumer.registerSchemaSourceListener(TextToASTTransformer.create(consumer, consumer));
 304         consumer.registerSchemaSourceListener(new SchemaSourceListener() {
 305             @Override
 306             public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {}
 307
 308             @Override
 309             public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
 310                 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
 311                     loadedSources.add(potentialSchemaSource.getSourceIdentifier());
 312                 }
 313             }
 314
 315             @Override
 316             public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {}
 317         });
 318
 319         if (configuration.getSchemasDir() != null) {
 320             LOG.info("Loading models from directory.");
 321             final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
 322                 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
 323             consumer.registerSchemaSourceListener(cache);
 324         } else if (configuration.getModels() != null) {
 325             LOG.info("Loading models from classpath.");
 326             final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
 327                     consumer, YangTextSchemaSource.class, configuration.getModels());
 328             consumer.registerSchemaSourceListener(cache);
 329         } else {
 330             LOG.info("Custom module loading skipped.");
 331         }
 332
 333         configuration.getDefaultYangResources().forEach(r -> {
 334             final SourceIdentifier sourceIdentifier = RevisionSourceIdentifier.create(r.getModuleName(),
 335                 Revision.ofNullable(r.getRevision()));
 336             registerSource(consumer, r.getResourcePath(), sourceIdentifier);
 337         });
 338
 339         try {
 340             //necessary for creating mdsal data stores and operations
 341             this.schemaContext = consumer.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT)
 342                 .createSchemaContext(loadedSources).get();
 343         } catch (final InterruptedException | ExecutionException e) {
 344             throw new RuntimeException("Cannot parse schema context", e);
 345         }
 346
 347         final Set<Capability> capabilities = Sets.newHashSet();
 348
 349         for (final Module module : schemaContext.getModules()) {
 350             for (final Module subModule : module.getSubmodules()) {
 351                 addModuleCapability(consumer, capabilities, subModule);
 352             }
 353             addModuleCapability(consumer, capabilities, module);
 354         }
 355         return capabilities;
 356     }
 357
 358     private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
 359                                      final Module module) {
 360         final SourceIdentifier moduleSourceIdentifier = RevisionSourceIdentifier.create(module.getName(),
 361             module.getRevision());
 362         try {
 363             final String moduleContent = new String(
 364                 consumer.getSchemaSource(moduleSourceIdentifier, YangTextSchemaSource.class).get().read());
 365             capabilities.add(new YangModuleCapability(module, moduleContent));
 366             //IOException would be thrown in creating SchemaContext already
 367         } catch (final ExecutionException | InterruptedException | IOException e) {
 368             throw new RuntimeException("Cannot retrieve schema source for module "
 369                 + moduleSourceIdentifier.toString() + " from schema repository", e);
 370         }
 371     }
 372
 373     private static void registerSource(final SharedSchemaRepository consumer, final String resource,
 374                                 final SourceIdentifier sourceId) {
 375         consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(new YangTextSchemaSource(sourceId) {
 376             @Override
 377             protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 378                 return toStringHelper;
 379             }
 380
 381             @Override
 382             public InputStream openStream() {
 383                 return getClass().getResourceAsStream(resource);
 384             }
 385         }), PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
 386             PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 387     }
 388
 389     private static InetSocketAddress getAddress(final String ip, final int port) {
 390         try {
 391             return new InetSocketAddress(Inet4Address.getByName(ip), port);
 392         } catch (final UnknownHostException e) {
 393             throw new RuntimeException(e);
 394         }
 395     }
 396
 397     @Override
 398     public void close() {
 399         for (final SshProxyServer sshWrapper : sshWrappers) {
 400             try {
 401                 sshWrapper.close();
 402             } catch (final IOException e) {
 403                 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
 404             }
 405         }
 406         for (final Channel deviceCh : devicesChannels) {
 407             deviceCh.close();
 408         }
 409         nettyThreadgroup.shutdownGracefully();
 410         minaTimerExecutor.shutdownNow();
 411         nioExecutor.shutdownNow();
 412     }
 413
 414 }