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
8 package org.opendaylight.netconf.test.tool;
10 import com.google.common.base.MoreObjects.ToStringHelper;
11 import com.google.common.collect.Collections2;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ThreadFactoryBuilder;
14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
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.io.InputStream;
23 import java.net.BindException;
24 import java.net.Inet4Address;
25 import java.net.InetSocketAddress;
26 import java.net.UnknownHostException;
27 import java.nio.channels.AsynchronousChannelGroup;
28 import java.util.ArrayList;
29 import java.util.HashSet;
30 import java.util.List;
31 import java.util.Optional;
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.RevisionSourceIdentifier;
66 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
67 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
68 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
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.model.repo.util.FilesystemSchemaSourceCache;
73 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
74 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.TextToIRTransformer;
75 import org.slf4j.Logger;
76 import org.slf4j.LoggerFactory;
78 @SuppressFBWarnings("DM_DEFAULT_ENCODING")
79 public class NetconfDeviceSimulator implements Closeable {
81 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSimulator.class);
83 private final NioEventLoopGroup nettyThreadgroup;
84 private final HashedWheelTimer hashedWheelTimer;
85 private final List<Channel> devicesChannels = new ArrayList<>();
86 private final List<SshProxyServer> sshWrappers = new ArrayList<>();
87 private final ScheduledExecutorService minaTimerExecutor;
88 private final ExecutorService nioExecutor;
89 private final Configuration configuration;
90 private EffectiveModelContext schemaContext;
92 private boolean sendFakeSchema = false;
94 public NetconfDeviceSimulator(final Configuration configuration) {
95 this.configuration = configuration;
96 this.nettyThreadgroup = new NioEventLoopGroup();
97 this.hashedWheelTimer = new HashedWheelTimer();
98 this.minaTimerExecutor = Executors.newScheduledThreadPool(configuration.getThreadPoolSize(),
99 new ThreadFactoryBuilder().setNameFormat("netconf-ssh-server-mina-timers-%d").build());
100 this.nioExecutor = ThreadUtils
101 .newFixedThreadPool("netconf-ssh-server-nio-group", configuration.getThreadPoolSize());
104 private NetconfServerDispatcherImpl createDispatcher(final Set<Capability> capabilities,
105 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
107 final Set<Capability> transformedCapabilities = new HashSet<>(Collections2.transform(capabilities, input -> {
108 if (sendFakeSchema) {
109 sendFakeSchema = false;
110 return new FakeCapability((YangModuleCapability) input);
115 transformedCapabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
116 final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
117 final SessionIdProvider idProvider = new SessionIdProvider();
119 final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
120 sourceProvider, transformedCapabilities, monitoringService1, idProvider);
122 final Set<String> serverCapabilities = configuration.getCapabilities();
124 final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
125 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
126 configuration.getGenerateConfigsTimeout(),
127 monitoringService1, serverCapabilities);
129 final ServerChannelInitializer serverChannelInitializer =
130 new ServerChannelInitializer(serverNegotiatorFactory);
131 return new NetconfServerDispatcherImpl(serverChannelInitializer, nettyThreadgroup, nettyThreadgroup);
134 private NetconfOperationServiceFactory createOperationServiceFactory(
135 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider,
136 final Set<Capability> transformedCapabilities, final NetconfMonitoringService monitoringService1,
137 final SessionIdProvider idProvider) {
138 final AggregatedNetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory =
139 new AggregatedNetconfOperationServiceFactory();
141 final NetconfOperationServiceFactory operationProvider;
142 if (configuration.isMdSal()) {
143 LOG.info("using MdsalOperationProvider.");
144 operationProvider = new MdsalOperationProvider(
145 idProvider, transformedCapabilities, schemaContext, sourceProvider);
146 } else if (configuration.isXmlConfigurationProvided()) {
147 LOG.info("using SimulatedOperationProvider.");
148 operationProvider = new SimulatedOperationProvider(idProvider, transformedCapabilities,
149 Optional.ofNullable(configuration.getNotificationFile()),
150 Optional.ofNullable(configuration.getInitialConfigXMLFile()));
152 LOG.info("using OperationsProvider.");
153 operationProvider = new OperationsProvider(idProvider, transformedCapabilities,
154 configuration.getOperationsCreator() != null ? configuration.getOperationsCreator()
155 : DefaultOperationsCreator.getDefaultOperationServiceCreator(idProvider.getCurrentSessionId()));
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);
169 final SettableOperationRpcProvider settableService =
170 new SettableOperationRpcProvider(configuration.getRpcHandler());
171 aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
173 return aggregatedNetconfOperationServiceFactory;
176 public List<Integer> start() {
177 LOG.info("Starting {}, {} simulated devices starting on port {}",
178 configuration.getDeviceCount(), configuration.isSsh() ? "SSH" : "TCP", configuration.getStartingPort());
180 final SharedSchemaRepository schemaRepo = new SharedSchemaRepository("netconf-simulator");
181 final Set<Capability> capabilities = parseSchemasToModuleCapabilities(schemaRepo);
183 final NetconfServerDispatcherImpl dispatcher = createDispatcher(capabilities,
184 sourceIdentifier -> schemaRepo.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class));
186 int currentPort = configuration.getStartingPort();
188 final List<Integer> openDevices = new ArrayList<>();
190 // Generate key to temp folder
191 final KeyPairProvider keyPairProvider = new VirtualKeyPairProvider();
193 final AsynchronousChannelGroup group;
195 group = AsynchronousChannelGroup.withThreadPool(nioExecutor);
196 } catch (final IOException e) {
197 throw new IllegalStateException("Failed to create group", e);
200 for (int i = 0; i < configuration.getDeviceCount(); i++) {
201 if (currentPort > 65535) {
202 LOG.warn("Port cannot be greater than 65535, stopping further attempts.");
205 final InetSocketAddress address = getAddress(configuration.getIp(), currentPort);
207 final ChannelFuture server;
208 if (configuration.isSsh()) {
209 final InetSocketAddress bindingAddress = InetSocketAddress.createUnresolved("0.0.0.0", currentPort);
210 final LocalAddress tcpLocalAddress = new LocalAddress(address.toString());
212 server = dispatcher.createLocalServer(tcpLocalAddress);
214 final SshProxyServer sshServer = new SshProxyServer(
215 minaTimerExecutor, nettyThreadgroup, group);
216 sshServer.bind(getSshConfiguration(bindingAddress, tcpLocalAddress, keyPairProvider));
217 sshWrappers.add(sshServer);
218 } catch (final BindException e) {
219 LOG.warn("Cannot start simulated device on {}, port already in use. Skipping.", address);
220 // Close local server and continue
222 if (server.isDone()) {
223 server.channel().close();
226 } catch (final IOException e) {
227 LOG.warn("Cannot start simulated device on {} due to IOException.", address, e);
235 } catch (final InterruptedException e) {
236 throw new RuntimeException(e);
237 } catch (final ExecutionException e) {
238 LOG.warn("Cannot start ssh simulated device on {}, skipping", address, e);
242 LOG.debug("Simulated SSH device started on {}", address);
245 server = dispatcher.createServer(address);
250 } catch (final InterruptedException e) {
251 throw new RuntimeException(e);
252 } catch (final ExecutionException e) {
253 LOG.warn("Cannot start tcp simulated device on {}, skipping", address, e);
257 LOG.debug("Simulated TCP device started on {}", server.channel().localAddress());
260 devicesChannels.add(server.channel());
261 openDevices.add(currentPort - 1);
264 if (openDevices.size() == configuration.getDeviceCount()) {
265 LOG.info("All simulated devices started successfully from port {} to {}",
266 configuration.getStartingPort(), currentPort - 1);
267 } else if (openDevices.size() == 0) {
268 LOG.warn("No simulated devices started.");
270 LOG.warn("Not all simulated devices started successfully. Started devices ar on ports {}", openDevices);
276 private SshProxyServerConfiguration getSshConfiguration(final InetSocketAddress bindingAddress,
277 final LocalAddress tcpLocalAddress, final KeyPairProvider keyPairProvider) {
278 return new SshProxyServerConfigurationBuilder()
279 .setBindingAddress(bindingAddress)
280 .setLocalAddress(tcpLocalAddress)
281 .setAuthenticator(configuration.getAuthProvider())
282 .setPublickeyAuthenticator(configuration.getPublickeyAuthenticator())
283 .setKeyPairProvider(keyPairProvider)
284 .setIdleTimeout(Integer.MAX_VALUE)
285 .createSshProxyServerConfiguration();
288 private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
289 final Set<SourceIdentifier> loadedSources = new HashSet<>();
290 consumer.registerSchemaSourceListener(TextToIRTransformer.create(consumer, consumer));
291 consumer.registerSchemaSourceListener(new SchemaSourceListener() {
293 public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {
298 public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
299 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
300 loadedSources.add(potentialSchemaSource.getSourceIdentifier());
305 public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {
310 if (configuration.getSchemasDir() != null) {
311 LOG.info("Loading models from directory.");
312 final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
313 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
314 consumer.registerSchemaSourceListener(cache);
315 } else if (configuration.getModels() != null) {
316 LOG.info("Loading models from classpath.");
317 final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
318 consumer, YangTextSchemaSource.class, configuration.getModels());
319 consumer.registerSchemaSourceListener(cache);
321 LOG.info("Custom module loading skipped.");
324 configuration.getDefaultYangResources().forEach(r -> {
325 final SourceIdentifier sourceIdentifier = RevisionSourceIdentifier.create(r.getModuleName(),
326 Revision.ofNullable(r.getRevision()));
327 registerSource(consumer, r.getResourcePath(), sourceIdentifier);
331 //necessary for creating mdsal data stores and operations
332 this.schemaContext = consumer.createEffectiveModelContextFactory()
333 .createEffectiveModelContext(loadedSources).get();
334 } catch (final InterruptedException | ExecutionException e) {
335 throw new RuntimeException("Cannot parse schema context", e);
338 final Set<Capability> capabilities = new HashSet<>();
340 for (final Module module : schemaContext.getModules()) {
341 for (final Submodule subModule : module.getSubmodules()) {
342 addModuleCapability(consumer, capabilities, subModule);
344 addModuleCapability(consumer, capabilities, module);
349 private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
350 final ModuleLike module) {
351 final SourceIdentifier moduleSourceIdentifier = RevisionSourceIdentifier.create(module.getName(),
352 module.getRevision());
354 final String moduleContent = new String(
355 consumer.getSchemaSource(moduleSourceIdentifier, YangTextSchemaSource.class).get().read());
356 capabilities.add(new YangModuleCapability(module, moduleContent));
357 //IOException would be thrown in creating SchemaContext already
358 } catch (final ExecutionException | InterruptedException | IOException e) {
359 throw new RuntimeException("Cannot retrieve schema source for module "
360 + moduleSourceIdentifier.toString() + " from schema repository", e);
364 private static void registerSource(final SharedSchemaRepository consumer, final String resource,
365 final SourceIdentifier sourceId) {
366 consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(new YangTextSchemaSource(sourceId) {
368 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
369 return toStringHelper;
373 public InputStream openStream() {
374 return getClass().getResourceAsStream(resource);
376 }), PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
377 PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
380 private static InetSocketAddress getAddress(final String ip, final int port) {
382 return new InetSocketAddress(Inet4Address.getByName(ip), port);
383 } catch (final UnknownHostException e) {
384 throw new RuntimeException(e);
389 public void close() {
390 for (final SshProxyServer sshWrapper : sshWrappers) {
393 } catch (final IOException e) {
394 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
397 for (final Channel deviceCh : devicesChannels) {
400 nettyThreadgroup.shutdownGracefully();
401 minaTimerExecutor.shutdownNow();
402 nioExecutor.shutdownNow();