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 if (configuration.isNotificationsSupported()) {
 148             LOG.info("using SimulatedOperationProvider.");
 149             operationProvider = new SimulatedOperationProvider(idProvider, transformedCapabilities,
 150                     Optional.ofNullable(configuration.getNotificationFile()),
 151                     Optional.empty());
 152         } else {
 153             LOG.info("using OperationsProvider.");
 154             operationProvider = new OperationsProvider(idProvider, transformedCapabilities,
 155                 requireNonNullElseGet(configuration.getOperationsCreator(),
 156                     () -> new DefaultOperationsCreator(idProvider.getCurrentSessionId())));
 157         }
 158
 159         final NetconfMonitoringOperationServiceFactory monitoringService =
 160                 new NetconfMonitoringOperationServiceFactory(
 161                         new NetconfMonitoringOperationService(monitoringService1));
 162         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(operationProvider);
 163         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(monitoringService);
 164         if (configuration.getRpcConfigFile() != null) {
 165             final SettableOperationProvider settableService =
 166                     new SettableOperationProvider(configuration.getRpcConfigFile());
 167             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 168         } else {
 169             final SettableOperationRpcProvider settableService =
 170                     new SettableOperationRpcProvider(configuration.getRpcHandler());
 171             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 172         }
 173         return aggregatedNetconfOperationServiceFactory;
 174     }
 175
 176     public List<Integer> start() {
 177         final var proto = configuration.isSsh() ? "SSH" : "TCP";
 178         LOG.info("Starting {}, {} simulated devices starting on port {}",
 179                 configuration.getDeviceCount(), proto, 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 = new ArrayList<>();
 190
 191         // Generate key to temp folder
 192         final KeyPairProvider keyPairProvider = new VirtualKeyPairProvider();
 193
 194         final AsynchronousChannelGroup group;
 195         try {
 196             group = AsynchronousChannelGroup.withThreadPool(nioExecutor);
 197         } catch (final IOException e) {
 198             throw new IllegalStateException("Failed to create group", e);
 199         }
 200
 201         for (int i = 0; i < configuration.getDeviceCount(); i++) {
 202             if (currentPort > 65535) {
 203                 LOG.warn("Port cannot be greater than 65535, stopping further attempts.");
 204                 break;
 205             }
 206             final InetSocketAddress address = getAddress(configuration.getIp(), currentPort);
 207
 208             final ChannelFuture server;
 209             if (configuration.isSsh()) {
 210                 final InetSocketAddress bindingAddress = InetSocketAddress.createUnresolved("0.0.0.0", currentPort);
 211                 final LocalAddress tcpLocalAddress = new LocalAddress(address.toString());
 212
 213                 server = dispatcher.createLocalServer(tcpLocalAddress);
 214                 try {
 215                     final SshProxyServer sshServer = new SshProxyServer(
 216                         minaTimerExecutor, nettyThreadgroup, group);
 217                     sshServer.bind(getSshConfiguration(bindingAddress, tcpLocalAddress, keyPairProvider));
 218                     sshWrappers.add(sshServer);
 219                 } catch (final BindException e) {
 220                     LOG.warn("Cannot start simulated device on {}, port already in use. Skipping.", address);
 221                     // Close local server and continue
 222                     server.cancel(true);
 223                     if (server.isDone()) {
 224                         server.channel().close();
 225                     }
 226                     continue;
 227                 } catch (final IOException e) {
 228                     LOG.warn("Cannot start simulated device on {} due to IOException.", address, e);
 229                     break;
 230                 } finally {
 231                     currentPort++;
 232                 }
 233
 234                 try {
 235                     server.get();
 236                 } catch (final InterruptedException e) {
 237                     throw new IllegalStateException("Interrupted while waiting for server", e);
 238                 } catch (final ExecutionException e) {
 239                     LOG.warn("Cannot start ssh simulated device on {}, skipping", address, e);
 240                     continue;
 241                 }
 242
 243                 LOG.debug("Simulated SSH device started on {}", address);
 244
 245             } else {
 246                 server = dispatcher.createServer(address);
 247                 currentPort++;
 248
 249                 try {
 250                     server.get();
 251                 } catch (final InterruptedException e) {
 252                     throw new IllegalStateException("Interrupted while waiting for server", e);
 253                 } catch (final ExecutionException e) {
 254                     LOG.warn("Cannot start tcp simulated device on {}, skipping", address, e);
 255                     continue;
 256                 }
 257
 258                 LOG.debug("Simulated TCP device started on {}", server.channel().localAddress());
 259             }
 260
 261             devicesChannels.add(server.channel());
 262             openDevices.add(currentPort - 1);
 263         }
 264
 265         if (openDevices.size() == configuration.getDeviceCount()) {
 266             LOG.info("All simulated devices started successfully from port {} to {}",
 267                     configuration.getStartingPort(), currentPort - 1);
 268         } else if (openDevices.size() == 0) {
 269             LOG.warn("No simulated devices started.");
 270         } else {
 271             LOG.warn("Not all simulated devices started successfully. Started devices ar on ports {}", openDevices);
 272         }
 273
 274         return openDevices;
 275     }
 276
 277     private SshProxyServerConfiguration getSshConfiguration(final InetSocketAddress bindingAddress,
 278             final LocalAddress tcpLocalAddress, final KeyPairProvider keyPairProvider) {
 279         return new SshProxyServerConfigurationBuilder()
 280                 .setBindingAddress(bindingAddress)
 281                 .setLocalAddress(tcpLocalAddress)
 282                 .setAuthenticator(configuration.getAuthProvider())
 283                 .setPublickeyAuthenticator(configuration.getPublickeyAuthenticator())
 284                 .setKeyPairProvider(keyPairProvider)
 285                 .setIdleTimeout(Integer.MAX_VALUE)
 286                 .createSshProxyServerConfiguration();
 287     }
 288
 289     private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
 290         final Set<SourceIdentifier> loadedSources = new HashSet<>();
 291         consumer.registerSchemaSourceListener(TextToIRTransformer.create(consumer, consumer));
 292         consumer.registerSchemaSourceListener(new SchemaSourceListener() {
 293             @Override
 294             public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {
 295
 296             }
 297
 298             @Override
 299             public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
 300                 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
 301                     loadedSources.add(potentialSchemaSource.getSourceIdentifier());
 302                 }
 303             }
 304
 305             @Override
 306             public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {
 307
 308             }
 309         });
 310
 311         if (configuration.getSchemasDir() != null) {
 312             LOG.info("Loading models from directory.");
 313             final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
 314                 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
 315             consumer.registerSchemaSourceListener(cache);
 316         } else if (configuration.getModels() != null) {
 317             LOG.info("Loading models from classpath.");
 318             final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
 319                     consumer, YangTextSchemaSource.class, configuration.getModels());
 320             consumer.registerSchemaSourceListener(cache);
 321         } else {
 322             LOG.info("Custom module loading skipped.");
 323         }
 324
 325         configuration.getDefaultYangResources().forEach(r -> {
 326             final SourceIdentifier sourceIdentifier = new SourceIdentifier(r.getModuleName(), r.getRevision());
 327             registerSource(consumer, r.getResourcePath(), sourceIdentifier);
 328         });
 329
 330         try {
 331             //necessary for creating mdsal data stores and operations
 332             schemaContext = consumer.createEffectiveModelContextFactory()
 333                     .createEffectiveModelContext(loadedSources).get();
 334         } catch (final InterruptedException | ExecutionException e) {
 335             throw new IllegalStateException(
 336                 "Cannot parse schema context. Please read stack trace and check YANG files in schema directory.", e);
 337         }
 338
 339         final Set<Capability> capabilities = new HashSet<>();
 340
 341         for (final Module module : schemaContext.getModules()) {
 342             for (final Submodule subModule : module.getSubmodules()) {
 343                 addModuleCapability(consumer, capabilities, subModule);
 344             }
 345             addModuleCapability(consumer, capabilities, module);
 346         }
 347         return capabilities;
 348     }
 349
 350     private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
 351                                             final ModuleLike module) {
 352         final var sourceId = new SourceIdentifier(module.getName(),
 353             module.getRevision().map(Revision::toString).orElse(null));
 354
 355         final String moduleContent;
 356         try {
 357             moduleContent = consumer.getSchemaSource(sourceId, YangTextSchemaSource.class).get()
 358                 .asCharSource(StandardCharsets.UTF_8).read();
 359         } catch (ExecutionException | InterruptedException | IOException e) {
 360             throw new IllegalStateException(
 361                 "Cannot retrieve schema source for module " + sourceId + " from schema repository", e);
 362         }
 363
 364         capabilities.add(new YangModuleCapability(module, moduleContent));
 365     }
 366
 367     private static void registerSource(final SharedSchemaRepository consumer, final String resource,
 368             final SourceIdentifier sourceId) {
 369         consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(
 370             YangTextSchemaSource.forResource(NetconfDeviceSimulator.class, resource)),
 371             PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
 372                 PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 373     }
 374
 375     private static InetSocketAddress getAddress(final String ip, final int port) {
 376         try {
 377             return new InetSocketAddress(Inet4Address.getByName(ip), port);
 378         } catch (final UnknownHostException e) {
 379             throw new IllegalArgumentException("Cannot resolve address " + ip, e);
 380         }
 381     }
 382
 383     @Override
 384     public void close() {
 385         for (final SshProxyServer sshWrapper : sshWrappers) {
 386             try {
 387                 sshWrapper.close();
 388             } catch (final IOException e) {
 389                 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
 390             }
 391         }
 392         for (final Channel deviceCh : devicesChannels) {
 393             deviceCh.close();
 394         }
 395         nettyThreadgroup.shutdownGracefully();
 396         minaTimerExecutor.shutdownNow();
 397         nioExecutor.shutdownNow();
 398     }
 399
 400 }