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.ArgumentMatchers.any;
  11 import static org.mockito.ArgumentMatchers.isNull;
  12 import static org.mockito.Mockito.doAnswer;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.timeout;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import java.net.InetSocketAddress;
  21 import java.util.concurrent.Executors;
  22 import java.util.concurrent.ScheduledExecutorService;
  23 import org.junit.After;
  24 import org.junit.Before;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.Mock;
  28 import org.mockito.junit.MockitoJUnitRunner;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  30 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  31 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  32 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  33 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  34 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  35 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  36 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.common.RpcError;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  42
  43 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  44 public class KeepaliveSalFacadeTest {
  45
  46     private static final RemoteDeviceId REMOTE_DEVICE_ID =
  47             new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  48
  49     @Mock
  50     private RemoteDeviceHandler underlyingSalFacade;
  51
  52     private ScheduledExecutorService executorServiceSpy;
  53
  54     @Mock
  55     private NetconfDeviceCommunicator listener;
  56     @Mock
  57     private DOMRpcService deviceRpc;
  58
  59     private DOMRpcService proxyRpc;
  60
  61     private KeepaliveSalFacade keepaliveSalFacade;
  62
  63     @Before
  64     public void setUp() throws Exception {
  65         executorServiceSpy = Executors.newScheduledThreadPool(1);
  66
  67         doNothing().when(listener).disconnect();
  68         doNothing().when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
  69
  70         keepaliveSalFacade =
  71                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
  72         keepaliveSalFacade.setListener(listener);
  73     }
  74
  75     @After
  76     public void tearDown() throws Exception {
  77         executorServiceSpy.shutdownNow();
  78     }
  79
  80     @Test
  81     public void testKeepaliveSuccess() throws Exception {
  82         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
  83                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
  84
  85         doReturn(FluentFutures.immediateFluentFuture(result))
  86                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
  87
  88         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
  89
  90         verify(underlyingSalFacade).onDeviceConnected(
  91                 isNull(), isNull(), any(DOMRpcService.class), isNull());
  92
  93         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(QName.class), any(ContainerNode.class));
  94     }
  95
  96     @Test
  97     public void testKeepaliveRpcFailure() {
  98
  99         doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("illegal-state")))
 100                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 101
 102         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 103
 104         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 105
 106         // Should disconnect the session
 107         verify(listener, timeout(15000).times(1)).disconnect();
 108         verify(deviceRpc, times(1)).invokeRpc(any(QName.class), any(ContainerNode.class));
 109     }
 110
 111     @Test
 112     public void testKeepaliveSuccessWithRpcError() {
 113
 114         final DOMRpcResult rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
 115
 116         doReturn(FluentFutures.immediateFluentFuture(rpcSuccessWithError))
 117                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 118
 119         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 120
 121         verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 122
 123
 124         // Shouldn't disconnect the session
 125         verify(listener, times(0)).disconnect();
 126         verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(QName.class), any(ContainerNode.class));
 127     }
 128
 129     @Test
 130     public void testNonKeepaliveRpcFailure() throws Exception {
 131         doAnswer(invocation -> proxyRpc = invocation.getArgument(2))
 132                 .when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
 133
 134         doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("illegal-state")))
 135                 .when(deviceRpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 136
 137         keepaliveSalFacade =
 138                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
 139         keepaliveSalFacade.setListener(listener);
 140
 141         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 142
 143         proxyRpc.invokeRpc(QName.create("foo", "bar"), mock(ContainerNode.class));
 144
 145         verify(listener, times(1)).disconnect();
 146     }
 147 }