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