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 com.google.common.util.concurrent.Futures;
  21 import java.net.InetSocketAddress;
  22 import java.util.concurrent.Executors;
  23 import java.util.concurrent.ScheduledExecutorService;
  24 import java.util.concurrent.ScheduledFuture;
  25 import org.junit.After;
  26 import org.junit.Before;
  27 import org.junit.Test;
  28 import org.mockito.Mock;
  29 import org.mockito.Mockito;
  30 import org.mockito.MockitoAnnotations;
  31 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  32 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  33 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  34 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  35 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  36 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  37 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  38 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  39 import org.opendaylight.yangtools.yang.common.RpcError;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  45
  46 public class KeepaliveSalFacadeTest {
  47
  48     private static final RemoteDeviceId REMOTE_DEVICE_ID =
  49             new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  50
  51     @Mock
  52     private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
  53
  54     private ScheduledExecutorService executorServiceSpy;
  55
  56     @Mock
  57     private NetconfDeviceCommunicator listener;
  58     @Mock
  59     private DOMRpcService deviceRpc;
  60
  61     private DOMRpcService proxyRpc;
  62
  63     @Mock
  64     private ScheduledFuture currentKeepalive;
  65
  66     private KeepaliveSalFacade keepaliveSalFacade;
  67
  68     @Before
  69     public void setUp() throws Exception {
  70         executorServiceSpy = Executors.newScheduledThreadPool(1);
  71
  72         MockitoAnnotations.initMocks(this);
  73
  74         doNothing().when(listener).disconnect();
  75         doReturn("mockedRpc").when(deviceRpc).toString();
  76         doNothing().when(underlyingSalFacade).onDeviceConnected(
  77                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
  78
  79         ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);
  80         executorServiceSpy = Mockito.spy(executorService);
  81
  82         doAnswer(
  83             invocationOnMock -> {
  84                 invocationOnMock.callRealMethod();
  85                 return currentKeepalive;
  86             }).when(executorServiceSpy).schedule(Mockito.<Runnable>any(), Mockito.anyLong(), any());
  87
  88         Mockito.when(currentKeepalive.isDone()).thenReturn(true);
  89
  90         keepaliveSalFacade =
  91                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
  92         keepaliveSalFacade.setListener(listener);
  93     }
  94
  95     @After
  96     public void tearDown() throws Exception {
  97         executorServiceSpy.shutdownNow();
  98     }
  99
 100     @Test
 101     public void testKeepaliveSuccess() throws Exception {
 102         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 103                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 104
 105         doReturn(Futures.immediateCheckedFuture(result))
 106                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), isNull());
 107
 108         doReturn(Futures.immediateCheckedFuture(result))
 109                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 110
 111         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 112
 113         verify(underlyingSalFacade).onDeviceConnected(
 114                 isNull(), isNull(), any(DOMRpcService.class), isNull());
 115
 116         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 117     }
 118
 119     @Test
 120     public void testKeepaliveRpcFailure() {
 121
 122         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 123                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 124
 125         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 126
 127         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 128
 129         // Should disconnect the session
 130         verify(listener, timeout(15000).times(1)).disconnect();
 131         verify(deviceRpc, times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 132     }
 133
 134     @Test
 135     public void testKeepaliveSuccessWithRpcError() {
 136
 137         final DOMRpcResult rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
 138
 139         doReturn(Futures.immediateCheckedFuture(rpcSuccessWithError))
 140                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 141
 142         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 143
 144         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 145
 146
 147         // Shouldn't disconnect the session
 148         verify(listener, times(0)).disconnect();
 149         verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 150     }
 151
 152     @Test
 153     public void testNonKeepaliveRpcFailure() throws Exception {
 154         doAnswer(
 155             invocationOnMock -> {
 156                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 157                 return null;
 158             }).when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 159
 160         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 161                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 162
 163         keepaliveSalFacade =
 164                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 165         keepaliveSalFacade.setListener(listener);
 166
 167         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 168
 169         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 170
 171         verify(listener, times(1)).disconnect();
 172     }
 173 }