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 org.junit.After;
23 import org.junit.Before;
24 import org.junit.Test;
25 import org.mockito.Mock;
26 import org.mockito.MockitoAnnotations;
27 import org.mockito.invocation.InvocationOnMock;
28 import org.mockito.stubbing.Answer;
29 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
30 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
31 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
32 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
33 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
34 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
35 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
36 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
37 import org.opendaylight.yangtools.yang.common.RpcError;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
44 public class KeepaliveSalFacadeTest {
46 private static final RemoteDeviceId REMOTE_DEVICE_ID = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
49 private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
51 private static java.util.concurrent.ScheduledExecutorService executorService;
54 private NetconfDeviceCommunicator listener;
56 private DOMRpcService deviceRpc;
58 private DOMRpcService proxyRpc;
61 public void setUp() throws Exception {
62 executorService = Executors.newScheduledThreadPool(1);
64 MockitoAnnotations.initMocks(this);
66 doNothing().when(listener).disconnect();
67 doReturn("mockedRpc").when(deviceRpc).toString();
68 doNothing().when(underlyingSalFacade).onDeviceConnected(
69 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
73 public void tearDown() throws Exception {
74 executorService.shutdownNow();
78 public void testKeepaliveSuccess() throws Exception {
79 final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
80 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
82 doReturn(Futures.immediateCheckedFuture(result)).when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
84 final KeepaliveSalFacade keepaliveSalFacade =
85 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 1L);
86 keepaliveSalFacade.setListener(listener);
88 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
90 verify(underlyingSalFacade).onDeviceConnected(
91 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
93 verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
97 public void testKeepaliveFail() throws Exception {
98 final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
99 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
101 RpcError error = mock(RpcError.class);
102 doReturn("Failure").when(error).toString();
104 final DOMRpcResult resultFailWithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
106 doReturn(Futures.immediateCheckedFuture(result))
107 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
108 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
109 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
111 final KeepaliveSalFacade keepaliveSalFacade =
112 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 1L);
113 keepaliveSalFacade.setListener(listener);
115 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
117 verify(underlyingSalFacade).onDeviceConnected(
118 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
120 // 1 failed that results in disconnect
121 verify(listener, timeout(15000).times(1)).disconnect();
123 verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
125 // Reconnect with same keepalive responses
126 doReturn(Futures.immediateCheckedFuture(result))
127 .doReturn(Futures.immediateCheckedFuture(resultFailWithResultAndError))
128 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
129 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
131 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
133 // 1 failed that results in disconnect, 2 total with previous fail
134 verify(listener, timeout(15000).times(2)).disconnect();
135 // 6 attempts now total
136 verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
138 final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
140 doReturn(Futures.immediateCheckedFuture(resultFailwithError))
141 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
143 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
145 // 1 failed that results in disconnect, 3 total with previous fail
146 verify(listener, timeout(15000).times(3)).disconnect();
150 public void testNonKeepaliveRpcFailure() throws Exception {
151 doAnswer(new Answer() {
153 public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
154 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
157 }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
159 doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
160 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
162 final KeepaliveSalFacade keepaliveSalFacade =
163 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 100L);
164 keepaliveSalFacade.setListener(listener);
166 keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
168 proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
170 verify(listener, times(1)).disconnect();