netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/RemoteDeviceConnectorImplTest.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.netconf.topology.singleton.impl;
  10
  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.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.times;
  17 import static org.mockito.Mockito.verify;
  18 import static org.mockito.MockitoAnnotations.initMocks;
  19
  20 import akka.actor.ActorRef;
  21 import akka.actor.ActorSystem;
  22 import io.netty.util.concurrent.EventExecutor;
  23 import java.net.InetAddress;
  24 import java.net.InetSocketAddress;
  25 import java.net.UnknownHostException;
  26 import java.util.concurrent.ExecutorService;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.mockito.Mock;
  30 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  31 import org.opendaylight.controller.config.threadpool.ThreadPool;
  32 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  33 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  34 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  35 import org.opendaylight.controller.sal.core.api.Broker;
  36 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  37 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  38 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  39 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  40 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  41 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  42 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  43 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
  44 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  45 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
  46 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  58
  59 public class RemoteDeviceConnectorImplTest {
  60
  61     private static final NodeId NODE_ID = new NodeId("testing-node");
  62     private static final String TOPOLOGY_ID = "testing-topology";
  63
  64     @Mock
  65     private DataBroker dataBroker;
  66
  67     @Mock
  68     private RpcProviderRegistry rpcProviderRegistry;
  69
  70     @Mock
  71     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  72
  73     @Mock
  74     private BindingAwareBroker bindingAwareBroker;
  75
  76     @Mock
  77     private ScheduledThreadPool keepaliveExecutor;
  78
  79     @Mock
  80     private ThreadPool processingExecutor;
  81
  82     @Mock
  83     private Broker domBroker;
  84
  85     @Mock
  86     private ActorSystem actorSystem;
  87
  88     @Mock
  89     private EventExecutor eventExecutor;
  90
  91     @Mock
  92     private NetconfClientDispatcher clientDispatcher;
  93
  94     private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
  95     private RemoteDeviceId remoteDeviceId;
  96
  97     @Before
  98     public void setUp() throws UnknownHostException {
  99         initMocks(this);
 100
 101         remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 102                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 103
 104         builder = new NetconfTopologySetup.NetconfTopologySetupBuilder();
 105         builder.setDataBroker(dataBroker);
 106         builder.setRpcProviderRegistry(rpcProviderRegistry);
 107         builder.setClusterSingletonServiceProvider(clusterSingletonServiceProvider);
 108         builder.setBindingAwareBroker(bindingAwareBroker);
 109         builder.setKeepaliveExecutor(keepaliveExecutor);
 110         builder.setProcessingExecutor(processingExecutor);
 111         builder.setDomBroker(domBroker);
 112         builder.setActorSystem(actorSystem);
 113         builder.setEventExecutor(eventExecutor);
 114         builder.setNetconfClientDispatcher(clientDispatcher);
 115         builder.setTopologyId(TOPOLOGY_ID);
 116
 117     }
 118
 119     @Test
 120     public void testStopRemoteDeviceConnection() {
 121         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 122         final NetconfNode netconfNode = 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                 .setSchemaless(false)
 129                 .setTcpOnly(false)
 130                 .setCredentials(credentials)
 131                 .build();
 132         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 133
 134         builder.setNode(node);
 135
 136
 137         final NetconfDeviceCommunicator communicator = mock (NetconfDeviceCommunicator.class);
 138         final RemoteDeviceHandler salFacade = mock(RemoteDeviceHandler.class);
 139
 140         final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
 141                 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator, salFacade);
 142
 143         final ActorRef masterRef = mock(ActorRef.class);
 144
 145         remoteDeviceConnection.startRemoteDeviceConnection(masterRef);
 146
 147         remoteDeviceConnection.stopRemoteDeviceConnection();
 148
 149         verify(communicator, times(1)).close();
 150         verify(salFacade, times(1)).close();
 151
 152     }
 153
 154     @Test
 155     public void testMasterSalFacade() throws UnknownHostException {
 156         final ExecutorService executorService = mock(ExecutorService.class);
 157         doReturn(executorService).when(processingExecutor).getExecutor();
 158
 159         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 160         final NetconfNode netconfNode = new NetconfNodeBuilder()
 161                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 162                 .setPort(new PortNumber(9999))
 163                 .setReconnectOnChangedSchema(true)
 164                 .setDefaultRequestTimeoutMillis(1000L)
 165                 .setBetweenAttemptsTimeoutMillis(100)
 166                 .setSchemaless(false)
 167                 .setTcpOnly(false)
 168                 .setCredentials(credentials)
 169                 .build();
 170
 171         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 172                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 173
 174         final ActorRef masterRef = mock(ActorRef.class);
 175
 176         final NetconfConnectorDTO connectorDTO =
 177                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 178
 179         assertTrue(connectorDTO.getFacade() instanceof MasterSalFacade);
 180     }
 181
 182     @Test
 183     public void testKeapAliveFacade() throws UnknownHostException {
 184         final ExecutorService executorService = mock(ExecutorService.class);
 185         doReturn(executorService).when(processingExecutor).getExecutor();
 186
 187         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 188         final NetconfNode netconfNode = new NetconfNodeBuilder()
 189                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 190                 .setPort(new PortNumber(9999))
 191                 .setReconnectOnChangedSchema(true)
 192                 .setDefaultRequestTimeoutMillis(1000L)
 193                 .setBetweenAttemptsTimeoutMillis(100)
 194                 .setSchemaless(false)
 195                 .setTcpOnly(false)
 196                 .setCredentials(credentials)
 197                 .setKeepaliveDelay(1L)
 198                 .build();
 199
 200         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 201                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 202
 203         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 204                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 205
 206         final ActorRef masterRef = mock(ActorRef.class);
 207
 208         final NetconfConnectorDTO connectorDTO =
 209                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 210
 211         assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
 212     }
 213
 214     @Test
 215     public void testGetClientConfig() throws UnknownHostException {
 216         final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
 217         final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
 218         final PortNumber portNumber = new PortNumber(9999);
 219         final NetconfNode testingNode = new NetconfNodeBuilder()
 220                 .setConnectionTimeoutMillis(1000L)
 221                 .setDefaultRequestTimeoutMillis(2000L)
 222                 .setHost(host)
 223                 .setPort(portNumber)
 224                 .setCredentials(new LoginPasswordBuilder()
 225                         .setUsername("testuser")
 226                         .setPassword("testpassword").build())
 227                 .setTcpOnly(true)
 228                 .build();
 229
 230         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 231                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 232
 233         final NetconfReconnectingClientConfiguration defaultClientConfig =
 234                 remoteDeviceConnection.getClientConfig(listener, testingNode);
 235
 236         assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
 237         assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 238         assertSame(defaultClientConfig.getSessionListener(), listener);
 239         assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
 240         assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
 241     }
 242
 243     @Test
 244     public void testSchemaResourceDTO() throws UnknownHostException {
 245         final ExecutorService executorService = mock(ExecutorService.class);
 246         doReturn(executorService).when(processingExecutor).getExecutor();
 247
 248         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 249         final NetconfNode netconfNode = new NetconfNodeBuilder()
 250                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 251                 .setPort(new PortNumber(9999))
 252                 .setReconnectOnChangedSchema(true)
 253                 .setDefaultRequestTimeoutMillis(1000L)
 254                 .setBetweenAttemptsTimeoutMillis(100)
 255                 .setSchemaless(false)
 256                 .setTcpOnly(false)
 257                 .setCredentials(credentials)
 258                 .setSchemaCacheDirectory("schemas-test")
 259                 .build();
 260
 261         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 262                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 263
 264         final ActorRef masterRef = mock(ActorRef.class);
 265
 266         remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 267
 268         assertTrue(remoteDeviceConnection.getSchemaResourcesDTOs().containsKey("schemas-test"));
 269     }
 270
 271 }