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 com.google.common.util.concurrent.Futures;
  20 import java.net.InetSocketAddress;
  21 import java.util.concurrent.Executors;
  22 import java.util.concurrent.ScheduledExecutorService;
  23 import java.util.concurrent.ScheduledFuture;
  24 import java.util.concurrent.TimeUnit;
  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 public class KeepaliveSalFacadeTest {
  50
  51     private static final RemoteDeviceId REMOTE_DEVICE_ID = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  52
  53     @Mock
  54     private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
  55
  56     private ScheduledExecutorService executorServiceSpy;
  57
  58     @Mock
  59     private NetconfDeviceCommunicator listener;
  60     @Mock
  61     private DOMRpcService deviceRpc;
  62
  63     private DOMRpcService proxyRpc;
  64
  65     @Mock
  66     private ScheduledFuture currentKeepalive;
  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         doAnswer(new Answer<ScheduledFuture>() {
  82             @Override
  83             public ScheduledFuture answer(InvocationOnMock invocationOnMock)
  84                     throws Throwable {
  85                 invocationOnMock.callRealMethod();
  86                 return currentKeepalive;
  87             }
  88         }).when(executorServiceSpy).schedule(Mockito.<Runnable> any(),
  89                 Mockito.anyLong(), Matchers.<TimeUnit> any());
  90
  91         Mockito.when(currentKeepalive.isDone()).thenReturn(true);
  92     }
  93
  94     @After
  95     public void tearDown() throws Exception {
  96         executorServiceSpy.shutdownNow();
  97     }
  98
  99     @Test
 100     public void testKeepaliveSuccess() throws Exception {
 101         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 102                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 103
 104         doReturn(Futures.immediateCheckedFuture(result)).when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 105
 106         final KeepaliveSalFacade keepaliveSalFacade =
 107                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
 108         keepaliveSalFacade.setListener(listener);
 109
 110         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 111
 112         verify(underlyingSalFacade).onDeviceConnected(
 113                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 114
 115         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 116     }
 117
 118     @Test
 119     public void testKeepaliveFail() throws Exception {
 120         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 121                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 122
 123         RpcError error = mock(RpcError.class);
 124         doReturn("Failure").when(error).toString();
 125
 126         final DOMRpcResult resultFailWithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
 127
 128         doReturn(Futures.immediateCheckedFuture(result))
 129                 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
 130                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 131                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 132
 133         final KeepaliveSalFacade keepaliveSalFacade =
 134                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
 135         keepaliveSalFacade.setListener(listener);
 136
 137         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 138
 139         verify(underlyingSalFacade).onDeviceConnected(
 140                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 141
 142         // 1 failed that results in disconnect
 143         verify(listener, timeout(15000).times(1)).disconnect();
 144         // 3 attempts total
 145         verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 146
 147         // Reconnect with same keepalive responses
 148         doReturn(Futures.immediateCheckedFuture(result))
 149                 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
 150                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 151                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 152
 153         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 154
 155         // 1 failed that results in disconnect, 2 total with previous fail
 156         verify(listener, timeout(15000).times(2)).disconnect();
 157         // 6 attempts now total
 158         verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 159
 160         final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
 161
 162         doReturn(Futures.immediateCheckedFuture(resultFailwithError))
 163                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 164
 165         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 166
 167         // 1 failed that results in disconnect, 3 total with previous fail
 168         verify(listener, timeout(15000).times(3)).disconnect();
 169
 170
 171         Mockito.when(currentKeepalive.isDone()).thenReturn(false);
 172         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 173         // 1 failed that results in disconnect, 4 total with previous fail
 174         verify(listener, timeout(15000).times(4)).disconnect();
 175     }
 176
 177     @Test
 178     public void testNonKeepaliveRpcFailure() throws Exception {
 179         doAnswer(new Answer() {
 180             @Override
 181             public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
 182                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 183                 return null;
 184             }
 185         }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 186
 187         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 188                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 189
 190         final KeepaliveSalFacade keepaliveSalFacade =
 191                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 192         keepaliveSalFacade.setListener(listener);
 193
 194         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 195
 196         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 197
 198         verify(listener, times(1)).disconnect();
 199     }
 200 }