Integrate netconf-mapping-api into netconf-server
[netconf.git] / 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.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.operations.NetconfOperationServiceFactory;
46 import org.opendaylight.netconf.server.impl.DefaultSessionIdProvider;
47 import org.opendaylight.netconf.server.osgi.AggregatedNetconfOperationServiceFactory;
48 import org.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyPairProvider;
49 import org.opendaylight.netconf.shaded.sshd.common.util.threads.ThreadUtils;
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.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;
77
78 public class NetconfDeviceSimulator implements Closeable {
79     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceSimulator.class);
80
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;
89
90     private boolean sendFakeSchema = false;
91
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());
99     }
100
101     private NetconfServerDispatcherImpl createDispatcher(final Set<Capability> capabilities,
102             final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
103
104         final Set<Capability> transformedCapabilities = new HashSet<>(Collections2.transform(capabilities, input -> {
105             if (sendFakeSchema) {
106                 sendFakeSchema = false;
107                 return new FakeCapability((YangModuleCapability) input);
108             } else {
109                 return input;
110             }
111         }));
112         transformedCapabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
113         final NetconfMonitoringService monitoringService1 = new DummyMonitoringService(transformedCapabilities);
114         final SessionIdProvider idProvider = new DefaultSessionIdProvider();
115
116         final NetconfOperationServiceFactory aggregatedNetconfOperationServiceFactory = createOperationServiceFactory(
117             sourceProvider, transformedCapabilities, monitoringService1, idProvider);
118
119         final Set<String> serverCapabilities = configuration.getCapabilities();
120
121         final NetconfServerSessionNegotiatorFactory serverNegotiatorFactory = new TesttoolNegotiationFactory(
122                 hashedWheelTimer, aggregatedNetconfOperationServiceFactory, idProvider,
123                 configuration.getGenerateConfigsTimeout(),
124                 monitoringService1, serverCapabilities);
125
126         final ServerChannelInitializer serverChannelInitializer =
127             new ServerChannelInitializer(serverNegotiatorFactory);
128         return new NetconfServerDispatcherImpl(serverChannelInitializer, nettyThreadgroup, nettyThreadgroup);
129     }
130
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();
137
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(idProvider, 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(idProvider, transformedCapabilities,
151                     Optional.ofNullable(configuration.getNotificationFile()),
152                     Optional.empty());
153         } else {
154             LOG.info("using OperationsProvider.");
155             operationProvider = new OperationsProvider(idProvider, transformedCapabilities,
156                 requireNonNullElseGet(configuration.getOperationsCreator(),
157                     () -> new DefaultOperationsCreator(idProvider.getCurrentSessionId())));
158         }
159
160         final NetconfMonitoringOperationServiceFactory monitoringService =
161                 new NetconfMonitoringOperationServiceFactory(
162                         new NetconfMonitoringOperationService(monitoringService1));
163         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(operationProvider);
164         aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(monitoringService);
165         if (configuration.getRpcConfigFile() != null) {
166             final SettableOperationProvider settableService =
167                     new SettableOperationProvider(configuration.getRpcConfigFile());
168             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
169         } else {
170             final SettableOperationRpcProvider settableService =
171                     new SettableOperationRpcProvider(configuration.getRpcHandler());
172             aggregatedNetconfOperationServiceFactory.onAddNetconfOperationServiceFactory(settableService);
173         }
174         return aggregatedNetconfOperationServiceFactory;
175     }
176
177     public List<Integer> start() {
178         final var proto = configuration.isSsh() ? "SSH" : "TCP";
179         LOG.info("Starting {}, {} simulated devices starting on port {}",
180                 configuration.getDeviceCount(), proto, configuration.getStartingPort());
181
182         final SharedSchemaRepository schemaRepo = new SharedSchemaRepository("netconf-simulator");
183         final Set<Capability> capabilities = parseSchemasToModuleCapabilities(schemaRepo);
184
185         final NetconfServerDispatcherImpl dispatcher = createDispatcher(capabilities,
186             sourceIdentifier -> schemaRepo.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class));
187
188         int currentPort = configuration.getStartingPort();
189
190         final List<Integer> openDevices = new ArrayList<>();
191
192         // Generate key to temp folder
193         final KeyPairProvider keyPairProvider = new VirtualKeyPairProvider();
194
195         final AsynchronousChannelGroup group;
196         try {
197             group = AsynchronousChannelGroup.withThreadPool(nioExecutor);
198         } catch (final IOException e) {
199             throw new IllegalStateException("Failed to create group", e);
200         }
201
202         for (int i = 0; i < configuration.getDeviceCount(); i++) {
203             if (currentPort > 65535) {
204                 LOG.warn("Port cannot be greater than 65535, stopping further attempts.");
205                 break;
206             }
207             final InetSocketAddress address = getAddress(configuration.getIp(), currentPort);
208
209             final ChannelFuture server;
210             if (configuration.isSsh()) {
211                 final InetSocketAddress bindingAddress = InetSocketAddress.createUnresolved("0.0.0.0", currentPort);
212                 final LocalAddress tcpLocalAddress = new LocalAddress(address.toString());
213
214                 server = dispatcher.createLocalServer(tcpLocalAddress);
215                 try {
216                     final SshProxyServer sshServer = new SshProxyServer(
217                         minaTimerExecutor, nettyThreadgroup, group);
218                     sshServer.bind(getSshConfiguration(bindingAddress, tcpLocalAddress, keyPairProvider));
219                     sshWrappers.add(sshServer);
220                 } catch (final BindException e) {
221                     LOG.warn("Cannot start simulated device on {}, port already in use. Skipping.", address);
222                     // Close local server and continue
223                     server.cancel(true);
224                     if (server.isDone()) {
225                         server.channel().close();
226                     }
227                     continue;
228                 } catch (final IOException e) {
229                     LOG.warn("Cannot start simulated device on {} due to IOException.", address, e);
230                     break;
231                 } finally {
232                     currentPort++;
233                 }
234
235                 try {
236                     server.get();
237                 } catch (final InterruptedException e) {
238                     throw new IllegalStateException("Interrupted while waiting for server", e);
239                 } catch (final ExecutionException e) {
240                     LOG.warn("Cannot start ssh simulated device on {}, skipping", address, e);
241                     continue;
242                 }
243
244                 LOG.debug("Simulated SSH device started on {}", address);
245
246             } else {
247                 server = dispatcher.createServer(address);
248                 currentPort++;
249
250                 try {
251                     server.get();
252                 } catch (final InterruptedException e) {
253                     throw new IllegalStateException("Interrupted while waiting for server", e);
254                 } catch (final ExecutionException e) {
255                     LOG.warn("Cannot start tcp simulated device on {}, skipping", address, e);
256                     continue;
257                 }
258
259                 LOG.debug("Simulated TCP device started on {}", server.channel().localAddress());
260             }
261
262             devicesChannels.add(server.channel());
263             openDevices.add(currentPort - 1);
264         }
265
266         if (openDevices.size() == configuration.getDeviceCount()) {
267             LOG.info("All simulated devices started successfully from port {} to {}",
268                     configuration.getStartingPort(), currentPort - 1);
269         } else if (openDevices.size() == 0) {
270             LOG.warn("No simulated devices started.");
271         } else {
272             LOG.warn("Not all simulated devices started successfully. Started devices ar on ports {}", openDevices);
273         }
274
275         return openDevices;
276     }
277
278     private SshProxyServerConfiguration getSshConfiguration(final InetSocketAddress bindingAddress,
279             final LocalAddress tcpLocalAddress, final KeyPairProvider keyPairProvider) {
280         return new SshProxyServerConfigurationBuilder()
281                 .setBindingAddress(bindingAddress)
282                 .setLocalAddress(tcpLocalAddress)
283                 .setAuthenticator(configuration.getAuthProvider())
284                 .setPublickeyAuthenticator(configuration.getPublickeyAuthenticator())
285                 .setKeyPairProvider(keyPairProvider)
286                 .setIdleTimeout(Integer.MAX_VALUE)
287                 .createSshProxyServerConfiguration();
288     }
289
290     private Set<Capability> parseSchemasToModuleCapabilities(final SharedSchemaRepository consumer) {
291         final Set<SourceIdentifier> loadedSources = new HashSet<>();
292         consumer.registerSchemaSourceListener(TextToIRTransformer.create(consumer, consumer));
293         consumer.registerSchemaSourceListener(new SchemaSourceListener() {
294             @Override
295             public void schemaSourceEncountered(final SchemaSourceRepresentation schemaSourceRepresentation) {
296
297             }
298
299             @Override
300             public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> potentialSchemaSources) {
301                 for (final PotentialSchemaSource<?> potentialSchemaSource : potentialSchemaSources) {
302                     loadedSources.add(potentialSchemaSource.getSourceIdentifier());
303                 }
304             }
305
306             @Override
307             public void schemaSourceUnregistered(final PotentialSchemaSource<?> potentialSchemaSource) {
308
309             }
310         });
311
312         if (configuration.getSchemasDir() != null) {
313             LOG.info("Loading models from directory.");
314             final FilesystemSchemaSourceCache<YangTextSchemaSource> cache = new FilesystemSchemaSourceCache<>(
315                 consumer, YangTextSchemaSource.class, configuration.getSchemasDir());
316             consumer.registerSchemaSourceListener(cache);
317         } else if (configuration.getModels() != null) {
318             LOG.info("Loading models from classpath.");
319             final SchemaSourceCache<YangTextSchemaSource> cache = new SchemaSourceCache<>(
320                     consumer, YangTextSchemaSource.class, configuration.getModels());
321             consumer.registerSchemaSourceListener(cache);
322         } else {
323             LOG.info("Custom module loading skipped.");
324         }
325
326         configuration.getDefaultYangResources().forEach(r -> {
327             final SourceIdentifier sourceIdentifier = new SourceIdentifier(r.getModuleName(), r.getRevision());
328             registerSource(consumer, r.getResourcePath(), sourceIdentifier);
329         });
330
331         try {
332             //necessary for creating mdsal data stores and operations
333             schemaContext = consumer.createEffectiveModelContextFactory()
334                     .createEffectiveModelContext(loadedSources).get();
335         } catch (final InterruptedException | ExecutionException e) {
336             throw new IllegalStateException(
337                 "Cannot parse schema context. Please read stack trace and check YANG files in schema directory.", e);
338         }
339
340         final Set<Capability> capabilities = new HashSet<>();
341
342         for (final Module module : schemaContext.getModules()) {
343             for (final Submodule subModule : module.getSubmodules()) {
344                 addModuleCapability(consumer, capabilities, subModule);
345             }
346             addModuleCapability(consumer, capabilities, module);
347         }
348         return capabilities;
349     }
350
351     private static void addModuleCapability(final SharedSchemaRepository consumer, final Set<Capability> capabilities,
352                                             final ModuleLike module) {
353         final var sourceId = new SourceIdentifier(module.getName(),
354             module.getRevision().map(Revision::toString).orElse(null));
355
356         final String moduleContent;
357         try {
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);
363         }
364
365         capabilities.add(new YangModuleCapability(module, moduleContent));
366     }
367
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()));
374     }
375
376     private static InetSocketAddress getAddress(final String ip, final int port) {
377         try {
378             return new InetSocketAddress(Inet4Address.getByName(ip), port);
379         } catch (final UnknownHostException e) {
380             throw new IllegalArgumentException("Cannot resolve address " + ip, e);
381         }
382     }
383
384     @Override
385     public void close() {
386         for (final SshProxyServer sshWrapper : sshWrappers) {
387             try {
388                 sshWrapper.close();
389             } catch (final IOException e) {
390                 LOG.debug("Wrapper {} failed to close", sshWrapper, e);
391             }
392         }
393         for (final Channel deviceCh : devicesChannels) {
394             deviceCh.close();
395         }
396         nettyThreadgroup.shutdownGracefully();
397         minaTimerExecutor.shutdownNow();
398         nioExecutor.shutdownNow();
399     }
400 }