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