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