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     private KeepaliveSalFacade keepaliveSalFacade;
  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(invocationOnMock -> {
  84             invocationOnMock.callRealMethod();
  85             return currentKeepalive;
  86         }).when(executorServiceSpy).schedule(Mockito.<Runnable> any(),
  87                 Mockito.anyLong(), Matchers.<TimeUnit> any());
  88
  89         Mockito.when(currentKeepalive.isDone()).thenReturn(true);
  90
  91         keepaliveSalFacade =
  92                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
  93         keepaliveSalFacade.setListener(listener);
  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, 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).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 118     }
 119
 120     @Test
 121     public void testKeepaliveRpcFailure() {
 122
 123         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 124                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 125
 126         final KeepaliveSalFacade keepaliveSalFacade =
 127                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
 128         keepaliveSalFacade.setListener(listener);
 129
 130         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 131
 132         verify(underlyingSalFacade).onDeviceConnected(
 133                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 134
 135         // Should disconnect the session
 136         verify(listener, timeout(15000).times(1)).disconnect();
 137         verify(deviceRpc, times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 138     }
 139
 140     @Test
 141     public void testKeepaliveSuccessWithRpcError() {
 142
 143         final DOMRpcResult rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
 144
 145         doReturn(Futures.immediateCheckedFuture(rpcSuccessWithError))
 146                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 147
 148         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 149
 150         verify(underlyingSalFacade).onDeviceConnected(
 151                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 152
 153         // Shouldn't disconnect the session
 154         verify(listener, times(0)).disconnect();
 155         verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 156     }
 157
 158     @Test
 159     public void testNonKeepaliveRpcFailure() throws Exception {
 160         doAnswer(new Answer() {
 161             @Override
 162             public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
 163                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 164                 return null;
 165             }
 166         }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 167
 168         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 169                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 170
 171         final KeepaliveSalFacade keepaliveSalFacade =
 172                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 173         keepaliveSalFacade.setListener(listener);
 174
 175         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 176
 177         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 178
 179         verify(listener, times(1)).disconnect();
 180     }
 181 }