netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/sal/KeepaliveSalFacadeTest.java

   1 /*
   2  * Copyright (c) 2015 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.sal.connect.netconf.sal;
   9
  10 import static org.mockito.ArgumentMatchers.any;
  11 import static org.mockito.ArgumentMatchers.isNull;
  12 import static org.mockito.Mockito.doAnswer;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.timeout;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import java.net.InetSocketAddress;
  21 import java.util.concurrent.Executors;
  22 import java.util.concurrent.ScheduledExecutorService;
  23 import org.junit.After;
  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.dom.api.DOMRpcService;
  30 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  31 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  32 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices;
  33 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  34 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  35 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  36 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.common.RpcError;
  39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  41
  42 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  43 public class KeepaliveSalFacadeTest {
  44
  45     private static final RemoteDeviceId REMOTE_DEVICE_ID =
  46             new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  47
  48     @Mock
  49     private RemoteDeviceHandler underlyingSalFacade;
  50
  51     private ScheduledExecutorService executorServiceSpy;
  52
  53     @Mock
  54     private NetconfDeviceCommunicator listener;
  55     @Mock
  56     private DOMRpcService deviceRpc;
  57
  58     private DOMRpcService proxyRpc;
  59
  60     private KeepaliveSalFacade keepaliveSalFacade;
  61
  62     @Before
  63     public void setUp() throws Exception {
  64         executorServiceSpy = Executors.newScheduledThreadPool(1);
  65
  66         doNothing().when(listener).disconnect();
  67         doNothing().when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(RemoteDeviceServices.class));
  68
  69         keepaliveSalFacade =
  70                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
  71         keepaliveSalFacade.setListener(listener);
  72     }
  73
  74     @After
  75     public void tearDown() throws Exception {
  76         executorServiceSpy.shutdownNow();
  77     }
  78
  79     @Test
  80     public void testKeepaliveSuccess() throws Exception {
  81         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult(Builders.containerBuilder()
  82             .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID)
  83             .build()))).when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
  84
  85         final var services = new RemoteDeviceServices(deviceRpc, null);
  86         keepaliveSalFacade.onDeviceConnected(null, null, services);
  87
  88         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(RemoteDeviceServices.class));
  89
  90         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(QName.class), any(ContainerNode.class));
  91     }
  92
  93     @Test
  94     public void testKeepaliveRpcFailure() {
  95
  96         doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("illegal-state")))
  97                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
  98
  99         keepaliveSalFacade.onDeviceConnected(null, null, new RemoteDeviceServices(deviceRpc, null));
 100
 101         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(RemoteDeviceServices.class));
 102
 103         // Should disconnect the session
 104         verify(listener, timeout(15000).times(1)).disconnect();
 105         verify(deviceRpc, times(1)).invokeRpc(any(QName.class), any(ContainerNode.class));
 106     }
 107
 108     @Test
 109     public void testKeepaliveSuccessWithRpcError() {
 110
 111         final var rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
 112
 113         doReturn(FluentFutures.immediateFluentFuture(rpcSuccessWithError))
 114                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 115
 116         keepaliveSalFacade.onDeviceConnected(null, null, new RemoteDeviceServices(deviceRpc, null));
 117
 118         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(RemoteDeviceServices.class));
 119
 120         // Shouldn't disconnect the session
 121         verify(listener, times(0)).disconnect();
 122         verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(QName.class), any(ContainerNode.class));
 123     }
 124
 125     @Test
 126     public void testNonKeepaliveRpcFailure() throws Exception {
 127         doAnswer(invocation -> proxyRpc = invocation.getArgument(2, RemoteDeviceServices.class).rpcs())
 128                 .when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(RemoteDeviceServices.class));
 129
 130         doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("illegal-state")))
 131                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 132
 133         keepaliveSalFacade =
 134                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 135         keepaliveSalFacade.setListener(listener);
 136
 137         keepaliveSalFacade.onDeviceConnected(null, null, new RemoteDeviceServices(deviceRpc, null));
 138
 139         proxyRpc.invokeRpc(QName.create("foo", "bar"), mock(ContainerNode.class));
 140
 141         verify(listener, times(1)).disconnect();
 142     }
 143 }