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
   9 package org.opendaylight.netconf.topology.singleton.impl;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertSame;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.times;
  17 import static org.mockito.Mockito.verify;
  18 import static org.mockito.MockitoAnnotations.initMocks;
  19
  20 import akka.actor.ActorRef;
  21 import akka.actor.ActorSystem;
  22 import akka.util.Timeout;
  23 import io.netty.util.concurrent.EventExecutor;
  24 import java.net.InetAddress;
  25 import java.net.InetSocketAddress;
  26 import java.net.UnknownHostException;
  27 import java.util.concurrent.ExecutorService;
  28 import org.junit.Before;
  29 import org.junit.Test;
  30 import org.mockito.Mock;
  31 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  32 import org.opendaylight.controller.config.threadpool.ThreadPool;
  33 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  34 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  35 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  36 import org.opendaylight.controller.sal.core.api.Broker;
  37 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  38 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  39 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  40 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  41 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  42 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  43 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  44 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
  45 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  46 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
  47 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  48 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPasswordBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  60 import scala.concurrent.duration.Duration;
  61
  62 public class RemoteDeviceConnectorImplTest {
  63
  64     private static final NodeId NODE_ID = new NodeId("testing-node");
  65     private static final String TOPOLOGY_ID = "testing-topology";
  66     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  67
  68     @Mock
  69     private DataBroker dataBroker;
  70
  71     @Mock
  72     private RpcProviderRegistry rpcProviderRegistry;
  73
  74     @Mock
  75     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  76
  77     @Mock
  78     private BindingAwareBroker bindingAwareBroker;
  79
  80     @Mock
  81     private ScheduledThreadPool keepaliveExecutor;
  82
  83     @Mock
  84     private ThreadPool processingExecutor;
  85
  86     @Mock
  87     private Broker domBroker;
  88
  89     @Mock
  90     private ActorSystem actorSystem;
  91
  92     @Mock
  93     private EventExecutor eventExecutor;
  94
  95     @Mock
  96     private NetconfClientDispatcher clientDispatcher;
  97
  98     private NetconfTopologySetup.NetconfTopologySetupBuilder builder;
  99     private RemoteDeviceId remoteDeviceId;
 100
 101     @Before
 102     public void setUp() throws UnknownHostException {
 103         initMocks(this);
 104
 105         remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 106                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 107
 108         builder = new NetconfTopologySetup.NetconfTopologySetupBuilder();
 109         builder.setDataBroker(dataBroker);
 110         builder.setRpcProviderRegistry(rpcProviderRegistry);
 111         builder.setClusterSingletonServiceProvider(clusterSingletonServiceProvider);
 112         builder.setBindingAwareBroker(bindingAwareBroker);
 113         builder.setKeepaliveExecutor(keepaliveExecutor);
 114         builder.setProcessingExecutor(processingExecutor);
 115         builder.setDomBroker(domBroker);
 116         builder.setActorSystem(actorSystem);
 117         builder.setEventExecutor(eventExecutor);
 118         builder.setNetconfClientDispatcher(clientDispatcher);
 119         builder.setTopologyId(TOPOLOGY_ID);
 120     }
 121
 122     @Test
 123     public void testStopRemoteDeviceConnection() {
 124         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 125         final NetconfNode netconfNode = new NetconfNodeBuilder()
 126                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 127                 .setPort(new PortNumber(9999))
 128                 .setReconnectOnChangedSchema(true)
 129                 .setDefaultRequestTimeoutMillis(1000L)
 130                 .setBetweenAttemptsTimeoutMillis(100)
 131                 .setSchemaless(false)
 132                 .setTcpOnly(false)
 133                 .setCredentials(credentials)
 134                 .build();
 135         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 136
 137         builder.setNode(node);
 138
 139
 140         final NetconfDeviceCommunicator communicator = mock (NetconfDeviceCommunicator.class);
 141         final RemoteDeviceHandler salFacade = mock(RemoteDeviceHandler.class);
 142
 143         final TestingRemoteDeviceConnectorImpl remoteDeviceConnection =
 144                 new TestingRemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, communicator, salFacade, TIMEOUT);
 145
 146         final ActorRef masterRef = mock(ActorRef.class);
 147
 148         remoteDeviceConnection.startRemoteDeviceConnection(masterRef);
 149
 150         remoteDeviceConnection.stopRemoteDeviceConnection();
 151
 152         verify(communicator, times(1)).close();
 153         verify(salFacade, times(1)).close();
 154
 155     }
 156
 157     @Test
 158     public void testMasterSalFacade() throws UnknownHostException {
 159         final ExecutorService executorService = mock(ExecutorService.class);
 160         doReturn(executorService).when(processingExecutor).getExecutor();
 161
 162         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 163         final NetconfNode netconfNode = new NetconfNodeBuilder()
 164                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 165                 .setPort(new PortNumber(9999))
 166                 .setReconnectOnChangedSchema(true)
 167                 .setDefaultRequestTimeoutMillis(1000L)
 168                 .setBetweenAttemptsTimeoutMillis(100)
 169                 .setSchemaless(false)
 170                 .setTcpOnly(false)
 171                 .setCredentials(credentials)
 172                 .build();
 173
 174         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 175         builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
 176         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 177                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT);
 178
 179         final ActorRef masterRef = mock(ActorRef.class);
 180
 181         final NetconfConnectorDTO connectorDTO =
 182                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 183
 184         assertTrue(connectorDTO.getFacade() instanceof MasterSalFacade);
 185     }
 186
 187     @Test
 188     public void testKeapAliveFacade() throws UnknownHostException {
 189         final ExecutorService executorService = mock(ExecutorService.class);
 190         doReturn(executorService).when(processingExecutor).getExecutor();
 191
 192         final Credentials credentials = new LoginPasswordBuilder().setPassword("admin").setUsername("admin").build();
 193         final NetconfNode netconfNode = new NetconfNodeBuilder()
 194                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 195                 .setPort(new PortNumber(9999))
 196                 .setReconnectOnChangedSchema(true)
 197                 .setDefaultRequestTimeoutMillis(1000L)
 198                 .setBetweenAttemptsTimeoutMillis(100)
 199                 .setSchemaless(false)
 200                 .setTcpOnly(false)
 201                 .setCredentials(credentials)
 202                 .setKeepaliveDelay(1L)
 203                 .build();
 204
 205         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId(TOPOLOGY_ID,
 206                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 207         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 208         builder.setSchemaResourceDTO(NetconfTopologyUtils.setupSchemaCacheDTO(node));
 209
 210         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 211                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT);
 212
 213         final ActorRef masterRef = mock(ActorRef.class);
 214
 215         final NetconfConnectorDTO connectorDTO =
 216                 remoteDeviceConnection.createDeviceCommunicator(NODE_ID, netconfNode, masterRef);
 217
 218         assertTrue(connectorDTO.getFacade() instanceof KeepaliveSalFacade);
 219     }
 220
 221     @Test
 222     public void testGetClientConfig() throws UnknownHostException {
 223         final NetconfClientSessionListener listener = mock(NetconfClientSessionListener.class);
 224         final Host host = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
 225         final PortNumber portNumber = new PortNumber(9999);
 226         final NetconfNode testingNode = new NetconfNodeBuilder()
 227                 .setConnectionTimeoutMillis(1000L)
 228                 .setDefaultRequestTimeoutMillis(2000L)
 229                 .setHost(host)
 230                 .setPort(portNumber)
 231                 .setCredentials(new LoginPasswordBuilder()
 232                         .setUsername("testuser")
 233                         .setPassword("testpassword").build())
 234                 .setTcpOnly(true)
 235                 .build();
 236
 237         final RemoteDeviceConnectorImpl remoteDeviceConnection =
 238                 new RemoteDeviceConnectorImpl(builder.build(), remoteDeviceId, TIMEOUT);
 239
 240         final NetconfReconnectingClientConfiguration defaultClientConfig =
 241                 remoteDeviceConnection.getClientConfig(listener, testingNode);
 242
 243         assertEquals(defaultClientConfig.getConnectionTimeoutMillis().longValue(), 1000L);
 244         assertEquals(defaultClientConfig.getAddress(), new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
 245         assertSame(defaultClientConfig.getSessionListener(), listener);
 246         assertEquals(defaultClientConfig.getAuthHandler().getUsername(), "testuser");
 247         assertEquals(defaultClientConfig.getProtocol(), NetconfClientConfiguration.NetconfClientProtocol.TCP);
 248     }
 249 }