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