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