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