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.util.concurrent.Futures;
27 import io.netty.util.concurrent.EventExecutor;
28 import java.net.InetAddress;
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() throws UnknownHostException {
115 remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
116 new InetSocketAddress(InetAddress.getByName("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().setPassword("admin").setUsername("admin").build();
138 final NetconfNode netconfNode = new NetconfNodeBuilder()
139 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
140 .setPort(new PortNumber(9999))
141 .setReconnectOnChangedSchema(true)
142 .setDefaultRequestTimeoutMillis(1000L)
143 .setBetweenAttemptsTimeoutMillis(100)
144 .setSchemaless(false)
146 .setCredentials(credentials)
148 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
150 builder.setNode(node);
153 final NetconfDeviceCommunicator communicator = mock (NetconfDeviceCommunicator.class);
154 final RemoteDeviceHandler salFacade = mock(RemoteDeviceHandler.class);
156 final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
157 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator, salFacade, TIMEOUT,
160 final ActorRef masterRef = mock(ActorRef.class);
162 remoteDeviceConnection.startRemoteDeviceConnection(masterRef);
164 remoteDeviceConnection.stopRemoteDeviceConnection();
166 verify(communicator, times(1)).close();
167 verify(salFacade, times(1)).close();
172 public void testMasterSalFacade() throws UnknownHostException {
173 final ExecutorService executorService = mock(ExecutorService.class);
174 doReturn(executorService).when(processingExecutor).getExecutor();
176 final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
177 final NetconfNode netconfNode = new NetconfNodeBuilder()
178 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
179 .setPort(new PortNumber(9999))
180 .setReconnectOnChangedSchema(true)
181 .setDefaultRequestTimeoutMillis(1000L)
182 .setBetweenAttemptsTimeoutMillis(100)
183 .setSchemaless(false)
185 .setCredentials(credentials)
188 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
189 builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
190 final RemoteDeviceConnectorImpl remoteDeviceConnection =
191 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
193 final ActorRef masterRef = mock(ActorRef.class);
195 final NetconfConnectorDTO connectorDTO =
196 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
198 assertTrue(connectorDTO.getFacade() instanceof MasterSalFacade);
202 public void testKeapAliveFacade() throws UnknownHostException {
203 final ExecutorService executorService = mock(ExecutorService.class);
204 doReturn(executorService).when(processingExecutor).getExecutor();
206 final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
207 final NetconfNode netconfNode = new NetconfNodeBuilder()
208 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
209 .setPort(new PortNumber(9999))
210 .setReconnectOnChangedSchema(true)
211 .setDefaultRequestTimeoutMillis(1000L)
212 .setBetweenAttemptsTimeoutMillis(100)
213 .setSchemaless(false)
215 .setCredentials(credentials)
216 .setKeepaliveDelay(1L)
219 final RemoteDeviceId remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
220 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
221 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
222 builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
224 final RemoteDeviceConnectorImpl remoteDeviceConnection =
225 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
227 final ActorRef masterRef = mock(ActorRef.class);
229 final NetconfConnectorDTO connectorDTO =
230 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
232 assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
236 public void testGetClientConfig() throws UnknownHostException {
237 final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
238 final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
239 final PortNumber portNumber = new PortNumber(9999);
240 final NetconfNode testingNode = new NetconfNodeBuilder()
241 .setConnectionTimeoutMillis(1000L)
242 .setDefaultRequestTimeoutMillis(2000L)
245 .setCredentials(new LoginPasswordBuilder()
246 .setUsername("testuser")
247 .setPassword("testpassword").build())
251 final RemoteDeviceConnectorImpl remoteDeviceConnection =
252 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
254 final NetconfReconnectingClientConfiguration defaultClientConfig =
255 remoteDeviceConnection.getClientConfig(listener, testingNode);
257 assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
258 assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
259 assertSame(defaultClientConfig.getSessionListener(), listener);
260 assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
261 assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);