opendaylight/md-sal/sal-netconf-connector/src/test/java/org/opendaylight/controller/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.controller.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.controller.sal.connect.api.RemoteDeviceHandler;
  38 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  39 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
  40 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  41 import org.opendaylight.controller.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
  73         MockitoAnnotations.initMocks(this);
  74
  75         doNothing().when(listener).disconnect();
  76         doReturn("mockedRpc").when(deviceRpc).toString();
  77         doNothing().when(underlyingSalFacade).onDeviceConnected(
  78                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
  79
  80         ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);
  81         executorServiceSpy = Mockito.spy(executorService);
  82         doAnswer(new Answer<ScheduledFuture>() {
  83             @Override
  84             public ScheduledFuture answer(InvocationOnMock invocationOnMock)
  85                     throws Throwable {
  86                 invocationOnMock.callRealMethod();
  87                 return currentKeepalive;
  88             }
  89         }).when(executorServiceSpy).schedule(Mockito.<Runnable> any(),
  90                 Mockito.anyLong(), Matchers.<TimeUnit> any());
  91
  92         Mockito.when(currentKeepalive.isDone()).thenReturn(true);
  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), any(NormalizedNode.class));
 107
 108         final KeepaliveSalFacade keepaliveSalFacade =
 109                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L);
 110
 111         keepaliveSalFacade.setListener(listener);
 112
 113         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 114
 115         verify(underlyingSalFacade).onDeviceConnected(
 116                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 117
 118         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 119     }
 120
 121     @Test
 122     public void testKeepaliveFail() throws Exception {
 123         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 124                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 125
 126         RpcError error = mock(RpcError.class);
 127         doReturn("Failure").when(error).toString();
 128
 129         final DOMRpcResult resultFailwithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
 130
 131         doReturn(Futures.immediateCheckedFuture(result))
 132                 .doReturn(Futures.immediateCheckedFuture(resultFailwithResultAndError))
 133                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 134                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 135
 136         final KeepaliveSalFacade keepaliveSalFacade =
 137                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L);
 138         keepaliveSalFacade.setListener(listener);
 139
 140         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 141
 142         verify(underlyingSalFacade).onDeviceConnected(
 143                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 144
 145         // 1 failed that results in disconnect
 146         verify(listener, timeout(15000).times(1)).disconnect();
 147         // 3 attempts total
 148         verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 149
 150         // Reconnect with same keepalive responses
 151         doReturn(Futures.immediateCheckedFuture(result))
 152                 .doReturn(Futures.immediateCheckedFuture(resultFailwithResultAndError))
 153                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 154                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 155
 156         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 157
 158         // 1 failed that results in disconnect, 2 total with previous fail
 159         verify(listener, timeout(15000).times(2)).disconnect();
 160         // 6 attempts now total
 161         verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 162
 163
 164         final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
 165
 166         doReturn(Futures.immediateCheckedFuture(resultFailwithError))
 167                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 168
 169         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 170
 171         // 1 failed that results in disconnect, 3 total with previous fail
 172         verify(listener, timeout(15000).times(3)).disconnect();
 173
 174
 175         Mockito.when(currentKeepalive.isDone()).thenReturn(false);
 176         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 177         // 1 failed that results in disconnect, 4 total with previous fail
 178         verify(listener, timeout(15000).times(4)).disconnect();
 179     }
 180
 181     @Test
 182     public void testNonKeepaliveRpcFailure() throws Exception {
 183         doAnswer(new Answer() {
 184             @Override
 185             public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
 186                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 187                 return null;
 188             }
 189         }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 190
 191         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 192                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 193
 194         final KeepaliveSalFacade keepaliveSalFacade =
 195                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L);
 196         keepaliveSalFacade.setListener(listener);
 197
 198         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 199
 200         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 201
 202         verify(listener, times(1)).disconnect();
 203     }
 204 }