netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/listener/NetconfDeviceCommunicatorTest.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.sal.connect.netconf.listener;
   9
  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;
  26
  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.junit.runner.RunWith;
  51 import org.mockito.ArgumentCaptor;
  52 import org.mockito.Mock;
  53 import org.mockito.junit.MockitoJUnitRunner;
  54 import org.opendaylight.netconf.api.NetconfMessage;
  55 import org.opendaylight.netconf.api.NetconfTerminationReason;
  56 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  57 import org.opendaylight.netconf.client.NetconfClientDispatcherImpl;
  58 import org.opendaylight.netconf.client.NetconfClientSession;
  59 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  60 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  61 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
  62 import org.opendaylight.netconf.nettyutil.ReconnectStrategy;
  63 import org.opendaylight.netconf.nettyutil.TimedReconnectStrategy;
  64 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.LoginPasswordHandler;
  65 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
  66 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  67 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  68 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  69 import org.opendaylight.yangtools.yang.common.QName;
  70 import org.opendaylight.yangtools.yang.common.RpcError;
  71 import org.opendaylight.yangtools.yang.common.RpcResult;
  72 import org.slf4j.Logger;
  73 import org.slf4j.LoggerFactory;
  74 import org.w3c.dom.Document;
  75 import org.w3c.dom.Element;
  76
  77 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  78 public class NetconfDeviceCommunicatorTest {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceCommunicatorTest.class);
  81
  82     @Mock
  83     NetconfClientSession mockSession;
  84
  85     @Mock
  86     RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> mockDevice;
  87
  88     NetconfDeviceCommunicator communicator;
  89
  90     @Before
  91     public void setUp() throws Exception {
  92         communicator = new NetconfDeviceCommunicator(
  93                 new RemoteDeviceId("test", InetSocketAddress.createUnresolved("localhost", 22)), mockDevice, 10);
  94     }
  95
  96     void setupSession() {
  97         doReturn(Collections.<String>emptySet()).when(mockSession).getServerCapabilities();
  98         doNothing().when(mockDevice).onRemoteSessionUp(any(NetconfSessionPreferences.class),
  99                 any(NetconfDeviceCommunicator.class));
 100         communicator.onSessionUp(mockSession);
 101     }
 102
 103     private ListenableFuture<RpcResult<NetconfMessage>> sendRequest() throws Exception {
 104         return sendRequest(UUID.randomUUID().toString(), true);
 105     }
 106
 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);
 115
 116         ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
 117         doReturn(mockChannelFuture).when(mockChannelFuture)
 118                 .addListener(any(GenericFutureListener.class));
 119         doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
 120
 121         ListenableFuture<RpcResult<NetconfMessage>> resultFuture =
 122                 communicator.sendRequest(message, QName.create("", "mockRpc"));
 123         if (doLastTest) {
 124             assertNotNull("ListenableFuture is null", resultFuture);
 125         }
 126         return resultFuture;
 127     }
 128
 129     @Test
 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(),
 135                         testCapability);
 136         doReturn(serverCapabilities).when(mockSession).getServerCapabilities();
 137
 138         ArgumentCaptor<NetconfSessionPreferences> netconfSessionPreferences =
 139                 ArgumentCaptor.forClass(NetconfSessionPreferences.class);
 140         doNothing().when(mockDevice).onRemoteSessionUp(netconfSessionPreferences.capture(), eq(communicator));
 141
 142         communicator.onSessionUp(mockSession);
 143
 144         verify(mockSession).getServerCapabilities();
 145         verify(mockDevice).onRemoteSessionUp(netconfSessionPreferences.capture(), eq(communicator));
 146
 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());
 156     }
 157
 158     @SuppressWarnings("unchecked")
 159     @Test(timeout = 5000)
 160     public void testOnSessionDown() throws Exception {
 161         setupSession();
 162
 163         ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest();
 164         final ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest();
 165
 166         doNothing().when(mockDevice).onRemoteSessionDown();
 167
 168         communicator.onSessionDown(mockSession, new Exception("mock ex"));
 169
 170         verifyErrorRpcResult(resultFuture1.get(), RpcError.ErrorType.TRANSPORT, "operation-failed");
 171         verifyErrorRpcResult(resultFuture2.get(), RpcError.ErrorType.TRANSPORT, "operation-failed");
 172
 173         verify(mockDevice).onRemoteSessionDown();
 174
 175         reset(mockDevice);
 176
 177         communicator.onSessionDown(mockSession, new Exception("mock ex"));
 178
 179         verify(mockDevice, never()).onRemoteSessionDown();
 180     }
 181
 182     @Test
 183     public void testOnSessionTerminated() throws Exception {
 184         setupSession();
 185
 186         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest();
 187
 188         doNothing().when(mockDevice).onRemoteSessionDown();
 189
 190         String reasonText = "testing terminate";
 191         NetconfTerminationReason reason = new NetconfTerminationReason(reasonText);
 192         communicator.onSessionTerminated(mockSession, reason);
 193
 194         RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.TRANSPORT,
 195                 "operation-failed");
 196         assertEquals("RpcError message", reasonText, rpcError.getMessage());
 197
 198         verify(mockDevice).onRemoteSessionDown();
 199     }
 200
 201     @Test
 202     public void testClose() throws Exception {
 203         communicator.close();
 204         verify(mockDevice, never()).onRemoteSessionDown();
 205     }
 206
 207     @SuppressWarnings({"rawtypes", "unchecked"})
 208     @Test
 209     public void testSendRequest() throws Exception {
 210         setupSession();
 211
 212         NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
 213         QName rpc = QName.create("", "mockRpc");
 214
 215         ArgumentCaptor<GenericFutureListener> futureListener =
 216                 ArgumentCaptor.forClass(GenericFutureListener.class);
 217
 218         ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
 219         doReturn(mockChannelFuture).when(mockChannelFuture).addListener(futureListener.capture());
 220         doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
 221
 222         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
 223
 224         verify(mockSession).sendMessage(same(message));
 225
 226         assertNotNull("ListenableFuture is null", resultFuture);
 227
 228         verify(mockChannelFuture).addListener(futureListener.capture());
 229         Future<Void> operationFuture = mock(Future.class);
 230         doReturn(true).when(operationFuture).isSuccess();
 231         futureListener.getValue().operationComplete(operationFuture);
 232
 233         try {
 234             resultFuture.get(1, TimeUnit.MILLISECONDS); // verify it's not cancelled or has an error set
 235         } catch (TimeoutException e) {
 236             LOG.info("Operation failed due timeout.");
 237         } // expected
 238     }
 239
 240     @Test
 241     public void testSendRequestWithNoSession() throws Exception {
 242         NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
 243         QName rpc = QName.create("", "mockRpc");
 244
 245         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
 246
 247         assertNotNull("ListenableFuture is null", resultFuture);
 248
 249         // Should have an immediate result
 250         RpcResult<NetconfMessage> rpcResult = resultFuture.get(3, TimeUnit.MILLISECONDS);
 251
 252         verifyErrorRpcResult(rpcResult, RpcError.ErrorType.TRANSPORT, "operation-failed");
 253     }
 254
 255     private static NetconfMessage createSuccessResponseMessage(final String messageID)
 256             throws ParserConfigurationException {
 257         Document doc = UntrustedXML.newDocumentBuilder().newDocument();
 258         Element rpcReply =
 259                 doc.createElementNS(URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlNetconfConstants.RPC_REPLY_KEY);
 260         rpcReply.setAttribute("message-id", messageID);
 261         Element element = doc.createElementNS("ns", "data");
 262         element.setTextContent(messageID);
 263         rpcReply.appendChild(element);
 264         doc.appendChild(rpcReply);
 265
 266         return new NetconfMessage(doc);
 267     }
 268
 269     @SuppressWarnings({ "rawtypes", "unchecked" })
 270     @Test
 271     public void testSendRequestWithWithSendFailure() throws Exception {
 272         setupSession();
 273
 274         NetconfMessage message = new NetconfMessage(UntrustedXML.newDocumentBuilder().newDocument());
 275         QName rpc = QName.create("", "mockRpc");
 276
 277         ArgumentCaptor<GenericFutureListener> futureListener =
 278                 ArgumentCaptor.forClass(GenericFutureListener.class);
 279
 280         ChannelFuture mockChannelFuture = mock(ChannelFuture.class);
 281         doReturn(mockChannelFuture).when(mockChannelFuture).addListener(futureListener.capture());
 282         doReturn(mockChannelFuture).when(mockSession).sendMessage(same(message));
 283
 284         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = communicator.sendRequest(message, rpc);
 285
 286         assertNotNull("ListenableFuture is null", resultFuture);
 287
 288         verify(mockChannelFuture).addListener(futureListener.capture());
 289
 290         Future<Void> operationFuture = mock(Future.class);
 291         doReturn(false).when(operationFuture).isSuccess();
 292         doReturn(new Exception("mock error")).when(operationFuture).cause();
 293         futureListener.getValue().operationComplete(operationFuture);
 294
 295         // Should have an immediate result
 296         RpcResult<NetconfMessage> rpcResult = resultFuture.get(3, TimeUnit.MILLISECONDS);
 297
 298         RpcError rpcError = verifyErrorRpcResult(rpcResult, RpcError.ErrorType.TRANSPORT, "operation-failed");
 299         assertEquals("RpcError message contains \"mock error\"", true,
 300                 rpcError.getMessage().contains("mock error"));
 301     }
 302
 303     //Test scenario verifying whether missing message is handled
 304     @Test
 305     public void testOnMissingResponseMessage() throws Exception {
 306
 307         setupSession();
 308
 309         String messageID1 = UUID.randomUUID().toString();
 310         ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest(messageID1, true);
 311
 312         String messageID2 = UUID.randomUUID().toString();
 313         ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest(messageID2, true);
 314
 315         String messageID3 = UUID.randomUUID().toString();
 316         ListenableFuture<RpcResult<NetconfMessage>> resultFuture3 = sendRequest(messageID3, true);
 317
 318         //response messages 1,2 are omitted
 319         communicator.onMessage(mockSession, createSuccessResponseMessage(messageID3));
 320
 321         verifyResponseMessage(resultFuture3.get(), messageID3);
 322     }
 323
 324     @Test
 325     public void testOnSuccessfulResponseMessage() throws Exception {
 326         setupSession();
 327
 328         String messageID1 = UUID.randomUUID().toString();
 329         ListenableFuture<RpcResult<NetconfMessage>> resultFuture1 = sendRequest(messageID1, true);
 330
 331         String messageID2 = UUID.randomUUID().toString();
 332         final ListenableFuture<RpcResult<NetconfMessage>> resultFuture2 = sendRequest(messageID2, true);
 333
 334         communicator.onMessage(mockSession, createSuccessResponseMessage(messageID1));
 335         communicator.onMessage(mockSession, createSuccessResponseMessage(messageID2));
 336
 337         verifyResponseMessage(resultFuture1.get(), messageID1);
 338         verifyResponseMessage(resultFuture2.get(), messageID2);
 339     }
 340
 341     @Test
 342     public void testOnResponseMessageWithError() throws Exception {
 343         setupSession();
 344
 345         String messageID = UUID.randomUUID().toString();
 346         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID, true);
 347
 348         communicator.onMessage(mockSession, createErrorResponseMessage(messageID));
 349
 350         RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.RPC,
 351                 "missing-attribute");
 352         assertEquals("RpcError message", "Missing attribute", rpcError.getMessage());
 353
 354         String errorInfo = rpcError.getInfo();
 355         assertNotNull("RpcError info is null", errorInfo);
 356         assertTrue("Error info contains \"foo\"", errorInfo.contains("<bad-attribute>foo</bad-attribute>"));
 357         assertTrue("Error info contains \"bar\"", errorInfo.contains("<bad-element>bar</bad-element>"));
 358     }
 359
 360     @Test
 361     public void testOnResponseMessageWithMultipleErrors() throws Exception {
 362         setupSession();
 363
 364         String messageID = UUID.randomUUID().toString();
 365         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID, true);
 366
 367         communicator.onMessage(mockSession, createMultiErrorResponseMessage(messageID));
 368
 369         RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.PROTOCOL,
 370                 "operation-failed");
 371
 372         String errorInfo = rpcError.getInfo();
 373         assertNotNull("RpcError info is null", errorInfo);
 374
 375         String errorInfoMessages = rpcError.getInfo();
 376         String errMsg1 = "Number of member links configured, i.e [1], "
 377                 + "for interface [ae0]is lesser than the required minimum [2].";
 378         String errMsg2 = "configuration check-out failed";
 379         assertTrue(String.format("Error info contains \"%s\" or \"%s\'", errMsg1, errMsg2),
 380                 errorInfoMessages.contains(errMsg1) && errorInfoMessages.contains(errMsg2));
 381     }
 382
 383     /**
 384      * Test whether reconnect is scheduled properly.
 385      */
 386     @Test
 387     public void testNetconfDeviceReconnectInCommunicator() throws Exception {
 388         final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> device =
 389                 mock(RemoteDevice.class);
 390
 391         final TimedReconnectStrategy timedReconnectStrategy =
 392                 new TimedReconnectStrategy(GlobalEventExecutor.INSTANCE, 10000, 0, 1.0, null, 100L, null);
 393         final ReconnectStrategy reconnectStrategy = spy(new ReconnectStrategy() {
 394             @Override
 395             @Deprecated
 396             public int getConnectTimeout() throws Exception {
 397                 return timedReconnectStrategy.getConnectTimeout();
 398             }
 399
 400             @Override
 401             @Deprecated
 402             public Future<Void> scheduleReconnect(final Throwable cause) {
 403                 return timedReconnectStrategy.scheduleReconnect(cause);
 404             }
 405
 406             @Override
 407             @Deprecated
 408             public void reconnectSuccessful() {
 409                 timedReconnectStrategy.reconnectSuccessful();
 410             }
 411         });
 412
 413         final EventLoopGroup group = new NioEventLoopGroup();
 414         final Timer time = new HashedWheelTimer();
 415         try {
 416             final NetconfDeviceCommunicator listener = new NetconfDeviceCommunicator(
 417                     new RemoteDeviceId("test", InetSocketAddress.createUnresolved("localhost", 22)), device, 10);
 418             final NetconfReconnectingClientConfiguration cfg = NetconfReconnectingClientConfigurationBuilder.create()
 419                     .withAddress(new InetSocketAddress("localhost", 65000))
 420                     .withReconnectStrategy(reconnectStrategy)
 421                     .withConnectStrategyFactory(() -> reconnectStrategy)
 422                     .withAuthHandler(new LoginPasswordHandler("admin", "admin"))
 423                     .withConnectionTimeoutMillis(10000)
 424                     .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH)
 425                     .withSessionListener(listener)
 426                     .build();
 427
 428             listener.initializeRemoteConnection(new NetconfClientDispatcherImpl(group, group, time), cfg);
 429
 430             verify(reconnectStrategy,
 431                     timeout((int) TimeUnit.MINUTES.toMillis(3)).times(101)).scheduleReconnect(any(Throwable.class));
 432         } finally {
 433             time.stop();
 434             group.shutdownGracefully();
 435         }
 436     }
 437
 438     @Test
 439     public void testOnResponseMessageWithWrongMessageID() throws Exception {
 440         setupSession();
 441
 442         String messageID = UUID.randomUUID().toString();
 443         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID, true);
 444
 445         communicator.onMessage(mockSession, createSuccessResponseMessage(UUID.randomUUID().toString()));
 446
 447         RpcError rpcError = verifyErrorRpcResult(resultFuture.get(), RpcError.ErrorType.PROTOCOL,
 448                 "bad-attribute");
 449         assertFalse("RpcError message non-empty", Strings.isNullOrEmpty(rpcError.getMessage()));
 450
 451         String errorInfo = rpcError.getInfo();
 452         assertNotNull("RpcError info is null", errorInfo);
 453         assertTrue("Error info contains \"actual-message-id\"", errorInfo.contains("actual-message-id"));
 454         assertTrue("Error info contains \"expected-message-id\"", errorInfo.contains("expected-message-id"));
 455     }
 456
 457     @Test
 458     public void testConcurrentMessageLimit() throws Exception {
 459         setupSession();
 460         ArrayList<String> messageID = new ArrayList<>();
 461
 462         for (int i = 0; i < 10; i++) {
 463             messageID.add(UUID.randomUUID().toString());
 464             ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(messageID.get(i), false);
 465             assertEquals("ListenableFuture is null", true, resultFuture instanceof UncancellableFuture);
 466         }
 467
 468         final String notWorkingMessageID = UUID.randomUUID().toString();
 469         ListenableFuture<RpcResult<NetconfMessage>> resultFuture = sendRequest(notWorkingMessageID, false);
 470         assertEquals("ListenableFuture is null", false, resultFuture instanceof UncancellableFuture);
 471
 472         communicator.onMessage(mockSession, createSuccessResponseMessage(messageID.get(0)));
 473
 474         resultFuture = sendRequest(messageID.get(0), false);
 475         assertNotNull("ListenableFuture is null", resultFuture);
 476     }
 477
 478     private static NetconfMessage createMultiErrorResponseMessage(final String messageID) throws Exception {
 479         // multiple rpc-errors which simulate actual response like in NETCONF-666
 480         String xmlStr = "<nc:rpc-reply xmlns:nc=\"urn:ietf:params:xml:ns:netconf:base:1.0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\" xmlns:junos=\"http://xml.juniper.net/junos/18.4R1/junos\""
 481                 + "           message-id=\"" + messageID + "\">"
 482                 + "<nc:rpc-error>\n"
 483                 + "<nc:error-type>protocol</nc:error-type>\n"
 484                 + "<nc:error-tag>operation-failed</nc:error-tag>\n"
 485                 + "<nc:error-severity>error</nc:error-severity>\n"
 486                 + "<source-daemon>\n"
 487                 + "dcd\n"
 488                 + "</source-daemon>\n"
 489                 + "<nc:error-message>\n"
 490                 + "Number of member links configured, i.e [1], "
 491                 + "for interface [ae0]is lesser than the required minimum [2].\n"
 492                 + "</nc:error-message>\n"
 493                 + "</nc:rpc-error>\n"
 494                 + "<nc:rpc-error>\n"
 495                 + "<nc:error-type>protocol</nc:error-type>\n"
 496                 + "<nc:error-tag>operation-failed</nc:error-tag>\n"
 497                 + "<nc:error-severity>error</nc:error-severity>\n"
 498                 + "<nc:error-message>\n"
 499                 + "configuration check-out failed\n"
 500                 + "</nc:error-message>\n"
 501                 + "</nc:rpc-error>\n"
 502                 + "</nc:rpc-reply>";
 503
 504         ByteArrayInputStream bis = new ByteArrayInputStream(xmlStr.getBytes());
 505         Document doc = UntrustedXML.newDocumentBuilder().parse(bis);
 506         return new NetconfMessage(doc);
 507     }
 508
 509     private static NetconfMessage createErrorResponseMessage(final String messageID) throws Exception {
 510         String xmlStr = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\""
 511                 + "           message-id=\"" + messageID + "\">"
 512                 + "  <rpc-error>"
 513                 + "    <error-type>rpc</error-type>"
 514                 + "    <error-tag>missing-attribute</error-tag>"
 515                 + "    <error-severity>error</error-severity>"
 516                 + "    <error-message>Missing attribute</error-message>"
 517                 + "    <error-info>"
 518                 + "      <bad-attribute>foo</bad-attribute>"
 519                 + "      <bad-element>bar</bad-element>"
 520                 + "    </error-info>"
 521                 + "  </rpc-error>"
 522                 + "</rpc-reply>";
 523
 524         ByteArrayInputStream bis = new ByteArrayInputStream(xmlStr.getBytes());
 525         Document doc = UntrustedXML.newDocumentBuilder().parse(bis);
 526         return new NetconfMessage(doc);
 527     }
 528
 529     private static void verifyResponseMessage(final RpcResult<NetconfMessage> rpcResult, final String dataText) {
 530         assertNotNull("RpcResult is null", rpcResult);
 531         assertTrue("isSuccessful", rpcResult.isSuccessful());
 532         NetconfMessage messageResult = rpcResult.getResult();
 533         assertNotNull("getResult", messageResult);
 534 //        List<SimpleNode<?>> nodes = messageResult.getSimpleNodesByName(
 535 //                                         QName.create( URI.create( "ns" ), null, "data" ) );
 536 //        assertNotNull( "getSimpleNodesByName", nodes );
 537 //        assertEquals( "List<SimpleNode<?>> size", 1, nodes.size() );
 538 //        assertEquals( "SimpleNode value", dataText, nodes.iterator().next().getValue() );
 539     }
 540
 541     private static RpcError verifyErrorRpcResult(final RpcResult<NetconfMessage> rpcResult,
 542                                                  final RpcError.ErrorType expErrorType, final String expErrorTag) {
 543         assertNotNull("RpcResult is null", rpcResult);
 544         assertFalse("isSuccessful", rpcResult.isSuccessful());
 545         assertNotNull("RpcResult errors is null", rpcResult.getErrors());
 546         assertEquals("Errors size", 1, rpcResult.getErrors().size());
 547         RpcError rpcError = rpcResult.getErrors().iterator().next();
 548         assertEquals("getErrorSeverity", RpcError.ErrorSeverity.ERROR, rpcError.getSeverity());
 549         assertEquals("getErrorType", expErrorType, rpcError.getErrorType());
 550         assertEquals("getErrorTag", expErrorTag, rpcError.getTag());
 551
 552         final String msg = rpcError.getMessage();
 553         assertNotNull("getMessage is null", msg);
 554         assertFalse("getMessage is empty", msg.isEmpty());
 555         assertFalse("getMessage is blank", CharMatcher.whitespace().matchesAllOf(msg));
 556         return rpcError;
 557     }
 558 }