2 * Copyright (c) 2016 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.topology.singleton.impl;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertSame;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.eq;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.times;
20 import static org.mockito.Mockito.verify;
21 import static org.mockito.MockitoAnnotations.initMocks;
23 import akka.actor.ActorRef;
24 import akka.actor.ActorSystem;
25 import akka.util.Timeout;
26 import com.google.common.net.InetAddresses;
27 import com.google.common.util.concurrent.Futures;
28 import io.netty.util.concurrent.EventExecutor;
29 import java.net.InetSocketAddress;
30 import java.net.UnknownHostException;
31 import java.util.concurrent.ExecutorService;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.Mock;
35 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
36 import org.opendaylight.controller.config.threadpool.ThreadPool;
37 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
38 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
39 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
40 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
41 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
42 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
43 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
44 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
45 import org.opendaylight.netconf.client.NetconfClientDispatcher;
46 import org.opendaylight.netconf.client.NetconfClientSessionListener;
47 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
48 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
49 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
50 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
51 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
52 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
53 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
54 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
55 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
67 import scala.concurrent.duration.Duration;
69 public class RemoteDeviceConnectorImplTest {
71 private static final NodeId NODE_ID = new NodeId("testing-node");
72 private static final String TOPOLOGY_ID = "testing-topology";
73 private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
76 private DataBroker dataBroker;
79 private RpcProviderRegistry rpcProviderRegistry;
82 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
85 private ScheduledThreadPool keepaliveExecutor;
88 private ThreadPool processingExecutor;
91 private ActorSystem actorSystem;
94 private EventExecutor eventExecutor;
97 private NetconfClientDispatcher clientDispatcher;
100 private DOMMountPointService mountPointService;
103 private BindingTransactionChain txChain;
106 private WriteTransaction writeTx;
108 private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
109 private RemoteDeviceId remoteDeviceId;
112 public void setUp() {
115 remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
116 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
118 doReturn(txChain).when(dataBroker).createTransactionChain(any(TransactionChainListener.class));
119 doReturn(writeTx).when(txChain).newWriteOnlyTransaction();
120 doNothing().when(writeTx).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
121 doReturn("Some object").when(writeTx).getIdentifier();
122 doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
123 builder = new NetconfTopologySetup.NetconfTopologySetupBuilder();
124 builder.setDataBroker(dataBroker);
125 builder.setRpcProviderRegistry(rpcProviderRegistry);
126 builder.setClusterSingletonServiceProvider(clusterSingletonServiceProvider);
127 builder.setKeepaliveExecutor(keepaliveExecutor);
128 builder.setProcessingExecutor(processingExecutor);
129 builder.setActorSystem(actorSystem);
130 builder.setEventExecutor(eventExecutor);
131 builder.setNetconfClientDispatcher(clientDispatcher);
132 builder.setTopologyId(TOPOLOGY_ID);
136 public void testStopRemoteDeviceConnection() {
137 final Credentials credentials = new LoginPasswordBuilder()
138 .setPassword("admin").setUsername("admin").build();
139 final NetconfNode netconfNode = new NetconfNodeBuilder()
140 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
141 .setPort(new PortNumber(9999))
142 .setReconnectOnChangedSchema(true)
143 .setDefaultRequestTimeoutMillis(1000L)
144 .setBetweenAttemptsTimeoutMillis(100)
145 .setSchemaless(false)
147 .setCredentials(credentials)
149 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
151 builder.setNode(node);
154 final NetconfDeviceCommunicator communicator = mock(NetconfDeviceCommunicator.class);
155 final RemoteDeviceHandler salFacade = mock(RemoteDeviceHandler.class);
157 final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
158 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator, salFacade, TIMEOUT,
161 final ActorRef masterRef = mock(ActorRef.class);
163 remoteDeviceConnection.startRemoteDeviceConnection(masterRef);
165 remoteDeviceConnection.stopRemoteDeviceConnection();
167 verify(communicator, times(1)).close();
168 verify(salFacade, times(1)).close();
173 public void testMasterSalFacade() throws UnknownHostException {
174 final ExecutorService executorService = mock(ExecutorService.class);
175 doReturn(executorService).when(processingExecutor).getExecutor();
177 final Credentials credentials = new LoginPasswordBuilder()
178 .setPassword("admin").setUsername("admin").build();
179 final NetconfNode netconfNode = new NetconfNodeBuilder()
180 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
181 .setPort(new PortNumber(9999))
182 .setReconnectOnChangedSchema(true)
183 .setDefaultRequestTimeoutMillis(1000L)
184 .setBetweenAttemptsTimeoutMillis(100)
185 .setSchemaless(false)
187 .setCredentials(credentials)
190 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
191 builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
192 final RemoteDeviceConnectorImpl remoteDeviceConnection =
193 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
195 final ActorRef masterRef = mock(ActorRef.class);
197 final NetconfConnectorDTO connectorDTO =
198 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
200 assertTrue(connectorDTO.getFacade() instanceof MasterSalFacade);
204 public void testKeapAliveFacade() {
205 final ExecutorService executorService = mock(ExecutorService.class);
206 doReturn(executorService).when(processingExecutor).getExecutor();
208 final Credentials credentials = new LoginPasswordBuilder()
209 .setPassword("admin").setUsername("admin").build();
210 final NetconfNode netconfNode = new NetconfNodeBuilder()
211 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
212 .setPort(new PortNumber(9999))
213 .setReconnectOnChangedSchema(true)
214 .setDefaultRequestTimeoutMillis(1000L)
215 .setBetweenAttemptsTimeoutMillis(100)
216 .setSchemaless(false)
218 .setCredentials(credentials)
219 .setKeepaliveDelay(1L)
222 final RemoteDeviceId remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
223 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
224 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
225 builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
227 final RemoteDeviceConnectorImpl remoteDeviceConnection =
228 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
230 final ActorRef masterRef = mock(ActorRef.class);
232 final NetconfConnectorDTO connectorDTO =
233 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
235 assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
239 public void testGetClientConfig() {
240 final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
241 final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
242 final PortNumber portNumber = new PortNumber(9999);
243 final NetconfNode testingNode = new NetconfNodeBuilder()
244 .setConnectionTimeoutMillis(1000L)
245 .setDefaultRequestTimeoutMillis(2000L)
248 .setCredentials(new LoginPasswordBuilder()
249 .setUsername("testuser")
250 .setPassword("testpassword").build())
254 final RemoteDeviceConnectorImpl remoteDeviceConnection =
255 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
257 final NetconfReconnectingClientConfiguration defaultClientConfig =
258 remoteDeviceConnection.getClientConfig(listener, testingNode);
260 assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
261 assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddresses.forString("127.0.0.1"),
263 assertSame(defaultClientConfig.getSessionListener(), listener);
264 assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
265 assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);