2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.test.tool;
11 import com.google.common.base.MoreObjects.ToStringHelper;
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.Futures;
17 import com.google.common.util.concurrent.ThreadFactoryBuilder;
18 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
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.channels.AsynchronousChannelGroup;
32 import java.util.List;
34 import java.util.concurrent.ExecutionException;
35 import java.util.concurrent.ExecutorService;
36 import java.util.concurrent.Executors;
37 import java.util.concurrent.ScheduledExecutorService;
38 import org.apache.sshd.common.keyprovider.KeyPairProvider;
39 import org.apache.sshd.common.util.threads.ThreadUtils;
40 import org.opendaylight.netconf.api.capability.BasicCapability;
41 import org.opendaylight.netconf.api.capability.Capability;
42 import org.opendaylight.netconf.api.capability.YangModuleCapability;
43 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
44 import org.opendaylight.netconf.impl.NetconfServerDispatcherImpl;
45 import org.opendaylight.netconf.impl.NetconfServerSessionNegotiatorFactory;
46 import org.opendaylight.netconf.impl.ServerChannelInitializer;
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.ssh.SshProxyServer;
51 import org.opendaylight.netconf.ssh.SshProxyServerConfiguration;
52 import org.opendaylight.netconf.ssh.SshProxyServerConfigurationBuilder;
53 import org.opendaylight.netconf.test.tool.config.Configuration;
54 import org.opendaylight.netconf.test.tool.customrpc.SettableOperationProvider;
55 import org.opendaylight.netconf.test.tool.monitoring.NetconfMonitoringOperationService;
56 import org.opendaylight.netconf.test.tool.monitoring.NetconfMonitoringOperationServiceFactory;
57 import org.opendaylight.netconf.test.tool.operations.DefaultOperationsCreator;
58 import org.opendaylight.netconf.test.tool.operations.OperationsProvider;
59 import org.opendaylight.netconf.test.tool.rpchandler.SettableOperationRpcProvider;
60 import org.opendaylight.netconf.test.tool.schemacache.SchemaSourceCache;
61 import org.opendaylight.yangtools.yang.common.Revision;
62 import org.opendaylight.yangtools.yang.model.api.Module;
63 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
64 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
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.spi.PotentialSchemaSource;
69 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
70 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
71 import org.opendaylight.yangtools.yang.model.repo.util.FilesystemSchemaSourceCache;
72 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
73 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.TextToASTTransformer;
74 import org.slf4j.Logger;
75 import org.slf4j.LoggerFactory;
77 @SuppressFBWarnings("DM_DEFAULT_ENCODING")
78 public class NetconfDeviceSimulator implements Closeable {
80 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSimulator.class);
82 private final NioEventLoopGroup nettyThreadgroup;
83 private final HashedWheelTimer hashedWheelTimer;
84 private final List<Channel> devicesChannels = Lists.newArrayList();
85 private final List<SshProxyServer> sshWrappers = Lists.newArrayList();
86 private final ScheduledExecutorService minaTimerExecutor;
87 private final ExecutorService nioExecutor;
88 private final Configuration configuration;
89 private SchemaContext schemaContext;
91 private boolean sendFakeSchema = false;
93 public NetconfDeviceSimulator(final Configuration configuration) {
94 this.configuration = configuration;
95 this.nettyThreadgroup = new NioEventLoopGroup();
96 this.hashedWheelTimer = new HashedWheelTimer();
97 this.minaTimerExecutor = Executors.newScheduledThreadPool(configuration.getThreadPoolSize(),
98 new ThreadFactoryBuilder().setNameFormat("netconf-ssh-server-mina-timers-%d").build());
99 this.nioExecutor = ThreadUtils
100 .newFixedThreadPool("netconf-ssh-server-nio-group", configuration.getThreadPoolSize());
103 private NetconfServerDispatcherImpl createDispatcher(final Set<Capability> capabilities,
104 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
106 final Set<Capability> transformedCapabilities = Sets.newHashSet(Collections2.transform(capabilities, input -> {
107 if (sendFakeSchema) {
108 sendFakeSchema = false;
109 return new FakeCapability((YangModuleCapability) input);
114 transformedCapabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
115 final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
116 final SessionIdProvider idProvider = new SessionIdProvider();
118 final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
119 sourceProvider, transformedCapabilities, monitoringService1, idProvider);
121 final Set<String> serverCapabilities = configuration.getCapabilities();
123 final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
124 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
125 configuration.getGenerateConfigsTimeout(),
126 monitoringService1, serverCapabilities);
128 final ServerChannelInitializer serverChannelInitializer =
129 new ServerChannelInitializer(serverNegotiatorFactory);
130 return new NetconfServerDispatcherImpl(serverChannelInitializer, nettyThreadgroup, nettyThreadgroup);
133 private NetconfOperationServiceFactory createOperationServiceFactory(
134 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider,
135 final Set<Capability> transformedCapabilities, final NetconfMonitoringService monitoringService1,
136 final SessionIdProvider idProvider) {
137 final AggregatedNetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory =
138 new AggregatedNetconfOperationServiceFactory();
140 final NetconfOperationServiceFactory operationProvider;
141 if (configuration.isMdSal()) {
142 LOG.info("using MdsalOperationProvider.");
143 operationProvider = new MdsalOperationProvider(
144 idProvider, transformedCapabilities, schemaContext, sourceProvider);
145 } else if (configuration.isXmlConfigurationProvided()) {
146 LOG.info("using SimulatedOperationProvider.");
147 operationProvider = new SimulatedOperationProvider(idProvider, transformedCapabilities,
148 Optional.fromNullable(configuration.getNotificationFile()),
149 Optional.fromNullable(configuration.getInitialConfigXMLFile()));
151 LOG.info("using OperationsProvider.");
152 operationProvider = new OperationsProvider(idProvider, transformedCapabilities,
153 configuration.getOperationsCreator() != null ? configuration.getOperationsCreator()
154 : DefaultOperationsCreator.getDefaultOperationServiceCreator(idProvider.getCurrentSessionId()));
158 final NetconfMonitoringOperationServiceFactory monitoringService =
159 new NetconfMonitoringOperationServiceFactory(
160 new NetconfMonitoringOperationService(monitoringService1));
161 aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(operationProvider);
162 aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(monitoringService);
163 if (configuration.getRpcConfigFile() != null) {
164 final SettableOperationProvider settableService =
165 new SettableOperationProvider(configuration.getRpcConfigFile());
166 aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
168 final SettableOperationRpcProvider settableService =
169 new SettableOperationRpcProvider(configuration.getRpcHandler());
170 aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
172 return aggregatedNetconfOperationServiceFactory;
175 public List<Integer> start() {
176 LOG.info("Starting {}, {} simulated devices starting on port {}",
177 configuration.getDeviceCount(), configuration.isSsh() ? "SSH" : "TCP", configuration.getStartingPort());
179 final SharedSchemaRepository schemaRepo = new SharedSchemaRepository("netconf-simulator");
180 final Set<Capability> capabilities = parseSchemasToModuleCapabilities(schemaRepo);
182 final NetconfServerDispatcherImpl dispatcher = createDispatcher(capabilities,
183 sourceIdentifier -> schemaRepo.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class));
185 int currentPort = configuration.getStartingPort();
187 final List<Integer> openDevices = Lists.newArrayList();
189 // Generate key to temp folder
190 final KeyPairProvider keyPairProvider = new VirtualKeyPairProvider();
192 final AsynchronousChannelGroup group;
194 group = AsynchronousChannelGroup.withThreadPool(nioExecutor);
195 } catch (final IOException e) {
196 throw new IllegalStateException("Failed to create group", e);
199 for (int i = 0; i < configuration.getDeviceCount(); i++) {
200 if (currentPort > 65535) {
201 LOG.warn("Port cannot be greater than 65535, stopping further attempts.");
204 final InetSocketAddress address = getAddress(configuration.getIp(), currentPort);
206 final ChannelFuture server;
207 if (configuration.isSsh()) {
208 final InetSocketAddress bindingAddress = InetSocketAddress.createUnresolved("0.0.0.0", currentPort);
209 final LocalAddress tcpLocalAddress = new LocalAddress(address.toString());
211 server = dispatcher.createLocalServer(tcpLocalAddress);
213 final SshProxyServer sshServer = new SshProxyServer(
214 minaTimerExecutor, nettyThreadgroup, group);
215 sshServer.bind(getSshConfiguration(bindingAddress, tcpLocalAddress, keyPairProvider));
216 sshWrappers.add(sshServer);
217 } catch (final BindException e) {
218 LOG.warn("Cannot start simulated device on {}, port already in use. Skipping.", address);
219 // Close local server and continue
221 if (server.isDone()) {
222 server.channel().close();
225 } catch (final IOException e) {
226 LOG.warn("Cannot start simulated device on {} due to IOException.", address, e);
234 } catch (final InterruptedException e) {
235 throw new RuntimeException(e);
236 } catch (final ExecutionException e) {
237 LOG.warn("Cannot start ssh simulated device on {}, skipping", address, e);
241 LOG.debug("Simulated SSH device started on {}", address);
244 server = dispatcher.createServer(address);
249 } catch (final InterruptedException e) {
250 throw new RuntimeException(e);
251 } catch (final ExecutionException e) {
252 LOG.warn("Cannot start tcp simulated device on {}, skipping", address, e);
256 LOG.debug("Simulated TCP device started on {}", server.channel().localAddress());
259 devicesChannels.add(server.channel());
260 openDevices.add(currentPort - 1);
263 if (openDevices.size() == configuration.getDeviceCount()) {
264 LOG.info("All simulated devices started successfully from port {} to {}",
265 configuration.getStartingPort(), currentPort - 1);
266 } else if (openDevices.size() == 0) {
267 LOG.warn("No simulated devices started.");
269 LOG.warn("Not all simulated devices started successfully. Started devices ar on ports {}", openDevices);
275 private SshProxyServerConfiguration getSshConfiguration(final InetSocketAddress bindingAddress,
276 final LocalAddress tcpLocalAddress, final KeyPairProvider keyPairProvider) {
277 return new SshProxyServerConfigurationBuilder()
278 .setBindingAddress(bindingAddress)
279 .setLocalAddress(tcpLocalAddress)
280 .setAuthenticator(configuration.getAuthProvider())
281 .setPublickeyAuthenticator(configuration.getPublickeyAuthenticator())
282 .setKeyPairProvider(keyPairProvider)
283 .setIdleTimeout(Integer.MAX_VALUE)
284 .createSshProxyServerConfiguration();
287 private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
288 final Set<SourceIdentifier> loadedSources = Sets.newHashSet();
289 consumer.registerSchemaSourceListener(TextToASTTransformer.create(consumer, consumer));
290 consumer.registerSchemaSourceListener(new SchemaSourceListener() {
292 public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {
297 public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
298 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
299 loadedSources.add(potentialSchemaSource.getSourceIdentifier());
304 public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {
309 if (configuration.getSchemasDir() != null) {
310 LOG.info("Loading models from directory.");
311 final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
312 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
313 consumer.registerSchemaSourceListener(cache);
314 } else if (configuration.getModels() != null) {
315 LOG.info("Loading models from classpath.");
316 final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
317 consumer, YangTextSchemaSource.class, configuration.getModels());
318 consumer.registerSchemaSourceListener(cache);
320 LOG.info("Custom module loading skipped.");
323 configuration.getDefaultYangResources().forEach(r -> {
324 final SourceIdentifier sourceIdentifier = RevisionSourceIdentifier.create(r.getModuleName(),
325 Revision.ofNullable(r.getRevision()));
326 registerSource(consumer, r.getResourcePath(), sourceIdentifier);
330 //necessary for creating mdsal data stores and operations
331 this.schemaContext = consumer.createEffectiveModelContextFactory()
332 .createEffectiveModelContext(loadedSources).get();
333 } catch (final InterruptedException | ExecutionException e) {
334 throw new RuntimeException("Cannot parse schema context", e);
337 final Set<Capability> capabilities = Sets.newHashSet();
339 for (final Module module : schemaContext.getModules()) {
340 for (final Module subModule : module.getSubmodules()) {
341 addModuleCapability(consumer, capabilities, subModule);
343 addModuleCapability(consumer, capabilities, module);
348 private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
349 final Module module) {
350 final SourceIdentifier moduleSourceIdentifier = RevisionSourceIdentifier.create(module.getName(),
351 module.getRevision());
353 final String moduleContent = new String(
354 consumer.getSchemaSource(moduleSourceIdentifier, YangTextSchemaSource.class).get().read());
355 capabilities.add(new YangModuleCapability(module, moduleContent));
356 //IOException would be thrown in creating SchemaContext already
357 } catch (final ExecutionException | InterruptedException | IOException e) {
358 throw new RuntimeException("Cannot retrieve schema source for module "
359 + moduleSourceIdentifier.toString() + " from schema repository", e);
363 private static void registerSource(final SharedSchemaRepository consumer, final String resource,
364 final SourceIdentifier sourceId) {
365 consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(new YangTextSchemaSource(sourceId) {
367 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
368 return toStringHelper;
372 public InputStream openStream() {
373 return getClass().getResourceAsStream(resource);
375 }), PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
376 PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
379 private static InetSocketAddress getAddress(final String ip, final int port) {
381 return new InetSocketAddress(Inet4Address.getByName(ip), port);
382 } catch (final UnknownHostException e) {
383 throw new RuntimeException(e);
388 public void close() {
389 for (final SshProxyServer sshWrapper : sshWrappers) {
392 } catch (final IOException e) {
393 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
396 for (final Channel deviceCh : devicesChannels) {
399 nettyThreadgroup.shutdownGracefully();
400 minaTimerExecutor.shutdownNow();
401 nioExecutor.shutdownNow();