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