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