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