2 * Copyright (c) 2015 Cisco Systems, Inc. and others. 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.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;
20 import com.google.common.util.concurrent.Futures;
21 import java.net.InetSocketAddress;
22 import java.util.concurrent.Executors;
23 import java.util.concurrent.ScheduledExecutorService;
24 import java.util.concurrent.ScheduledFuture;
25 import org.junit.After;
26 import org.junit.Before;
27 import org.junit.Test;
28 import org.mockito.Matchers;
29 import org.mockito.Mock;
30 import org.mockito.Mockito;
31 import org.mockito.MockitoAnnotations;
32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
33 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
34 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
35 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
36 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
37 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
38 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
39 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
40 import org.opendaylight.yangtools.yang.common.RpcError;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
47 public class KeepaliveSalFacadeTest {
49 private static final RemoteDeviceId REMOTE_DEVICE_ID =
50 new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
53 private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
55 private ScheduledExecutorService executorServiceSpy;
58 private NetconfDeviceCommunicator listener;
60 private DOMRpcService deviceRpc;
62 private DOMRpcService proxyRpc;
65 private ScheduledFuture currentKeepalive;
67 private KeepaliveSalFacade keepaliveSalFacade;
70 public void setUp() throws Exception {
71 executorServiceSpy = Executors.newScheduledThreadPool(1);
73 MockitoAnnotations.initMocks(this);
75 doNothing().when(listener).disconnect();
76 doReturn("mockedRpc").when(deviceRpc).toString();
77 doNothing().when(underlyingSalFacade).onDeviceConnected(
78 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
80 ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);
81 executorServiceSpy = Mockito.spy(executorService);
85 invocationOnMock.callRealMethod();
86 return currentKeepalive;
87 }).when(executorServiceSpy).schedule(Mockito.<Runnable>any(), Mockito.anyLong(), Matchers.any());
89 Mockito.when(currentKeepalive.isDone()).thenReturn(true);
92 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
93 keepaliveSalFacade.setListener(listener);
97 public void tearDown() throws Exception {
98 executorServiceSpy.shutdownNow();
102 public void testKeepaliveSuccess() throws Exception {
103 final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
104 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
106 doReturn(Futures.immediateCheckedFuture(result))
107 .when(deviceRpc).invokeRpc(any(SchemaPath.class), isNull());
109 doReturn(Futures.immediateCheckedFuture(result))
110 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
112 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
114 verify(underlyingSalFacade).onDeviceConnected(
115 isNull(), isNull(), any(DOMRpcService.class), isNull());
117 verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
121 public void testKeepaliveRpcFailure() {
123 doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
124 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
126 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
128 verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
130 // Should disconnect the session
131 verify(listener, timeout(15000).times(1)).disconnect();
132 verify(deviceRpc, times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
136 public void testKeepaliveSuccessWithRpcError() {
138 final DOMRpcResult rpcSuccessWithError = new DefaultDOMRpcResult(mock(RpcError.class));
140 doReturn(Futures.immediateCheckedFuture(rpcSuccessWithError))
141 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
143 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
145 verify(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
148 // Shouldn't disconnect the session
149 verify(listener, times(0)).disconnect();
150 verify(deviceRpc, timeout(15000).times(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
154 public void testNonKeepaliveRpcFailure() throws Exception {
156 invocationOnMock -> {
157 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
159 }).when(underlyingSalFacade).onDeviceConnected(isNull(), isNull(), any(DOMRpcService.class), isNull());
161 doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
162 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
165 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
166 keepaliveSalFacade.setListener(listener);
168 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
170 proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
172 verify(listener, times(1)).disconnect();