opendaylight/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.Matchers.any;
  11 import static org.mockito.Mockito.doAnswer;
  12 import static org.mockito.Mockito.doNothing;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.Mockito.timeout;
  16 import static org.mockito.Mockito.times;
  17 import static org.mockito.Mockito.verify;
  18
  19 import java.net.InetSocketAddress;
  20 import java.util.concurrent.Executors;
  21 import java.util.concurrent.ScheduledExecutorService;
  22 import java.util.concurrent.ScheduledFuture;
  23 import java.util.concurrent.TimeUnit;
  24
  25 import org.junit.After;
  26 import org.junit.Before;
  27 import org.junit.Test;
  28 import org.mockito.Matchers;
  29 import org.mockito.Mock;
  30 import org.mockito.Mockito;
  31 import org.mockito.MockitoAnnotations;
  32 import org.mockito.invocation.InvocationOnMock;
  33 import org.mockito.stubbing.Answer;
  34 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  36 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  37 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  38 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  39 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  40 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  41 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  42 import org.opendaylight.yangtools.yang.common.RpcError;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  48
  49 import com.google.common.util.concurrent.Futures;
  50
  51 public class KeepaliveSalFacadeTest {
  52
  53     private static final RemoteDeviceId REMOTE_DEVICE_ID = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  54
  55     @Mock
  56     private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
  57
  58     private ScheduledExecutorService executorServiceSpy;
  59
  60     @Mock
  61     private NetconfDeviceCommunicator listener;
  62     @Mock
  63     private DOMRpcService deviceRpc;
  64
  65     private DOMRpcService proxyRpc;
  66
  67     @Mock
  68     private ScheduledFuture currentKeepalive;
  69
  70     @Before
  71     public void setUp() throws Exception {
  72         executorServiceSpy = Executors.newScheduledThreadPool(1);
  73
  74         MockitoAnnotations.initMocks(this);
  75
  76         doNothing().when(listener).disconnect();
  77         doReturn("mockedRpc").when(deviceRpc).toString();
  78         doNothing().when(underlyingSalFacade).onDeviceConnected(
  79                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
  80
  81         ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);
  82         executorServiceSpy = Mockito.spy(executorService);
  83         doAnswer(new Answer<ScheduledFuture>() {
  84             @Override
  85             public ScheduledFuture answer(InvocationOnMock invocationOnMock)
  86                     throws Throwable {
  87                 invocationOnMock.callRealMethod();
  88                 return currentKeepalive;
  89             }
  90         }).when(executorServiceSpy).schedule(Mockito.<Runnable> any(),
  91                 Mockito.anyLong(), Matchers.<TimeUnit> any());
  92
  93         Mockito.when(currentKeepalive.isDone()).thenReturn(true);
  94     }
  95
  96     @After
  97     public void tearDown() throws Exception {
  98         executorServiceSpy.shutdownNow();
  99     }
 100
 101     @Test
 102     public void testKeepaliveSuccess() throws Exception {
 103         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 104                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 105
 106         doReturn(Futures.immediateCheckedFuture(result)).when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 107
 108         final KeepaliveSalFacade keepaliveSalFacade =
 109                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L);
 110         keepaliveSalFacade.setListener(listener);
 111
 112         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 113
 114         verify(underlyingSalFacade).onDeviceConnected(
 115                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 116
 117         verify(deviceRpc, timeout(15000).atLeast(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 118     }
 119
 120     @Test
 121     public void testKeepaliveFail() throws Exception {
 122         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 123                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 124
 125         RpcError error = mock(RpcError.class);
 126         doReturn("Failure").when(error).toString();
 127
 128         final DOMRpcResult resultFailWithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
 129
 130         doReturn(Futures.immediateCheckedFuture(result))
 131                 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
 132                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 133                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 134
 135         final KeepaliveSalFacade keepaliveSalFacade =
 136                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L);
 137         keepaliveSalFacade.setListener(listener);
 138
 139         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 140
 141         verify(underlyingSalFacade).onDeviceConnected(
 142                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 143
 144         // 1 failed that results in disconnect
 145         verify(listener, timeout(15000).times(1)).disconnect();
 146         // 3 attempts total
 147         verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 148
 149         // Reconnect with same keepalive responses
 150         doReturn(Futures.immediateCheckedFuture(result))
 151                 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
 152                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 153                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 154
 155         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 156
 157         // 1 failed that results in disconnect, 2 total with previous fail
 158         verify(listener, timeout(15000).times(2)).disconnect();
 159         // 6 attempts now total
 160         verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 161
 162         final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
 163
 164         doReturn(Futures.immediateCheckedFuture(resultFailwithError))
 165                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 166
 167         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 168
 169         // 1 failed that results in disconnect, 3 total with previous fail
 170         verify(listener, timeout(15000).times(3)).disconnect();
 171
 172
 173         Mockito.when(currentKeepalive.isDone()).thenReturn(false);
 174         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 175         // 1 failed that results in disconnect, 4 total with previous fail
 176         verify(listener, timeout(15000).times(4)).disconnect();
 177     }
 178
 179     @Test
 180     public void testNonKeepaliveRpcFailure() throws Exception {
 181         doAnswer(new Answer() {
 182             @Override
 183             public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
 184                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 185                 return null;
 186             }
 187         }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 188
 189         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 190                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 191
 192         final KeepaliveSalFacade keepaliveSalFacade =
 193                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L);
 194         keepaliveSalFacade.setListener(listener);
 195
 196         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 197
 198         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 199
 200         verify(listener, times(1)).disconnect();
 201     }
 202 }