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