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.Mockito.mock;
  14 import static org.mockito.Mockito.times;
  15 import static org.mockito.Mockito.verify;
  16
  17 import akka.actor.ActorSystem;
  18 import akka.util.Timeout;
  19 import com.google.common.net.InetAddresses;
  20 import com.google.common.util.concurrent.ListeningExecutorService;
  21 import io.netty.util.concurrent.EventExecutor;
  22 import java.net.InetSocketAddress;
  23 import java.util.concurrent.ScheduledExecutorService;
  24 import org.junit.Before;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.Mock;
  28 import org.mockito.junit.MockitoJUnitRunner;
  29 import org.opendaylight.mdsal.binding.api.DataBroker;
  30 import org.opendaylight.mdsal.binding.api.TransactionChain;
  31 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  32 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  33 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  34 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  35 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  36 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  37 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  38 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  39 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  40 import org.opendaylight.netconf.sal.connect.impl.DefaultSchemaResourceManager;
  41 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  42 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  43 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
  44 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  45 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  46 import org.opendaylight.netconf.topology.spi.NetconfConnectorDTO;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  57 import org.opendaylight.yangtools.yang.common.Uint16;
  58 import org.opendaylight.yangtools.yang.common.Uint32;
  59 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
  60 import scala.concurrent.duration.Duration;
  61
  62 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  63 public class RemoteDeviceConnectorImplTest extends AbstractBaseSchemasTest {
  64
  65     private static final NodeId NODE_ID = new NodeId("testing-node");
  66     private static final String TOPOLOGY_ID = "testing-topology";
  67     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  68
  69     @Mock
  70     private DataBroker dataBroker;
  71
  72     @Mock
  73     private DOMRpcProviderService rpcProviderRegistry;
  74
  75     @Mock
  76     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  77
  78     @Mock
  79     private ScheduledExecutorService keepaliveExecutor;
  80
  81     @Mock
  82     private ListeningExecutorService processingExecutor;
  83
  84     @Mock
  85     private ActorSystem actorSystem;
  86
  87     @Mock
  88     private EventExecutor eventExecutor;
  89
  90     @Mock
  91     private NetconfClientDispatcher clientDispatcher;
  92
  93     @Mock
  94     private TransactionChain txChain;
  95
  96     @Mock
  97     private WriteTransaction writeTx;
  98
  99     @Mock
 100     private DeviceActionFactory deviceActionFactory;
 101
 102     private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
 103     private RemoteDeviceId remoteDeviceId;
 104
 105     @Before
 106     public void setUp() {
 107         remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 108                 new InetSocketAddress(InetAddresses.forString("127.0.0.1"), 9999));
 109
 110         builder = new NetconfTopologySetup.NetconfTopologySetupBuilder()
 111                 .setBaseSchemas(BASE_SCHEMAS)
 112                 .setDataBroker(dataBroker)
 113                 .setRpcProviderRegistry(rpcProviderRegistry)
 114                 .setClusterSingletonServiceProvider(clusterSingletonServiceProvider)
 115                 .setKeepaliveExecutor(keepaliveExecutor)
 116                 .setProcessingExecutor(processingExecutor)
 117                 .setActorSystem(actorSystem)
 118                 .setEventExecutor(eventExecutor)
 119                 .setNetconfClientDispatcher(clientDispatcher)
 120                 .setTopologyId(TOPOLOGY_ID);
 121     }
 122
 123     @SuppressWarnings("unchecked")
 124     @Test
 125     public void testStopRemoteDeviceConnection() {
 126         builder.setNode(new NodeBuilder().setNodeId(NODE_ID)
 127             .addAugmentation(new NetconfNodeBuilder()
 128                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 129                 .setPort(new PortNumber(Uint16.valueOf(9999)))
 130                 .setReconnectOnChangedSchema(true)
 131                 .setDefaultRequestTimeoutMillis(Uint32.valueOf(1000))
 132                 .setBetweenAttemptsTimeoutMillis(Uint16.valueOf(100))
 133                 .setSchemaless(false)
 134                 .setTcpOnly(false)
 135                 .setCredentials(new LoginPasswordBuilder()
 136                     .setPassword("admin").setUsername("admin")
 137                     .build())
 138                 .build())
 139             .build());
 140
 141         final NetconfDeviceCommunicator communicator = mock(NetconfDeviceCommunicator.class);
 142         final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
 143
 144         final TestingRemoteDeviceConnectorImpl remoteDeviceConnection = new TestingRemoteDeviceConnectorImpl(
 145             builder.build(), remoteDeviceId, communicator, deviceActionFactory);
 146
 147         remoteDeviceConnection.startRemoteDeviceConnection(salFacade);
 148
 149         remoteDeviceConnection.stopRemoteDeviceConnection();
 150
 151         verify(communicator, times(1)).close();
 152         verify(salFacade, times(1)).close();
 153     }
 154
 155     @SuppressWarnings("unchecked")
 156     @Test
 157     public void testKeapAliveFacade() {
 158         final Credentials credentials = new LoginPasswordBuilder()
 159                 .setPassword("admin").setUsername("admin").build();
 160         final NetconfNode netconfNode = new NetconfNodeBuilder()
 161                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 162                 .setPort(new PortNumber(Uint16.valueOf(9999)))
 163                 .setReconnectOnChangedSchema(true)
 164                 .setDefaultRequestTimeoutMillis(Uint32.valueOf(1000))
 165                 .setBetweenAttemptsTimeoutMillis(Uint16.valueOf(100))
 166                 .setSchemaless(false)
 167                 .setTcpOnly(false)
 168                 .setCredentials(credentials)
 169                 .setKeepaliveDelay(Uint32.ONE)
 170                 .build();
 171
 172         builder.setSchemaResourceDTO(new DefaultSchemaResourceManager(new DefaultYangParserFactory())
 173             .getSchemaResources(netconfNode.getSchemaCacheDirectory(), "foo"));
 174
 175         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 176                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, deviceActionFactory);
 177
 178         final RemoteDeviceHandler<NetconfSessionPreferences> salFacade = mock(RemoteDeviceHandler.class);
 179
 180         final NetconfConnectorDTO connectorDTO =
 181                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, salFacade);
 182
 183         assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
 184     }
 185
 186     @Test
 187     public void testGetClientConfig() {
 188         final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
 189         final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
 190         final PortNumber portNumber = new PortNumber(Uint16.valueOf(9999));
 191         final NetconfNode testingNode = new NetconfNodeBuilder()
 192                 .setConnectionTimeoutMillis(Uint32.valueOf(1000))
 193                 .setDefaultRequestTimeoutMillis(Uint32.valueOf(2000))
 194                 .setHost(host)
 195                 .setPort(portNumber)
 196                 .setCredentials(new LoginPasswordBuilder()
 197                         .setUsername("testuser")
 198                         .setPassword("testpassword").build())
 199                 .setTcpOnly(true)
 200                 .build();
 201
 202         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 203                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, deviceActionFactory);
 204
 205         final NetconfReconnectingClientConfiguration defaultClientConfig =
 206                 remoteDeviceConnection.getClientConfig(listener, testingNode);
 207
 208         assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
 209         assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddresses.forString("127.0.0.1"),
 210             9999));
 211         assertSame(defaultClientConfig.getSessionListener(), listener);
 212         assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
 213         assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
 214     }
 215 }