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 org.junit.After;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.mockito.Matchers;
  28 import org.mockito.Mock;
  29 import org.mockito.Mockito;
  30 import org.mockito.MockitoAnnotations;
  31 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  33 import org.opendaylight.controller.md.sal.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(), Matchers.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), any(NormalizedNode.class));
 107
 108         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 109
 110         verify(underlyingSalFacade).onDeviceConnected(
 111                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 112
 113         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 114     }
 115
 116     @Test
 117     public void testKeepaliveRpcFailure() {
 118
 119         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 120                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 121
 122         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 123
 124         verify(underlyingSalFacade).onDeviceConnected(
 125                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 126
 127         // Should disconnect the session
 128         verify(listener, timeout(15000).times(1)).disconnect();
 129         verify(deviceRpc, times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 130     }
 131
 132     @Test
 133     public void testKeepaliveSuccessWithRpcError() {
 134
 135         final DOMRpcResult rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
 136
 137         doReturn(Futures.immediateCheckedFuture(rpcSuccessWithError))
 138                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 139
 140         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 141
 142         verify(underlyingSalFacade).onDeviceConnected(
 143                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 144
 145         // Shouldn't disconnect the session
 146         verify(listener, times(0)).disconnect();
 147         verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 148     }
 149
 150     @Test
 151     public void testNonKeepaliveRpcFailure() throws Exception {
 152         doAnswer(
 153             invocationOnMock -> {
 154                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 155                 return null;
 156             }).when(underlyingSalFacade).onDeviceConnected(
 157                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 158
 159         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 160                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 161
 162         keepaliveSalFacade =
 163                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 164         keepaliveSalFacade.setListener(listener);
 165
 166         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 167
 168         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 169
 170         verify(listener, times(1)).disconnect();
 171     }
 172 }