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
8 package org.opendaylight.netconf.topology.singleton.impl;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertSame;
12 import static org.junit.Assert.assertTrue;
13 import static org.mockito.ArgumentMatchers.any;
14 import static org.mockito.ArgumentMatchers.eq;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.mock;
18 import static org.mockito.Mockito.times;
19 import static org.mockito.Mockito.verify;
20 import static org.mockito.MockitoAnnotations.initMocks;
21 import static org.opendaylight.mdsal.common.api.CommitInfo.emptyFluentFuture;
23 import akka.actor.ActorSystem;
24 import akka.util.Timeout;
25 import com.google.common.net.InetAddresses;
26 import com.google.common.util.concurrent.ListeningExecutorService;
27 import io.netty.util.concurrent.EventExecutor;
28 import java.net.InetSocketAddress;
29 import java.util.concurrent.ScheduledExecutorService;
30 import org.junit.Before;
31 import org.junit.Test;
32 import org.mockito.Mock;
33 import org.opendaylight.mdsal.binding.api.DataBroker;
34 import org.opendaylight.mdsal.binding.api.TransactionChain;
35 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
36 import org.opendaylight.mdsal.binding.api.WriteTransaction;
37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
38 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
39 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
40 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
41 import org.opendaylight.netconf.client.NetconfClientDispatcher;
42 import org.opendaylight.netconf.client.NetconfClientSessionListener;
43 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
44 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
45 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
46 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
47 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
48 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
49 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
50 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
51 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
52 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
53 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
65 import org.opendaylight.yangtools.yang.common.Uint16;
66 import scala.concurrent.duration.Duration;
68 public class RemoteDeviceConnectorImplTest {
70 private static final NodeId NODE_ID = new NodeId("testing-node");
71 private static final String TOPOLOGY_ID = "testing-topology";
72 private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
75 private DataBroker dataBroker;
78 private DOMRpcProviderService rpcProviderRegistry;
81 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
84 private ScheduledExecutorService keepaliveExecutor;
87 private ListeningExecutorService processingExecutor;
90 private ActorSystem actorSystem;
93 private EventExecutor eventExecutor;
96 private NetconfClientDispatcher clientDispatcher;
99 private DOMMountPointService mountPointService;
102 private TransactionChain txChain;
105 private WriteTransaction writeTx;
108 private DeviceActionFactory deviceActionFactory;
110 private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
111 private RemoteDeviceId remoteDeviceId;
114 public void setUp() {
117 remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
118 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
120 doReturn(txChain).when(dataBroker).createTransactionChain(any(TransactionChainListener.class));
121 doReturn(writeTx).when(txChain).newWriteOnlyTransaction();
122 doNothing().when(writeTx).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
123 doReturn("Some object").when(writeTx).getIdentifier();
124 doReturn(emptyFluentFuture()).when(writeTx).commit();
125 builder = new NetconfTopologySetup.NetconfTopologySetupBuilder();
126 builder.setDataBroker(dataBroker);
127 builder.setRpcProviderRegistry(rpcProviderRegistry);
128 builder.setClusterSingletonServiceProvider(clusterSingletonServiceProvider);
129 builder.setKeepaliveExecutor(keepaliveExecutor);
130 builder.setProcessingExecutor(processingExecutor);
131 builder.setActorSystem(actorSystem);
132 builder.setEventExecutor(eventExecutor);
133 builder.setNetconfClientDispatcher(clientDispatcher);
134 builder.setTopologyId(TOPOLOGY_ID);
137 @SuppressWarnings("unchecked")
139 public void testStopRemoteDeviceConnection() {
140 final Credentials credentials = new LoginPasswordBuilder()
141 .setPassword("admin").setUsername("admin").build();
142 final NetconfNode netconfNode = new NetconfNodeBuilder()
143 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
144 .setPort(new PortNumber(Uint16.valueOf(9999)))
145 .setReconnectOnChangedSchema(true)
146 .setDefaultRequestTimeoutMillis(1000L)
147 .setBetweenAttemptsTimeoutMillis(100)
148 .setSchemaless(false)
150 .setCredentials(credentials)
152 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
154 builder.setNode(node);
157 final NetconfDeviceCommunicator communicator = mock(NetconfDeviceCommunicator.class);
158 final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
160 final TestingRemoteDeviceConnectorImpl remoteDeviceConnection = new TestingRemoteDeviceConnectorImpl(
161 builder.build(), remoteDeviceId, communicator, deviceActionFactory);
163 remoteDeviceConnection.startRemoteDeviceConnection(salFacade);
165 remoteDeviceConnection.stopRemoteDeviceConnection();
167 verify(communicator, times(1)).close();
168 verify(salFacade, times(1)).close();
172 @SuppressWarnings("unchecked")
174 public void testKeapAliveFacade() {
175 final Credentials credentials = new LoginPasswordBuilder()
176 .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(Uint16.valueOf(9999)))
180 .setReconnectOnChangedSchema(true)
181 .setDefaultRequestTimeoutMillis(1000L)
182 .setBetweenAttemptsTimeoutMillis(100)
183 .setSchemaless(false)
185 .setCredentials(credentials)
186 .setKeepaliveDelay(1L)
189 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
190 builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
192 final RemoteDeviceConnectorImpl remoteDeviceConnection =
193 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, deviceActionFactory);
195 final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
197 final NetconfConnectorDTO connectorDTO =
198 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, salFacade);
200 assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
204 public void testGetClientConfig() {
205 final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
206 final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
207 final PortNumber portNumber = new PortNumber(Uint16.valueOf(9999));
208 final NetconfNode testingNode = new NetconfNodeBuilder()
209 .setConnectionTimeoutMillis(1000L)
210 .setDefaultRequestTimeoutMillis(2000L)
213 .setCredentials(new LoginPasswordBuilder()
214 .setUsername("testuser")
215 .setPassword("testpassword").build())
219 final RemoteDeviceConnectorImpl remoteDeviceConnection =
220 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, deviceActionFactory);
222 final NetconfReconnectingClientConfiguration defaultClientConfig =
223 remoteDeviceConnection.getClientConfig(listener, testingNode);
225 assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
226 assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddresses.forString("127.0.0.1"),
228 assertSame(defaultClientConfig.getSessionListener(), listener);
229 assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
230 assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);