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 static java.util.Objects.requireNonNullElseGet;
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;
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.CapabilityURN;
38 import org.opendaylight.netconf.northbound.ssh.SshProxyServer;
39 import org.opendaylight.netconf.northbound.ssh.SshProxyServerConfiguration;
40 import org.opendaylight.netconf.northbound.ssh.SshProxyServerConfigurationBuilder;
41 import org.opendaylight.netconf.server.NetconfServerDispatcherImpl;
42 import org.opendaylight.netconf.server.NetconfServerSessionNegotiatorFactory;
43 import org.opendaylight.netconf.server.ServerChannelInitializer;
44 import org.opendaylight.netconf.server.api.SessionIdProvider;
45 import org.opendaylight.netconf.server.api.monitoring.BasicCapability;
46 import org.opendaylight.netconf.server.api.monitoring.Capability;
47 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
48 import org.opendaylight.netconf.server.api.monitoring.YangModuleCapability;
49 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
50 import org.opendaylight.netconf.server.impl.DefaultSessionIdProvider;
51 import org.opendaylight.netconf.server.osgi.AggregatedNetconfOperationServiceFactory;
52 import org.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyPairProvider;
53 import org.opendaylight.netconf.shaded.sshd.common.util.threads.ThreadUtils;
54 import org.opendaylight.netconf.test.tool.config.Configuration;
55 import org.opendaylight.netconf.test.tool.customrpc.SettableOperationProvider;
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.EffectiveModelContext;
63 import org.opendaylight.yangtools.yang.model.api.Module;
64 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
65 import org.opendaylight.yangtools.yang.model.api.Submodule;
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.fs.FilesystemSchemaSourceCache;
70 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
71 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
72 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
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 public class NetconfDeviceSimulator implements Closeable {
79 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSimulator.class);
81 private final NioEventLoopGroup nettyThreadgroup;
82 private final HashedWheelTimer hashedWheelTimer;
83 private final List<Channel> devicesChannels = new ArrayList<>();
84 private final List<SshProxyServer> sshWrappers = new ArrayList<>();
85 private final ScheduledExecutorService minaTimerExecutor;
86 private final ExecutorService nioExecutor;
87 private final Configuration configuration;
88 private EffectiveModelContext schemaContext;
90 private boolean sendFakeSchema = false;
92 public NetconfDeviceSimulator(final Configuration configuration) {
93 this.configuration = configuration;
94 nettyThreadgroup = new NioEventLoopGroup();
95 hashedWheelTimer = new HashedWheelTimer();
96 minaTimerExecutor = Executors.newScheduledThreadPool(configuration.getThreadPoolSize(),
97 new ThreadFactoryBuilder().setNameFormat("netconf-ssh-server-mina-timers-%d").build());
98 nioExecutor = ThreadUtils.newFixedThreadPool("netconf-ssh-server-nio-group", configuration.getThreadPoolSize());
101 private NetconfServerDispatcherImpl createDispatcher(final Set<Capability> capabilities,
102 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
104 final Set<Capability> transformedCapabilities = new HashSet<>(Collections2.transform(capabilities, input -> {
105 if (sendFakeSchema) {
106 sendFakeSchema = false;
107 return new FakeCapability((YangModuleCapability) input);
112 transformedCapabilities.add(new BasicCapability(CapabilityURN.CANDIDATE));
113 final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
114 final SessionIdProvider idProvider = new DefaultSessionIdProvider();
116 final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
117 sourceProvider, transformedCapabilities, monitoringService1, idProvider);
119 final Set<String> serverCapabilities = configuration.getCapabilities();
121 final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
122 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
123 configuration.getGenerateConfigsTimeout(),
124 monitoringService1, serverCapabilities);
126 final ServerChannelInitializer serverChannelInitializer =
127 new ServerChannelInitializer(serverNegotiatorFactory);
128 return new NetconfServerDispatcherImpl(serverChannelInitializer, nettyThreadgroup, nettyThreadgroup);
131 private NetconfOperationServiceFactory createOperationServiceFactory(
132 final SchemaSourceProvider<YangTextSchemaSource> sourceProvider,
133 final Set<Capability> transformedCapabilities, final NetconfMonitoringService monitoringService1,
134 final SessionIdProvider idProvider) {
135 final AggregatedNetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory =
136 new AggregatedNetconfOperationServiceFactory();
138 final NetconfOperationServiceFactory operationProvider;
139 if (configuration.isMdSal()) {
140 LOG.info("using MdsalOperationProvider.");
141 operationProvider = new MdsalOperationProvider(
142 idProvider, transformedCapabilities, schemaContext, sourceProvider);
143 } else if (configuration.isXmlConfigurationProvided()) {
144 LOG.info("using SimulatedOperationProvider.");
145 operationProvider = new SimulatedOperationProvider(transformedCapabilities,
146 Optional.ofNullable(configuration.getNotificationFile()),
147 Optional.ofNullable(configuration.getInitialConfigXMLFile()));
148 } else if (configuration.isNotificationsSupported()) {
149 LOG.info("using SimulatedOperationProvider.");
150 operationProvider = new SimulatedOperationProvider(transformedCapabilities,
151 Optional.ofNullable(configuration.getNotificationFile()),
154 LOG.info("using OperationsProvider.");
155 operationProvider = new OperationsProvider(transformedCapabilities,
156 requireNonNullElseGet(configuration.getOperationsCreator(), DefaultOperationsCreator::new));
159 final NetconfMonitoringOperationServiceFactory monitoringService =
160 new NetconfMonitoringOperationServiceFactory(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 final var proto = configuration.isSsh() ? "SSH" : "TCP";
177 LOG.info("Starting {}, {} simulated devices starting on port {}",
178 configuration.getDeviceCount(), proto, 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 IllegalStateException("Interrupted while waiting for server", 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 IllegalStateException("Interrupted while waiting for server", 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 = new SourceIdentifier(r.getModuleName(), r.getRevision());
326 registerSource(consumer, r.getResourcePath(), sourceIdentifier);
330 //necessary for creating mdsal data stores and operations
331 schemaContext = consumer.createEffectiveModelContextFactory()
332 .createEffectiveModelContext(loadedSources).get();
333 } catch (final InterruptedException | ExecutionException e) {
334 throw new IllegalStateException(
335 "Cannot parse schema context. Please read stack trace and check YANG files in schema directory.", 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 var moduleNamespace = module.getNamespace().toString();
352 final var moduleName = module.getName();
353 final var revision = module.getRevision().map(Revision::toString).orElse(null);
354 final var sourceId = new SourceIdentifier(moduleName, revision);
356 final String moduleContent;
358 moduleContent = consumer.getSchemaSource(sourceId, YangTextSchemaSource.class).get()
359 .asCharSource(StandardCharsets.UTF_8).read();
360 } catch (ExecutionException | InterruptedException | IOException e) {
361 throw new IllegalStateException(
362 "Cannot retrieve schema source for module " + sourceId + " from schema repository", e);
365 capabilities.add(new YangModuleCapability(moduleNamespace, moduleName, revision, moduleContent));
368 private static void registerSource(final SharedSchemaRepository consumer, final String resource,
369 final SourceIdentifier sourceId) {
370 consumer.registerSchemaSource(sourceIdentifier -> Futures.immediateFuture(
371 YangTextSchemaSource.forResource(NetconfDeviceSimulator.class, resource)),
372 PotentialSchemaSource.create(sourceId, YangTextSchemaSource.class,
373 PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
376 private static InetSocketAddress getAddress(final String ip, final int port) {
378 return new InetSocketAddress(Inet4Address.getByName(ip), port);
379 } catch (final UnknownHostException e) {
380 throw new IllegalArgumentException("Cannot resolve address " + ip, e);
385 public void close() {
386 for (final SshProxyServer sshWrapper : sshWrappers) {
389 } catch (final IOException e) {
390 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
393 for (final Channel deviceCh : devicesChannels) {
396 nettyThreadgroup.shutdownGracefully();
397 minaTimerExecutor.shutdownNow();
398 nioExecutor.shutdownNow();