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;
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.junit.Assert.fail;
15 import static org.mockito.Matchers.any;
16 import static org.mockito.Mockito.mock;
17 import static org.mockito.Mockito.verify;
18 import static org.mockito.Mockito.when;
20 import akka.actor.ActorContext;
21 import akka.actor.ActorRef;
22 import com.google.common.util.concurrent.ListenableFuture;
23 import com.google.common.util.concurrent.MoreExecutors;
24 import io.netty.util.concurrent.EventExecutor;
25 import io.netty.util.concurrent.Future;
26 import io.netty.util.concurrent.ImmediateEventExecutor;
27 import io.netty.util.concurrent.SucceededFuture;
28 import java.net.InetAddress;
29 import java.net.InetSocketAddress;
30 import java.net.UnknownHostException;
31 import java.util.concurrent.ExecutionException;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.Mock;
35 import org.mockito.MockitoAnnotations;
36 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
37 import org.opendaylight.controller.config.threadpool.ThreadPool;
38 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
39 import org.opendaylight.controller.sal.core.api.Broker;
40 import org.opendaylight.netconf.client.NetconfClientDispatcher;
41 import org.opendaylight.netconf.client.NetconfClientSessionListener;
42 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
43 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
44 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
45 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
46 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
47 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
48 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
49 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
50 import org.opendaylight.netconf.topology.pipeline.TopologyMountPointFacade;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Host;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
61 import org.opendaylight.yangtools.yang.binding.DataContainer;
62 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
64 public class AbstractNetconfTopologyTest {
66 private static final NodeId NODE_ID = new NodeId("testing-node");
67 private static final String TOPOLOGY_ID = "testing-topology";
70 private Broker mockedDataBroker;
73 private NetconfClientDispatcher mockedClientDispatcher;
76 private BindingAwareBroker mockedBindingAwareBroker;
79 private EventExecutor mockedEventExecutor;
82 private ScheduledThreadPool mockedKeepaliveExecutor;
85 private ThreadPool mockedProcessingExecutor;
88 private SchemaRepositoryProvider mockedSchemaRepositoryProvider;
91 private TestingAbstractNetconfTopology topology;
95 MockitoAnnotations.initMocks(this);
97 when(mockedSchemaRepositoryProvider.getSharedSchemaRepository()).thenReturn(new SharedSchemaRepository("testingSharedSchemaRepo"));
98 when(mockedProcessingExecutor.getExecutor()).thenReturn(MoreExecutors.newDirectExecutorService());
99 Future<Void> future = new SucceededFuture<>(ImmediateEventExecutor.INSTANCE, null);
100 when(mockedClientDispatcher.createReconnectingClient(any(NetconfReconnectingClientConfiguration.class))).thenReturn(future);
102 topology = new TestingAbstractNetconfTopology(TOPOLOGY_ID, mockedClientDispatcher, mockedBindingAwareBroker,
103 mockedDataBroker, mockedEventExecutor, mockedKeepaliveExecutor, mockedProcessingExecutor, mockedSchemaRepositoryProvider);
107 public void testCreateSalFacade() {
108 NetconfNode testingNode = new NetconfNodeBuilder()
109 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
110 .setPort(new PortNumber(9999))
111 .setReconnectOnChangedSchema(true)
112 .setDefaultRequestTimeoutMillis(1000L)
113 .setBetweenAttemptsTimeoutMillis(100)
116 AbstractNetconfTopology.NetconfConnectorDTO connectorDTO = topology.createDeviceCommunicator(NODE_ID, testingNode);
117 assertSame(connectorDTO.getFacade(), topology.getFacade());
121 public void testCreateKeepAliveSalFacade() {
122 NetconfNode testingNode = new NetconfNodeBuilder()
123 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
124 .setPort(new PortNumber(9999))
125 .setReconnectOnChangedSchema(true)
126 .setDefaultRequestTimeoutMillis(1000L)
127 .setBetweenAttemptsTimeoutMillis(100)
128 .setKeepaliveDelay(1L)
131 AbstractNetconfTopology.NetconfConnectorDTO connectorDTO = topology.createDeviceCommunicator(NODE_ID, testingNode);
132 assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
136 public void testSetupSchemaResourceDTO() {
137 NetconfNode testingNode = new NetconfNodeBuilder()
138 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
139 .setPort(new PortNumber(9999))
140 .setReconnectOnChangedSchema(true)
141 .setDefaultRequestTimeoutMillis(1000L)
142 .setBetweenAttemptsTimeoutMillis(100)
143 .setKeepaliveDelay(1000L).build();
145 NetconfDevice.SchemaResourcesDTO resultDTO = topology.setupSchemaCacheDTO(NODE_ID, testingNode);
146 SharedSchemaRepository repo = (SharedSchemaRepository) resultDTO.getSchemaRegistry();
147 assertEquals(repo.getIdentifier(), "sal-netconf-connector");
149 testingNode = new NetconfNodeBuilder()
150 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
151 .setPort(new PortNumber(9999))
152 .setReconnectOnChangedSchema(true)
153 .setDefaultRequestTimeoutMillis(1000L)
154 .setBetweenAttemptsTimeoutMillis(100)
155 .setKeepaliveDelay(1000L)
156 .setSchemaCacheDirectory("test-directory")
159 resultDTO = topology.setupSchemaCacheDTO(NODE_ID, testingNode);
160 repo = (SharedSchemaRepository) resultDTO.getSchemaRegistry();
161 assertEquals(repo.getIdentifier(), "test-directory");
165 public void testGetClientConfig() throws UnknownHostException {
166 NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
167 Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
168 PortNumber portNumber = new PortNumber(9999);
169 NetconfNode testingNode = new NetconfNodeBuilder()
170 .setConnectionTimeoutMillis(1000L)
171 .setDefaultRequestTimeoutMillis(2000L)
174 .setCredentials(new LoginPasswordBuilder().setUsername("testuser").setPassword("testpassword").build())
177 NetconfReconnectingClientConfiguration defaultClientConfig = topology.getClientConfig(listener, testingNode);
179 assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
180 assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
181 assertSame(defaultClientConfig.getSessionListener(), listener);
182 assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
183 assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
187 public void testGetClientConfigNotSupportedCredentialsFail() {
188 NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
189 Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
190 PortNumber portNumber = new PortNumber(9999);
192 Credentials notSupportedCredentials = new Credentials() {
194 public Class<? extends DataContainer> getImplementedInterface() {
195 return Credentials.class;
199 NetconfNode testingNode = new NetconfNodeBuilder()
200 .setConnectionTimeoutMillis(1000L)
201 .setDefaultRequestTimeoutMillis(2000L)
204 .setCredentials(notSupportedCredentials)
208 topology.getClientConfig(listener, testingNode);
209 fail("Exception expected here.");
210 } catch(Exception e) {
211 assertTrue(e instanceof IllegalStateException);
216 public void testConnectNode() {
217 NetconfNode testingNode = new NetconfNodeBuilder()
218 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
219 .setPort(new PortNumber(9999))
220 .setReconnectOnChangedSchema(true)
221 .setDefaultRequestTimeoutMillis(1000L)
222 .setBetweenAttemptsTimeoutMillis(100)
223 .setKeepaliveDelay(1000L)
225 .setCredentials(new LoginPasswordBuilder().setUsername("testuser").setPassword("testpassword").build())
227 Node nd = mock(Node.class);
228 when(nd.getAugmentation(NetconfNode.class)).thenReturn(testingNode);
229 topology.connectNode(NODE_ID, nd);
230 assertTrue(topology.activeConnectors.containsKey(NODE_ID));
234 public void testDisconnectNode() {
235 NetconfNode testingNode = new NetconfNodeBuilder()
236 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
237 .setPort(new PortNumber(9999))
238 .setReconnectOnChangedSchema(true)
239 .setDefaultRequestTimeoutMillis(1000L)
240 .setBetweenAttemptsTimeoutMillis(100)
241 .setKeepaliveDelay(1000L)
243 .setCredentials(new LoginPasswordBuilder().setUsername("testuser").setPassword("testpassword").build())
245 Node nd = mock(Node.class);
246 when(nd.getAugmentation(NetconfNode.class)).thenReturn(testingNode);
247 topology.connectNode(NODE_ID, nd);
248 assertTrue(topology.activeConnectors.containsKey(NODE_ID));
249 assertTrue(topology.disconnectNode(NODE_ID).isDone());
250 assertTrue(!topology.activeConnectors.containsKey(NODE_ID));
251 verify(topology.getFacade()).close();
255 public void testDisconnectNotConnectedNode() throws ExecutionException, InterruptedException {
256 ListenableFuture disconnectFuture = topology.disconnectNode(NODE_ID);
257 assertTrue(disconnectFuture.isDone());
259 disconnectFuture.get();
260 fail("Exception expected!");
261 } catch(Exception e) {
262 assertTrue(e instanceof ExecutionException);
263 assertTrue(e.getCause() instanceof IllegalStateException);
267 public static class TestingAbstractNetconfTopology extends AbstractNetconfTopology {
269 private RemoteDeviceHandler salFacade;
271 protected TestingAbstractNetconfTopology(String topologyId, NetconfClientDispatcher clientDispatcher,
272 BindingAwareBroker bindingAwareBroker, Broker domBroker,
273 EventExecutor eventExecutor, ScheduledThreadPool keepaliveExecutor,
274 ThreadPool processingExecutor,
275 SchemaRepositoryProvider schemaRepositoryProvider) {
276 super(topologyId, clientDispatcher, bindingAwareBroker, domBroker, eventExecutor, keepaliveExecutor, processingExecutor, schemaRepositoryProvider);
277 salFacade = mock(RemoteDeviceHandler.class);
280 public RemoteDeviceHandler<NetconfSessionPreferences> getFacade() {
285 public void onSessionInitiated(BindingAwareBroker.ProviderContext session) {
290 protected RemoteDeviceHandler<NetconfSessionPreferences> createSalFacade(RemoteDeviceId id, Broker domBroker, BindingAwareBroker bindingBroker, long defaultRequestTimeoutMillis) {
295 public TopologyMountPointFacade.ConnectionStatusListenerRegistration registerConnectionStatusListener(NodeId node, RemoteDeviceHandler<NetconfSessionPreferences> listener) {
300 public void registerMountPoint(ActorContext context, NodeId nodeId) {
305 public void registerMountPoint(ActorContext context, NodeId nodeId, ActorRef masterRef) {
310 public void unregisterMountPoint(NodeId nodeId) {