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.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;
  22
  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;
  68
  69 public class RemoteDeviceConnectorImplTest {
  70
  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"));
  74
  75     @Mock
  76     private DataBroker dataBroker;
  77
  78     @Mock
  79     private RpcProviderRegistry rpcProviderRegistry;
  80
  81     @Mock
  82     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  83
  84     @Mock
  85     private ScheduledThreadPool keepaliveExecutor;
  86
  87     @Mock
  88     private ThreadPool processingExecutor;
  89
  90     @Mock
  91     private ActorSystem actorSystem;
  92
  93     @Mock
  94     private EventExecutor eventExecutor;
  95
  96     @Mock
  97     private NetconfClientDispatcher clientDispatcher;
  98
  99     @Mock
 100     private DOMMountPointService mountPointService;
 101
 102     @Mock
 103     private BindingTransactionChain txChain;
 104
 105     @Mock
 106     private WriteTransaction writeTx;
 107
 108     private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
 109     private RemoteDeviceId remoteDeviceId;
 110
 111     @Before
 112     public void setUp() {
 113         initMocks(this);
 114
 115         remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 116                 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
 117
 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);
 133     }
 134
 135     @Test
 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)
 146                 .setTcpOnly(false)
 147                 .setCredentials(credentials)
 148                 .build();
 149         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 150
 151         builder.setNode(node);
 152
 153
 154         final NetconfDeviceCommunicator communicator = mock(NetconfDeviceCommunicator.class);
 155         final RemoteDeviceHandler salFacade = mock(RemoteDeviceHandler.class);
 156
 157         final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
 158                 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator, salFacade, TIMEOUT,
 159                         mountPointService);
 160
 161         final ActorRef masterRef = mock(ActorRef.class);
 162
 163         remoteDeviceConnection.startRemoteDeviceConnection(masterRef);
 164
 165         remoteDeviceConnection.stopRemoteDeviceConnection();
 166
 167         verify(communicator, times(1)).close();
 168         verify(salFacade, times(1)).close();
 169
 170     }
 171
 172     @Test
 173     public void testMasterSalFacade() throws UnknownHostException {
 174         final ExecutorService executorService = mock(ExecutorService.class);
 175         doReturn(executorService).when(processingExecutor).getExecutor();
 176
 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)
 186                 .setTcpOnly(false)
 187                 .setCredentials(credentials)
 188                 .build();
 189
 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);
 194
 195         final ActorRef masterRef = mock(ActorRef.class);
 196
 197         final NetconfConnectorDTO connectorDTO =
 198                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 199
 200         assertTrue(connectorDTO.getFacade() instanceof MasterSalFacade);
 201     }
 202
 203     @Test
 204     public void testKeapAliveFacade() {
 205         final ExecutorService executorService = mock(ExecutorService.class);
 206         doReturn(executorService).when(processingExecutor).getExecutor();
 207
 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)
 217                 .setTcpOnly(false)
 218                 .setCredentials(credentials)
 219                 .setKeepaliveDelay(1L)
 220                 .build();
 221
 222         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 223         builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
 224
 225         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 226                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
 227
 228         final ActorRef masterRef = mock(ActorRef.class);
 229
 230         final NetconfConnectorDTO connectorDTO =
 231                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 232
 233         assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
 234     }
 235
 236     @Test
 237     public void testGetClientConfig() {
 238         final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
 239         final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
 240         final PortNumber portNumber = new PortNumber(9999);
 241         final NetconfNode testingNode = new NetconfNodeBuilder()
 242                 .setConnectionTimeoutMillis(1000L)
 243                 .setDefaultRequestTimeoutMillis(2000L)
 244                 .setHost(host)
 245                 .setPort(portNumber)
 246                 .setCredentials(new LoginPasswordBuilder()
 247                         .setUsername("testuser")
 248                         .setPassword("testpassword").build())
 249                 .setTcpOnly(true)
 250                 .build();
 251
 252         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 253                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT, mountPointService);
 254
 255         final NetconfReconnectingClientConfiguration defaultClientConfig =
 256                 remoteDeviceConnection.getClientConfig(listener, testingNode);
 257
 258         assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
 259         assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddresses.forString("127.0.0.1"),
 260             9999));
 261         assertSame(defaultClientConfig.getSessionListener(), listener);
 262         assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
 263         assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
 264     }
 265 }