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.Matchers.any;
11 import static org.mockito.Mockito.doAnswer;
12 import static org.mockito.Mockito.doNothing;
13 import static org.mockito.Mockito.doReturn;
14 import static org.mockito.Mockito.mock;
15 import static org.mockito.Mockito.timeout;
16 import static org.mockito.Mockito.times;
17 import static org.mockito.Mockito.verify;
19 import com.google.common.util.concurrent.Futures;
20 import java.net.InetSocketAddress;
21 import java.util.concurrent.Executors;
22 import java.util.concurrent.ScheduledExecutorService;
23 import java.util.concurrent.ScheduledFuture;
24 import org.junit.After;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.mockito.Matchers;
28 import org.mockito.Mock;
29 import org.mockito.Mockito;
30 import org.mockito.MockitoAnnotations;
31 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
33 import org.opendaylight.controller.md.sal.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.yang.common.RpcError;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
42 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
46 public class KeepaliveSalFacadeTest {
48 private static final RemoteDeviceId REMOTE_DEVICE_ID =
49 new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
52 private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
54 private ScheduledExecutorService executorServiceSpy;
57 private NetconfDeviceCommunicator listener;
59 private DOMRpcService deviceRpc;
61 private DOMRpcService proxyRpc;
64 private ScheduledFuture currentKeepalive;
67 public void setUp() throws Exception {
68 executorServiceSpy = Executors.newScheduledThreadPool(1);
70 MockitoAnnotations.initMocks(this);
72 doNothing().when(listener).disconnect();
73 doReturn("mockedRpc").when(deviceRpc).toString();
74 doNothing().when(underlyingSalFacade).onDeviceConnected(
75 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
77 ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);
78 executorServiceSpy = Mockito.spy(executorService);
81 invocationOnMock.callRealMethod();
82 return currentKeepalive;
83 }).when(executorServiceSpy).schedule(Mockito.<Runnable>any(), Mockito.anyLong(), Matchers.any());
85 Mockito.when(currentKeepalive.isDone()).thenReturn(true);
89 public void tearDown() throws Exception {
90 executorServiceSpy.shutdownNow();
94 public void testKeepaliveSuccess() throws Exception {
95 final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
96 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
98 doReturn(Futures.immediateCheckedFuture(result))
99 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
101 final KeepaliveSalFacade keepaliveSalFacade =
102 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
103 keepaliveSalFacade.setListener(listener);
105 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
107 verify(underlyingSalFacade).onDeviceConnected(
108 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
110 verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
114 public void testKeepaliveFail() throws Exception {
115 final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
116 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
118 RpcError error = mock(RpcError.class);
119 doReturn("Failure").when(error).toString();
121 final DOMRpcResult resultFailWithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
123 doReturn(Futures.immediateCheckedFuture(result))
124 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
125 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
126 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
128 final KeepaliveSalFacade keepaliveSalFacade =
129 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 1L, 1L);
130 keepaliveSalFacade.setListener(listener);
132 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
134 verify(underlyingSalFacade).onDeviceConnected(
135 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
137 // 1 failed that results in disconnect
138 verify(listener, timeout(15000).times(1)).disconnect();
140 verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
142 // Reconnect with same keepalive responses
143 doReturn(Futures.immediateCheckedFuture(result))
144 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
145 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
146 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
148 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
150 // 1 failed that results in disconnect, 2 total with previous fail
151 verify(listener, timeout(15000).times(2)).disconnect();
152 // 6 attempts now total
153 verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
155 final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
157 doReturn(Futures.immediateCheckedFuture(resultFailwithError))
158 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
160 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
162 // 1 failed that results in disconnect, 3 total with previous fail
163 verify(listener, timeout(15000).times(3)).disconnect();
166 Mockito.when(currentKeepalive.isDone()).thenReturn(false);
167 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
168 // 1 failed that results in disconnect, 4 total with previous fail
169 verify(listener, timeout(15000).times(4)).disconnect();
173 public void testNonKeepaliveRpcFailure() throws Exception {
175 invocationOnMock -> {
176 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
178 }).when(underlyingSalFacade).onDeviceConnected(
179 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
181 doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
182 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
184 final KeepaliveSalFacade keepaliveSalFacade =
185 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorServiceSpy, 100L, 1L);
186 keepaliveSalFacade.setListener(listener);
188 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
190 proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
192 verify(listener, times(1)).disconnect();