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