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