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.collect.ImmutableList;
  14 import com.google.common.util.concurrent.Futures;
  15 import io.netty.util.HashedWheelTimer;
  16 import java.io.Closeable;
  17 import java.io.IOException;
  18 import java.net.InetAddress;
  19 import java.net.ServerSocket;
  20 import java.net.UnknownHostException;
  21 import java.util.ArrayList;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Optional;
  25 import java.util.Set;
  26 import java.util.concurrent.ExecutionException;
  27 import java.util.stream.IntStream;
  28 import org.opendaylight.netconf.api.CapabilityURN;
  29 import org.opendaylight.netconf.server.NetconfServerFactoryImpl;
  30 import org.opendaylight.netconf.server.NetconfServerSessionNegotiatorFactory;
  31 import org.opendaylight.netconf.server.ServerChannelInitializer;
  32 import org.opendaylight.netconf.server.api.SessionIdProvider;
  33 import org.opendaylight.netconf.server.api.monitoring.BasicCapability;
  34 import org.opendaylight.netconf.server.api.monitoring.Capability;
  35 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
  36 import org.opendaylight.netconf.server.api.monitoring.YangModuleCapability;
  37 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  38 import org.opendaylight.netconf.server.impl.DefaultSessionIdProvider;
  39 import org.opendaylight.netconf.server.osgi.AggregatedNetconfOperationServiceFactory;
  40 import org.opendaylight.netconf.shaded.sshd.server.auth.UserAuthFactory;
  41 import org.opendaylight.netconf.shaded.sshd.server.auth.password.UserAuthPasswordFactory;
  42 import org.opendaylight.netconf.shaded.sshd.server.auth.pubkey.UserAuthPublicKeyFactory;
  43 import org.opendaylight.netconf.test.tool.config.Configuration;
  44 import org.opendaylight.netconf.test.tool.customrpc.SettableOperationProvider;
  45 import org.opendaylight.netconf.test.tool.monitoring.NetconfMonitoringOperationServiceFactory;
  46 import org.opendaylight.netconf.test.tool.operations.DefaultOperationsCreator;
  47 import org.opendaylight.netconf.test.tool.operations.OperationsProvider;
  48 import org.opendaylight.netconf.test.tool.rpchandler.SettableOperationRpcProvider;
  49 import org.opendaylight.netconf.test.tool.schemacache.SchemaSourceCache;
  50 import org.opendaylight.netconf.transport.api.TransportStack;
  51 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  52 import org.opendaylight.netconf.transport.ssh.SSHTransportStackFactory;
  53 import org.opendaylight.netconf.transport.ssh.ServerFactoryManagerConfigurator;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.server.rev230417.netconf.server.listen.stack.grouping.transport.ssh.ssh.TcpServerParametersBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.server.rev230417.TcpServerGrouping;
  59 import org.opendaylight.yangtools.yang.common.Revision;
  60 import org.opendaylight.yangtools.yang.common.Uint16;
  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 HashedWheelTimer hashedWheelTimer;
  81     private final Configuration configuration;
  82     private final List<TransportStack> servers;
  83     private final SSHTransportStackFactory sshTransportStackFactory;
  84     private EffectiveModelContext schemaContext;
  85
  86     private boolean sendFakeSchema = false;
  87
  88     public NetconfDeviceSimulator(final Configuration configuration) {
  89         this.configuration = configuration;
  90         this.servers = new ArrayList<>(configuration.getDeviceCount());
  91         this.sshTransportStackFactory = new SSHTransportStackFactory("netconf-device-simulator-threads",
  92             configuration.getThreadPoolSize());
  93         hashedWheelTimer = new HashedWheelTimer();
  94     }
  95
  96     private ServerChannelInitializer createServerChannelInitializer(final Set<Capability> capabilities,
  97             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
  98
  99         final Set<Capability> transformedCapabilities = new HashSet<>(Collections2.transform(capabilities, input -> {
 100             if (sendFakeSchema) {
 101                 sendFakeSchema = false;
 102                 return new FakeCapability((YangModuleCapability) input);
 103             } else {
 104                 return input;
 105             }
 106         }));
 107         transformedCapabilities.add(new BasicCapability(CapabilityURN.CANDIDATE));
 108         final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
 109         final SessionIdProvider idProvider = new DefaultSessionIdProvider();
 110
 111         final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
 112             sourceProvider, transformedCapabilities, monitoringService1, idProvider);
 113
 114         final Set<String> serverCapabilities = configuration.getCapabilities();
 115
 116         final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
 117                 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
 118                 configuration.getGenerateConfigsTimeout(),
 119                 monitoringService1, serverCapabilities);
 120
 121         return new ServerChannelInitializer(serverNegotiatorFactory);
 122     }
 123
 124     private NetconfOperationServiceFactory createOperationServiceFactory(
 125             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider,
 126             final Set<Capability> transformedCapabilities, final NetconfMonitoringService monitoringService1,
 127             final SessionIdProvider idProvider) {
 128         final AggregatedNetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory =
 129             new AggregatedNetconfOperationServiceFactory();
 130
 131         final NetconfOperationServiceFactory operationProvider;
 132         if (configuration.isMdSal()) {
 133             LOG.info("using MdsalOperationProvider.");
 134             operationProvider = new MdsalOperationProvider(
 135                 idProvider, transformedCapabilities, schemaContext, sourceProvider);
 136         } else if (configuration.isXmlConfigurationProvided()) {
 137             LOG.info("using SimulatedOperationProvider.");
 138             operationProvider = new SimulatedOperationProvider(transformedCapabilities,
 139                     Optional.ofNullable(configuration.getNotificationFile()),
 140                     Optional.ofNullable(configuration.getInitialConfigXMLFile()));
 141         } else if (configuration.isNotificationsSupported()) {
 142             LOG.info("using SimulatedOperationProvider.");
 143             operationProvider = new SimulatedOperationProvider(transformedCapabilities,
 144                     Optional.ofNullable(configuration.getNotificationFile()),
 145                     Optional.empty());
 146         } else {
 147             LOG.info("using OperationsProvider.");
 148             operationProvider = new OperationsProvider(transformedCapabilities,
 149                 requireNonNullElseGet(configuration.getOperationsCreator(), DefaultOperationsCreator::new));
 150         }
 151
 152         final NetconfMonitoringOperationServiceFactory monitoringService =
 153                 new NetconfMonitoringOperationServiceFactory(monitoringService1);
 154         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(operationProvider);
 155         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(monitoringService);
 156         if (configuration.getRpcConfigFile() != null) {
 157             final SettableOperationProvider settableService =
 158                     new SettableOperationProvider(configuration.getRpcConfigFile());
 159             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 160         } else {
 161             final SettableOperationRpcProvider settableService =
 162                     new SettableOperationRpcProvider(configuration.getRpcHandler());
 163             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
 164         }
 165         return aggregatedNetconfOperationServiceFactory;
 166     }
 167
 168     public List<Integer> start() {
 169         final var proto = configuration.isSsh() ? "SSH" : "TCP";
 170         LOG.info("Starting {}, {} simulated devices starting on port {}",
 171             configuration.getDeviceCount(), proto, configuration.getStartingPort());
 172
 173         final var schemaRepo = new SharedSchemaRepository("netconf-simulator");
 174         final var capabilities = parseSchemasToModuleCapabilities(schemaRepo);
 175         final var serverChannelInitializer = createServerChannelInitializer(capabilities,
 176             sourceIdentifier -> schemaRepo.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class));
 177         final var serverFactory = new NetconfServerFactoryImpl(serverChannelInitializer, sshTransportStackFactory);
 178
 179         final var ipAddress = getIpAddress(configuration);
 180         final var startingPort = getStartingPort(configuration);
 181         final var deviceCount = configuration.getDeviceCount();
 182         final var ports = IntStream.range(startingPort, Math.min(startingPort + deviceCount, 65536))
 183             .mapToObj(Integer::new).toList();
 184
 185         final var openDevices = new ArrayList<Integer>(ports.size());
 186         final var configurator = configuration.isSsh() ? createServerFactoryManagerConfigurator(configuration) : null;
 187
 188         LOG.debug("Ports: {}", ports);
 189
 190         for (final int port : ports) {
 191             try {
 192                 final var connectParams = connectionParams(ipAddress, port);
 193                 final var serverFuture = configuration.isSsh()
 194                     ? serverFactory.createSshServer(connectParams, null, configurator)
 195                     : serverFactory.createTcpServer(connectParams);
 196                 servers.add(serverFuture.get());
 197                 openDevices.add(port);
 198             } catch (UnsupportedConfigurationException | InterruptedException | ExecutionException e) {
 199                 LOG.error("Could not start {} simulated device on port {}", proto, port, e);
 200                 break;
 201             }
 202         }
 203
 204         final var first = openDevices.get(0);
 205         final var last = openDevices.isEmpty() ? null : openDevices.get(openDevices.size() - 1);
 206         if (openDevices.size() == configuration.getDeviceCount()) {
 207             LOG.info("All simulated devices started successfully from port {} to {}", first, last);
 208         } else if (openDevices.isEmpty()) {
 209             LOG.warn("No simulated devices started.");
 210         } else {
 211             LOG.warn("Not all simulated devices started successfully. Started devices are on ports {} to {}",
 212                 first, last);
 213         }
 214         return openDevices;
 215     }
 216
 217     private static ServerFactoryManagerConfigurator createServerFactoryManagerConfigurator(
 218             final Configuration configuration) {
 219         final var authProvider = configuration.getAuthProvider();
 220         final var publicKeyAuthenticator = configuration.getPublickeyAuthenticator();
 221         return factoryManager -> {
 222             final var authFactoriesListBuilder = ImmutableList.<UserAuthFactory>builder();
 223             authFactoriesListBuilder.add(new UserAuthPasswordFactory());
 224             factoryManager.setPasswordAuthenticator(
 225                 (usr, pass, session) -> authProvider.authenticated(usr, pass));
 226             if (publicKeyAuthenticator != null) {
 227                 final var factory = new UserAuthPublicKeyFactory();
 228                 factory.setSignatureFactories(factoryManager.getSignatureFactories());
 229                 authFactoriesListBuilder.add(factory);
 230                 factoryManager.setPublickeyAuthenticator(publicKeyAuthenticator);
 231             }
 232             factoryManager.setUserAuthFactories(authFactoriesListBuilder.build());
 233             factoryManager.setKeyPairProvider(new VirtualKeyPairProvider());
 234         };
 235     }
 236
 237     private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
 238         final Set<SourceIdentifier> loadedSources = new HashSet<>();
 239         consumer.registerSchemaSourceListener(TextToIRTransformer.create(consumer, consumer));
 240         consumer.registerSchemaSourceListener(new SchemaSourceListener() {
 241             @Override
 242             public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {
 243
 244             }
 245
 246             @Override
 247             public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
 248                 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
 249                     loadedSources.add(potentialSchemaSource.getSourceIdentifier());
 250                 }
 251             }
 252
 253             @Override
 254             public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {
 255
 256             }
 257         });
 258
 259         if (configuration.getSchemasDir() != null) {
 260             LOG.info("Loading models from directory.");
 261             final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
 262                 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
 263             consumer.registerSchemaSourceListener(cache);
 264         } else if (configuration.getModels() != null) {
 265             LOG.info("Loading models from classpath.");
 266             final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
 267                     consumer, YangTextSchemaSource.class, configuration.getModels());
 268             consumer.registerSchemaSourceListener(cache);
 269         } else {
 270             LOG.info("Custom module loading skipped.");
 271         }
 272
 273         configuration.getDefaultYangResources().forEach(r -> {
 274             final SourceIdentifier sourceIdentifier = new SourceIdentifier(r.getModuleName(), r.getRevision());
 275             registerSource(consumer, r.getResourcePath(), sourceIdentifier);
 276         });
 277
 278         try {
 279             //necessary for creating mdsal data stores and operations
 280             schemaContext = consumer.createEffectiveModelContextFactory()
 281                     .createEffectiveModelContext(loadedSources).get();
 282         } catch (final InterruptedException | ExecutionException e) {
 283             throw new IllegalStateException(
 284                 "Cannot parse schema context. Please read stack trace and check YANG files in schema directory.", e);
 285         }
 286
 287         final Set<Capability> capabilities = new HashSet<>();
 288
 289         for (final Module module : schemaContext.getModules()) {
 290             for (final Submodule subModule : module.getSubmodules()) {
 291                 addModuleCapability(consumer, capabilities, subModule);
 292             }
 293             addModuleCapability(consumer, capabilities, module);
 294         }
 295         return capabilities;
 296     }
 297
 298     private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
 299                                             final ModuleLike module) {
 300         final var moduleNamespace = module.getNamespace().toString();
 301         final var moduleName = module.getName();
 302         final var revision = module.getRevision().map(Revision::toString).orElse(null);
 303         final var sourceId = new SourceIdentifier(moduleName, revision);
 304
 305         final String moduleContent;
 306         try {
 307             moduleContent = consumer.getSchemaSource(sourceId, YangTextSchemaSource.class).get().read();
 308         } catch (ExecutionException | InterruptedException | IOException e) {
 309             throw new IllegalStateException(
 310                 "Cannot retrieve schema source for module " + sourceId + " from schema repository", e);
 311         }
 312
 313         capabilities.add(new YangModuleCapability(moduleNamespace, moduleName, revision, moduleContent));
 314     }
 315
 316     private static void registerSource(final SharedSchemaRepository consumer, final String resource,
 317             final SourceIdentifier sourceId) {
 318         consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(
 319             YangTextSchemaSource.forResource(NetconfDeviceSimulator.class, resource)),
 320             PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
 321                 PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 322     }
 323
 324     private static IpAddress getIpAddress(final Configuration configuration) {
 325         try {
 326             return IetfInetUtil.ipAddressFor(InetAddress.getByName(configuration.getIp()));
 327         } catch (final UnknownHostException e) {
 328             throw new IllegalArgumentException("Cannot resolve address " + configuration.getIp(), e);
 329         }
 330     }
 331
 332     private static int getStartingPort(final Configuration configuration) {
 333         final int startingPort = configuration.getStartingPort();
 334         if (startingPort > 0 && startingPort < 65536) {
 335             return startingPort;
 336         }
 337         // find available port
 338         try {
 339             final var socket = new ServerSocket(0);
 340             final int port = socket.getLocalPort();
 341             socket.close();
 342             return port;
 343         } catch (IOException e) {
 344             throw new IllegalStateException("Cannot find available port", e);
 345         }
 346     }
 347
 348     private static TcpServerGrouping connectionParams(final IpAddress address, final int port) {
 349         return new TcpServerParametersBuilder().setLocalAddress(address)
 350             .setLocalPort(new PortNumber(Uint16.valueOf(port))).build();
 351     }
 352
 353     @Override
 354     public void close() {
 355         for (final var server : servers) {
 356             try {
 357                 server.shutdown().get();
 358             } catch (InterruptedException | ExecutionException e) {
 359                 LOG.debug("Exception on simulated device shutdown", e);
 360             }
 361         }
 362         sshTransportStackFactory.close();
 363     }
 364 }