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