2 * Copyright (c) 2019 Lumina Networks, Inc. All Rights Reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf.sal;
10 import static org.mockito.Mockito.after;
11 import static org.mockito.Mockito.doReturn;
12 import static org.mockito.Mockito.verify;
13 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps.getSourceNode;
14 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_NODEID;
15 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
18 import com.google.common.util.concurrent.SettableFuture;
19 import java.net.InetSocketAddress;
20 import java.util.concurrent.Executors;
21 import java.util.concurrent.ScheduledExecutorService;
22 import org.eclipse.jdt.annotation.NonNull;
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.DOMActionService;
30 import org.opendaylight.mdsal.dom.api.DOMNotification;
31 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
32 import org.opendaylight.mdsal.dom.api.DOMRpcService;
33 import org.opendaylight.mdsal.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.rfc8528.data.api.MountPointContext;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
42 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
44 @RunWith(MockitoJUnitRunner.StrictStubs.class)
45 public class KeepaliveSalFacadeResponseWaitingTest {
47 private static final RemoteDeviceId REMOTE_DEVICE_ID =
48 new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
49 private static final @NonNull ContainerNode KEEPALIVE_PAYLOAD =
50 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID,
51 getSourceNode(NETCONF_RUNNING_QNAME), NetconfMessageTransformUtil.EMPTY_FILTER);
53 private KeepaliveSalFacade keepaliveSalFacade;
54 private ScheduledExecutorService executorService;
56 private LocalNetconfSalFacade underlyingSalFacade;
59 private DOMRpcService deviceRpc;
62 private NetconfDeviceCommunicator listener;
65 public void setUp() throws Exception {
66 executorService = Executors.newScheduledThreadPool(2);
68 underlyingSalFacade = new LocalNetconfSalFacade();
69 keepaliveSalFacade = new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 2L, 10000L);
70 keepaliveSalFacade.setListener(listener);
74 public void tearDown() {
75 executorService.shutdown();
79 * Not sending keepalive rpc test while the repsonse is processing.
82 public void testKeepaliveSalResponseWaiting() {
83 //This settable future object will be never set to any value. The test wants to simulate waiting for the result
84 //of the future object.
85 final SettableFuture<DOMRpcResult> settableFuture = SettableFuture.create();
86 doReturn(settableFuture).when(deviceRpc).invokeRpc(null, null);
88 //This settable future will be used to check the invokation of keepalive RPC. Should be never invoked.
89 final SettableFuture<DOMRpcResult> keepaliveSettableFuture = SettableFuture.create();
90 final DOMRpcResult keepaliveResult = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
91 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
92 keepaliveSettableFuture.set(keepaliveResult);
94 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
96 //Invoke general RPC on simulated local facade without args (or with null args). Will be returned
97 //settableFuture variable without any set value. WaitingShaduler in keepalive sal facade should wait for any
98 //result from the RPC and reset keepalive scheduler.
99 underlyingSalFacade.invokeNullRpc();
101 //Invoking of general RPC.
102 verify(deviceRpc, after(2000).times(1)).invokeRpc(null, null);
104 //verify the keepalive RPC invoke. Should be never happen.
105 verify(deviceRpc, after(2000).never()).invokeRpc(NETCONF_GET_CONFIG_QNAME, KEEPALIVE_PAYLOAD);
108 private static final class LocalNetconfSalFacade implements RemoteDeviceHandler {
109 private DOMRpcService localDeviceRpc;
112 public void onDeviceConnected(final MountPointContext remoteSchemaContext,
113 final NetconfSessionPreferences netconfSessionPreferences, final DOMRpcService currentDeviceRpc,
114 final DOMActionService deviceAction) {
115 localDeviceRpc = currentDeviceRpc;
119 public void onDeviceDisconnected() {
123 public void onDeviceFailed(final Throwable throwable) {
127 public void onNotification(final DOMNotification domNotification) {
131 public void close() {
134 public void invokeNullRpc() {
135 if (localDeviceRpc != null) {
136 localDeviceRpc.invokeRpc(null, null);