2 * Copyright (c) 2014 Brocade Communications 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.listener;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.ArgumentMatchers.any;
15 import static org.mockito.ArgumentMatchers.eq;
16 import static org.mockito.ArgumentMatchers.same;
17 import static org.mockito.Mockito.doNothing;
18 import static org.mockito.Mockito.doReturn;
19 import static org.mockito.Mockito.mock;
20 import static org.mockito.Mockito.never;
21 import static org.mockito.Mockito.reset;
22 import static org.mockito.Mockito.spy;
23 import static org.mockito.Mockito.timeout;
24 import static org.mockito.Mockito.verify;
25 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0;
27 import com.google.common.base.CharMatcher;
28 import com.google.common.base.Strings;
29 import com.google.common.collect.Sets;
30 import com.google.common.util.concurrent.ListenableFuture;
31 import io.netty.channel.ChannelFuture;
32 import io.netty.channel.EventLoopGroup;
33 import io.netty.channel.nio.NioEventLoopGroup;
34 import io.netty.util.HashedWheelTimer;
35 import io.netty.util.Timer;
36 import io.netty.util.concurrent.Future;
37 import io.netty.util.concurrent.GenericFutureListener;
38 import io.netty.util.concurrent.GlobalEventExecutor;
39 import java.io.ByteArrayInputStream;
40 import java.net.InetSocketAddress;
41 import java.util.ArrayList;
42 import java.util.Collection;
43 import java.util.Collections;
44 import java.util.UUID;
45 import java.util.concurrent.TimeUnit;
46 import java.util.concurrent.TimeoutException;
47 import javax.xml.parsers.ParserConfigurationException;
48 import org.junit.Before;
49 import org.junit.Test;
50 import org.mockito.ArgumentCaptor;
51 import org.mockito.Mock;
52 import org.mockito.MockitoAnnotations;
53 import org.opendaylight.netconf.api.NetconfMessage;
54 import org.opendaylight.netconf.api.NetconfTerminationReason;
55 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
56 import org.opendaylight.netconf.client.NetconfClientDispatcherImpl;
57 import org.opendaylight.netconf.client.NetconfClientSession;
58 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
59 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
60 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
61 import org.opendaylight.netconf.nettyutil.ReconnectStrategy;
62 import org.opendaylight.netconf.nettyutil.TimedReconnectStrategy;
63 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.LoginPasswordHandler;
64 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
65 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
66 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
67 import org.opendaylight.yangtools.util.xml.UntrustedXML;
68 import org.opendaylight.yangtools.yang.common.QName;
69 import org.opendaylight.yangtools.yang.common.RpcError;
70 import org.opendaylight.yangtools.yang.common.RpcResult;
71 import org.slf4j.Logger;
72 import org.slf4j.LoggerFactory;
73 import org.w3c.dom.Document;
74 import org.w3c.dom.Element;
76 public class NetconfDeviceCommunicatorTest {
78 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceCommunicatorTest.class);
81 NetconfClientSession mockSession;
84 RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> mockDevice;
86 NetconfDeviceCommunicator communicator;
89 public void setUp() throws Exception {
90 MockitoAnnotations.initMocks(this);
92 communicator = new NetconfDeviceCommunicator(
93 new RemoteDeviceId("test", InetSocketAddress.createUnresolved("localhost", 22)), mockDevice, 10);
97 doReturn(Collections.<String>emptySet()).when(mockSession).getServerCapabilities();
98 doNothing().when(mockDevice).onRemoteSessionUp(any(NetconfSessionPreferences.class),
99 any(NetconfDeviceCommunicator.class));
100 communicator.onSessionUp(mockSession);
103 private ListenableFuture<RpcResult<NetconfMessage>> sendRequest() throws Exception {
104 return sendRequest(UUID.randomUUID().toString(), true);
107 @SuppressWarnings("unchecked")
108 private ListenableFuture<RpcResult<NetconfMessage>> sendRequest(final String messageID,
109 final boolean doLastTest) throws Exception {
110 Document doc = UntrustedXML.newDocumentBuilder().newDocument();
111 Element element = doc.createElement("request");
112 element.setAttribute("message-id", messageID);
113 doc.appendChild(element);
114 NetconfMessage message = new NetconfMessage(doc);
116 ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
117 doReturn(mockChannelFuture).when(mockChannelFuture)
118 .addListener(any(GenericFutureListener.class));
119 doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
121 ListenableFuture<RpcResult<NetconfMessage>> resultFuture =
122 communicator.sendRequest(message, QName.create("", "mockRpc"));
124 assertNotNull("ListenableFuture is null", resultFuture);
130 public void testOnSessionUp() {
131 String testCapability = "urn:opendaylight:params:xml:ns:test?module=test-module&revision=2014-06-02";
132 Collection<String> serverCapabilities =
133 Sets.newHashSet(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString(),
134 NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString(),
136 doReturn(serverCapabilities).when(mockSession).getServerCapabilities();
138 ArgumentCaptor<NetconfSessionPreferences> netconfSessionPreferences =
139 ArgumentCaptor.forClass(NetconfSessionPreferences.class);
140 doNothing().when(mockDevice).onRemoteSessionUp(netconfSessionPreferences.capture(), eq(communicator));
142 communicator.onSessionUp(mockSession);
144 verify(mockSession).getServerCapabilities();
145 verify(mockDevice).onRemoteSessionUp(netconfSessionPreferences.capture(), eq(communicator));
147 NetconfSessionPreferences actualCapabilites = netconfSessionPreferences.getValue();
148 assertEquals("containsModuleCapability", true, actualCapabilites.containsNonModuleCapability(
149 NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString()));
150 assertEquals("containsModuleCapability", false, actualCapabilites.containsNonModuleCapability(testCapability));
151 assertEquals("getModuleBasedCaps", Sets.newHashSet(
152 QName.create("urn:opendaylight:params:xml:ns:test", "2014-06-02", "test-module")),
153 actualCapabilites.getModuleBasedCaps());
154 assertEquals("isRollbackSupported", true, actualCapabilites.isRollbackSupported());
155 assertEquals("isMonitoringSupported", true, actualCapabilites.isMonitoringSupported());
158 @SuppressWarnings("unchecked")
159 @Test(timeout = 5000)
160 public void testOnSessionDown() throws Exception {
163 ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest();
164 final ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest();
166 doNothing().when(mockDevice).onRemoteSessionDown();
168 communicator.onSessionDown(mockSession, new Exception("mock ex"));
170 verifyErrorRpcResult(resultFuture1.get(), RpcError.ErrorType.TRANSPORT, "operation-failed");
171 verifyErrorRpcResult(resultFuture2.get(), RpcError.ErrorType.TRANSPORT, "operation-failed");
173 verify(mockDevice).onRemoteSessionDown();
177 communicator.onSessionDown(mockSession, new Exception("mock ex"));
179 verify(mockDevice, never()).onRemoteSessionDown();
183 public void testOnSessionTerminated() throws Exception {
186 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest();
188 doNothing().when(mockDevice).onRemoteSessionDown();
190 String reasonText = "testing terminate";
191 NetconfTerminationReason reason = new NetconfTerminationReason(reasonText);
192 communicator.onSessionTerminated(mockSession, reason);
194 RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.TRANSPORT,
196 assertEquals("RpcError message", reasonText, rpcError.getMessage());
198 verify(mockDevice).onRemoteSessionDown();
202 public void testClose() throws Exception {
203 communicator.close();
204 verify(mockDevice, never()).onRemoteSessionDown();
207 @SuppressWarnings({"rawtypes", "unchecked"})
209 public void testSendRequest() throws Exception {
212 NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
213 QName rpc = QName.create("", "mockRpc");
215 ArgumentCaptor<GenericFutureListener> futureListener =
216 ArgumentCaptor.forClass(GenericFutureListener.class);
218 ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
219 doReturn(mockChannelFuture).when(mockChannelFuture).addListener(futureListener.capture());
220 doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
222 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
224 verify(mockSession).sendMessage(same(message));
226 assertNotNull("ListenableFuture is null", resultFuture);
228 verify(mockChannelFuture).addListener(futureListener.capture());
229 Future<Void> operationFuture = mock(Future.class);
230 doReturn(true).when(operationFuture).isSuccess();
231 doReturn(true).when(operationFuture).isDone();
232 futureListener.getValue().operationComplete(operationFuture);
235 resultFuture.get(1, TimeUnit.MILLISECONDS); // verify it's not cancelled or has an error set
236 } catch (TimeoutException e) {
237 LOG.info("Operation failed due timeout.");
242 public void testSendRequestWithNoSession() throws Exception {
243 NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
244 QName rpc = QName.create("", "mockRpc");
246 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
248 assertNotNull("ListenableFuture is null", resultFuture);
250 // Should have an immediate result
251 RpcResult<NetconfMessage> rpcResult = resultFuture.get(3, TimeUnit.MILLISECONDS);
253 verifyErrorRpcResult(rpcResult, RpcError.ErrorType.TRANSPORT, "operation-failed");
256 private static NetconfMessage createSuccessResponseMessage(final String messageID)
257 throws ParserConfigurationException {
258 Document doc = UntrustedXML.newDocumentBuilder().newDocument();
260 doc.createElementNS(URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlNetconfConstants.RPC_REPLY_KEY);
261 rpcReply.setAttribute("message-id", messageID);
262 Element element = doc.createElementNS("ns", "data");
263 element.setTextContent(messageID);
264 rpcReply.appendChild(element);
265 doc.appendChild(rpcReply);
267 return new NetconfMessage(doc);
270 @SuppressWarnings({ "rawtypes", "unchecked" })
272 public void testSendRequestWithWithSendFailure() throws Exception {
275 NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
276 QName rpc = QName.create("", "mockRpc");
278 ArgumentCaptor<GenericFutureListener> futureListener =
279 ArgumentCaptor.forClass(GenericFutureListener.class);
281 ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
282 doReturn(mockChannelFuture).when(mockChannelFuture).addListener(futureListener.capture());
283 doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
285 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
287 assertNotNull("ListenableFuture is null", resultFuture);
289 verify(mockChannelFuture).addListener(futureListener.capture());
291 Future<Void> operationFuture = mock(Future.class);
292 doReturn(false).when(operationFuture).isSuccess();
293 doReturn(true).when(operationFuture).isDone();
294 doReturn(new Exception("mock error")).when(operationFuture).cause();
295 futureListener.getValue().operationComplete(operationFuture);
297 // Should have an immediate result
298 RpcResult<NetconfMessage> rpcResult = resultFuture.get(3, TimeUnit.MILLISECONDS);
300 RpcError rpcError = verifyErrorRpcResult(rpcResult, RpcError.ErrorType.TRANSPORT, "operation-failed");
301 assertEquals("RpcError message contains \"mock error\"", true,
302 rpcError.getMessage().contains("mock error"));
305 //Test scenario verifying whether missing message is handled
307 public void testOnMissingResponseMessage() throws Exception {
311 String messageID1 = UUID.randomUUID().toString();
312 ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest(messageID1, true);
314 String messageID2 = UUID.randomUUID().toString();
315 ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest(messageID2, true);
317 String messageID3 = UUID.randomUUID().toString();
318 ListenableFuture<RpcResult<NetconfMessage>> resultFuture3 = sendRequest(messageID3, true);
320 //response messages 1,2 are omitted
321 communicator.onMessage(mockSession, createSuccessResponseMessage(messageID3));
323 verifyResponseMessage(resultFuture3.get(), messageID3);
327 public void testOnSuccessfulResponseMessage() throws Exception {
330 String messageID1 = UUID.randomUUID().toString();
331 ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest(messageID1, true);
333 String messageID2 = UUID.randomUUID().toString();
334 final ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest(messageID2, true);
336 communicator.onMessage(mockSession, createSuccessResponseMessage(messageID1));
337 communicator.onMessage(mockSession, createSuccessResponseMessage(messageID2));
339 verifyResponseMessage(resultFuture1.get(), messageID1);
340 verifyResponseMessage(resultFuture2.get(), messageID2);
344 public void testOnResponseMessageWithError() throws Exception {
347 String messageID = UUID.randomUUID().toString();
348 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID, true);
350 communicator.onMessage(mockSession, createErrorResponseMessage(messageID));
352 RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.RPC,
353 "missing-attribute");
354 assertEquals("RpcError message", "Missing attribute", rpcError.getMessage());
356 String errorInfo = rpcError.getInfo();
357 assertNotNull("RpcError info is null", errorInfo);
358 assertTrue("Error info contains \"foo\"", errorInfo.contains("<bad-attribute>foo</bad-attribute>"));
359 assertTrue("Error info contains \"bar\"", errorInfo.contains("<bad-element>bar</bad-element>"));
363 * Test whether reconnect is scheduled properly.
366 public void testNetconfDeviceReconnectInCommunicator() throws Exception {
367 final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> device =
368 mock(RemoteDevice.class);
370 final TimedReconnectStrategy timedReconnectStrategy =
371 new TimedReconnectStrategy(GlobalEventExecutor.INSTANCE, 10000, 0, 1.0, null, 100L, null);
372 final ReconnectStrategy reconnectStrategy = spy(new ReconnectStrategy() {
374 public int getConnectTimeout() throws Exception {
375 return timedReconnectStrategy.getConnectTimeout();
379 public Future<Void> scheduleReconnect(final Throwable cause) {
380 return timedReconnectStrategy.scheduleReconnect(cause);
384 public void reconnectSuccessful() {
385 timedReconnectStrategy.reconnectSuccessful();
389 final EventLoopGroup group = new NioEventLoopGroup();
390 final Timer time = new HashedWheelTimer();
392 final NetconfDeviceCommunicator listener = new NetconfDeviceCommunicator(
393 new RemoteDeviceId("test", InetSocketAddress.createUnresolved("localhost", 22)), device, 10);
394 final NetconfReconnectingClientConfiguration cfg = NetconfReconnectingClientConfigurationBuilder.create()
395 .withAddress(new InetSocketAddress("localhost", 65000))
396 .withReconnectStrategy(reconnectStrategy)
397 .withConnectStrategyFactory(() -> reconnectStrategy)
398 .withAuthHandler(new LoginPasswordHandler("admin", "admin"))
399 .withConnectionTimeoutMillis(10000)
400 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH)
401 .withSessionListener(listener)
404 listener.initializeRemoteConnection(new NetconfClientDispatcherImpl(group, group, time), cfg);
406 verify(reconnectStrategy,
407 timeout((int) TimeUnit.MINUTES.toMillis(3)).times(101)).scheduleReconnect(any(Throwable.class));
410 group.shutdownGracefully();
415 public void testOnResponseMessageWithWrongMessageID() throws Exception {
418 String messageID = UUID.randomUUID().toString();
419 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID, true);
421 communicator.onMessage(mockSession, createSuccessResponseMessage(UUID.randomUUID().toString()));
423 RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.PROTOCOL,
425 assertFalse("RpcError message non-empty", Strings.isNullOrEmpty(rpcError.getMessage()));
427 String errorInfo = rpcError.getInfo();
428 assertNotNull("RpcError info is null", errorInfo);
429 assertTrue("Error info contains \"actual-message-id\"", errorInfo.contains("actual-message-id"));
430 assertTrue("Error info contains \"expected-message-id\"", errorInfo.contains("expected-message-id"));
434 public void testConcurrentMessageLimit() throws Exception {
436 ArrayList<String> messageID = new ArrayList<>();
438 for (int i = 0; i < 10; i++) {
439 messageID.add(UUID.randomUUID().toString());
440 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID.get(i), false);
441 assertEquals("ListenableFuture is null", true, resultFuture instanceof UncancellableFuture);
444 final String notWorkingMessageID = UUID.randomUUID().toString();
445 ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(notWorkingMessageID, false);
446 assertEquals("ListenableFuture is null", false, resultFuture instanceof UncancellableFuture);
448 communicator.onMessage(mockSession, createSuccessResponseMessage(messageID.get(0)));
450 resultFuture = sendRequest(messageID.get(0), false);
451 assertNotNull("ListenableFuture is null", resultFuture);
454 private static NetconfMessage createErrorResponseMessage(final String messageID) throws Exception {
455 String xmlStr = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\""
456 + " message-id=\"" + messageID + "\">"
458 + " <error-type>rpc</error-type>"
459 + " <error-tag>missing-attribute</error-tag>"
460 + " <error-severity>error</error-severity>"
461 + " <error-message>Missing attribute</error-message>"
463 + " <bad-attribute>foo</bad-attribute>"
464 + " <bad-element>bar</bad-element>"
469 ByteArrayInputStream bis = new ByteArrayInputStream(xmlStr.getBytes());
470 Document doc = UntrustedXML.newDocumentBuilder().parse(bis);
471 return new NetconfMessage(doc);
474 private static void verifyResponseMessage(final RpcResult<NetconfMessage> rpcResult, final String dataText) {
475 assertNotNull("RpcResult is null", rpcResult);
476 assertTrue("isSuccessful", rpcResult.isSuccessful());
477 NetconfMessage messageResult = rpcResult.getResult();
478 assertNotNull("getResult", messageResult);
479 // List<SimpleNode<?>> nodes = messageResult.getSimpleNodesByName(
480 // QName.create( URI.create( "ns" ), null, "data" ) );
481 // assertNotNull( "getSimpleNodesByName", nodes );
482 // assertEquals( "List<SimpleNode<?>> size", 1, nodes.size() );
483 // assertEquals( "SimpleNode value", dataText, nodes.iterator().next().getValue() );
486 private static RpcError verifyErrorRpcResult(final RpcResult<NetconfMessage> rpcResult,
487 final RpcError.ErrorType expErrorType, final String expErrorTag) {
488 assertNotNull("RpcResult is null", rpcResult);
489 assertFalse("isSuccessful", rpcResult.isSuccessful());
490 assertNotNull("RpcResult errors is null", rpcResult.getErrors());
491 assertEquals("Errors size", 1, rpcResult.getErrors().size());
492 RpcError rpcError = rpcResult.getErrors().iterator().next();
493 assertEquals("getErrorSeverity", RpcError.ErrorSeverity.ERROR, rpcError.getSeverity());
494 assertEquals("getErrorType", expErrorType, rpcError.getErrorType());
495 assertEquals("getErrorTag", expErrorTag, rpcError.getTag());
497 final String msg = rpcError.getMessage();
498 assertNotNull("getMessage is null", msg);
499 assertFalse("getMessage is empty", msg.isEmpty());
500 assertFalse("getMessage is blank", CharMatcher.whitespace().matchesAllOf(msg));