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.Matchers.eq;
  16 import static org.mockito.Mockito.doNothing;
  17 import static org.mockito.Mockito.doReturn;
  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 import static org.opendaylight.mdsal.common.api.CommitInfo.emptyFluentFuture;
  23
  24 import akka.actor.ActorSystem;
  25 import akka.util.Timeout;
  26 import com.google.common.net.InetAddresses;
  27 import com.google.common.util.concurrent.ListeningExecutorService;
  28 import io.netty.util.concurrent.EventExecutor;
  29 import java.net.InetSocketAddress;
  30 import java.util.concurrent.ScheduledExecutorService;
  31 import org.junit.Before;
  32 import org.junit.Test;
  33 import org.mockito.Mock;
  34 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  35 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  36 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  38 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  40 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  41 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  42 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  43 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  44 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  45 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  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 scala.concurrent.duration.Duration;
  66
  67 public class RemoteDeviceConnectorImplTest {
  68
  69     private static final NodeId NODE_ID = new NodeId("testing-node");
  70     private static final String TOPOLOGY_ID = "testing-topology";
  71     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  72
  73     @Mock
  74     private DataBroker dataBroker;
  75
  76     @Mock
  77     private RpcProviderRegistry rpcProviderRegistry;
  78
  79     @Mock
  80     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  81
  82     @Mock
  83     private ScheduledExecutorService keepaliveExecutor;
  84
  85     @Mock
  86     private ListeningExecutorService processingExecutor;
  87
  88     @Mock
  89     private ActorSystem actorSystem;
  90
  91     @Mock
  92     private EventExecutor eventExecutor;
  93
  94     @Mock
  95     private NetconfClientDispatcher clientDispatcher;
  96
  97     @Mock
  98     private DOMMountPointService mountPointService;
  99
 100     @Mock
 101     private BindingTransactionChain txChain;
 102
 103     @Mock
 104     private WriteTransaction writeTx;
 105
 106     private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
 107     private RemoteDeviceId remoteDeviceId;
 108
 109     @Before
 110     public void setUp() {
 111         initMocks(this);
 112
 113         remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 114                 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
 115
 116         doReturn(txChain).when(dataBroker).createTransactionChain(any(TransactionChainListener.class));
 117         doReturn(writeTx).when(txChain).newWriteOnlyTransaction();
 118         doNothing().when(writeTx).merge(eq(LogicalDatastoreType.OPERATIONAL), any(), any());
 119         doReturn("Some object").when(writeTx).getIdentifier();
 120         doReturn(emptyFluentFuture()).when(writeTx).commit();
 121         builder = new NetconfTopologySetup.NetconfTopologySetupBuilder();
 122         builder.setDataBroker(dataBroker);
 123         builder.setRpcProviderRegistry(rpcProviderRegistry);
 124         builder.setClusterSingletonServiceProvider(clusterSingletonServiceProvider);
 125         builder.setKeepaliveExecutor(keepaliveExecutor);
 126         builder.setProcessingExecutor(processingExecutor);
 127         builder.setActorSystem(actorSystem);
 128         builder.setEventExecutor(eventExecutor);
 129         builder.setNetconfClientDispatcher(clientDispatcher);
 130         builder.setTopologyId(TOPOLOGY_ID);
 131     }
 132
 133     @SuppressWarnings("unchecked")
 134     @Test
 135     public void testStopRemoteDeviceConnection() {
 136         final Credentials credentials = new LoginPasswordBuilder()
 137                 .setPassword("admin").setUsername("admin").build();
 138         final NetconfNode netconfNode = new NetconfNodeBuilder()
 139                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 140                 .setPort(new PortNumber(9999))
 141                 .setReconnectOnChangedSchema(true)
 142                 .setDefaultRequestTimeoutMillis(1000L)
 143                 .setBetweenAttemptsTimeoutMillis(100)
 144                 .setSchemaless(false)
 145                 .setTcpOnly(false)
 146                 .setCredentials(credentials)
 147                 .build();
 148         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 149
 150         builder.setNode(node);
 151
 152
 153         final NetconfDeviceCommunicator communicator = mock(NetconfDeviceCommunicator.class);
 154         final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
 155
 156         final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
 157                 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator);
 158
 159         remoteDeviceConnection.startRemoteDeviceConnection(salFacade);
 160
 161         remoteDeviceConnection.stopRemoteDeviceConnection();
 162
 163         verify(communicator, times(1)).close();
 164         verify(salFacade, times(1)).close();
 165
 166     }
 167
 168     @SuppressWarnings("unchecked")
 169     @Test
 170     public void testKeapAliveFacade() {
 171         final Credentials credentials = new LoginPasswordBuilder()
 172                 .setPassword("admin").setUsername("admin").build();
 173         final NetconfNode netconfNode = new NetconfNodeBuilder()
 174                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 175                 .setPort(new PortNumber(9999))
 176                 .setReconnectOnChangedSchema(true)
 177                 .setDefaultRequestTimeoutMillis(1000L)
 178                 .setBetweenAttemptsTimeoutMillis(100)
 179                 .setSchemaless(false)
 180                 .setTcpOnly(false)
 181                 .setCredentials(credentials)
 182                 .setKeepaliveDelay(1L)
 183                 .build();
 184
 185         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 186         builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
 187
 188         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 189                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 190
 191         final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
 192
 193         final NetconfConnectorDTO connectorDTO =
 194                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, salFacade);
 195
 196         assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
 197     }
 198
 199     @Test
 200     public void testGetClientConfig() {
 201         final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
 202         final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
 203         final PortNumber portNumber = new PortNumber(9999);
 204         final NetconfNode testingNode = new NetconfNodeBuilder()
 205                 .setConnectionTimeoutMillis(1000L)
 206                 .setDefaultRequestTimeoutMillis(2000L)
 207                 .setHost(host)
 208                 .setPort(portNumber)
 209                 .setCredentials(new LoginPasswordBuilder()
 210                         .setUsername("testuser")
 211                         .setPassword("testpassword").build())
 212                 .setTcpOnly(true)
 213                 .build();
 214
 215         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 216                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId);
 217
 218         final NetconfReconnectingClientConfiguration defaultClientConfig =
 219                 remoteDeviceConnection.getClientConfig(listener, testingNode);
 220
 221         assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
 222         assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddresses.forString("127.0.0.1"),
 223             9999));
 224         assertSame(defaultClientConfig.getSessionListener(), listener);
 225         assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
 226         assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
 227     }
 228 }