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