2 * Copyright (c) 2016 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.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertThrows;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.ArgumentMatchers.any;
15 import static org.mockito.Mockito.doReturn;
16 import static org.mockito.Mockito.mock;
17 import static org.mockito.Mockito.verify;
18 import static org.mockito.Mockito.when;
20 import com.google.common.util.concurrent.Futures;
21 import java.util.Collection;
22 import java.util.concurrent.ExecutionException;
23 import org.junit.AfterClass;
24 import org.junit.Before;
25 import org.junit.BeforeClass;
26 import org.junit.Test;
27 import org.junit.runner.RunWith;
28 import org.mockito.ArgumentCaptor;
29 import org.mockito.Mock;
30 import org.mockito.junit.MockitoJUnitRunner;
31 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
32 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
33 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
34 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
35 import org.opendaylight.netconf.api.NetconfMessage;
36 import org.opendaylight.netconf.api.xml.XmlUtil;
37 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceCommunicator;
38 import org.opendaylight.netconf.client.mdsal.api.RpcTransformer;
39 import org.opendaylight.netconf.sal.connect.netconf.AbstractBaseSchemasTest;
40 import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.NetconfMessageTransformer;
41 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfService;
43 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.common.RpcResult;
46 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
48 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
51 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
52 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
53 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
54 import org.w3c.dom.Node;
56 @RunWith(MockitoJUnitRunner.StrictStubs.class)
57 public class NetconfDeviceRpcTest extends AbstractBaseSchemasTest {
58 private static EffectiveModelContext SCHEMA_CONTEXT;
61 private DOMRpcAvailabilityListener listener;
63 private RemoteDeviceCommunicator communicator;
65 private NetconfDeviceRpc rpc;
67 private DOMRpcResult expectedReply;
70 public static void beforeClass() {
71 SCHEMA_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfService.class);
75 public static void afterClass() {
76 SCHEMA_CONTEXT = null;
80 public void setUp() throws Exception {
81 NetconfMessageTransformer transformer = new NetconfMessageTransformer(
82 new EmptyMountPointContext(SCHEMA_CONTEXT), true, BASE_SCHEMAS.getBaseSchema());
83 final NetconfMessage reply = new NetconfMessage(XmlUtil.readXmlToDocument(
84 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
85 + "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\" message-id=\"101\">\n"
89 RpcResult<NetconfMessage> result = RpcResultBuilder.success(reply).build();
90 doReturn(Futures.immediateFuture(result))
91 .when(communicator).sendRequest(any(NetconfMessage.class), any(QName.class));
92 rpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicator, transformer);
94 type = QName.create("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "get-config");
95 expectedReply = transformer.toRpcResult(RpcResultBuilder.success(reply).build(), type);
99 public void testDeadlock() throws Exception {
100 // when rpc is successful, but transformer fails for some reason
101 final RpcTransformer<ContainerNode, DOMRpcResult> failingTransformer = mock(RpcTransformer.class);
102 final RemoteDeviceCommunicator communicatorMock = mock(RemoteDeviceCommunicator.class);
103 final NetconfMessage msg = null;
104 final RpcResult<NetconfMessage> result = RpcResultBuilder.success(msg).build();
105 when(communicatorMock.sendRequest(any(), any())).thenReturn(Futures.immediateFuture(result));
106 when(failingTransformer.toRpcResult(any(), any())).thenThrow(new RuntimeException("FAIL"));
107 final NetconfDeviceRpc failingRpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicatorMock, failingTransformer);
108 assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, mock(ContainerNode.class)).get());
109 assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, null).get());
113 public void testInvokeRpc() throws Exception {
114 ContainerNode input = createNode("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "filter");
115 final DOMRpcResult result = rpc.invokeRpc(type, input).get();
116 assertEquals(expectedReply.value().getIdentifier(), result.value().getIdentifier());
117 assertEquals(resolveNode(expectedReply), resolveNode(result));
120 private static Node resolveNode(final DOMRpcResult result) {
121 DataContainerChild value = result.value()
122 .findChildByArg(NetconfMessageTransformUtil.NETCONF_DATA_NODEID).orElseThrow();
123 Node node = ((DOMSourceAnyxmlNode)value).body().getNode();
129 public void testRegisterRpcListener() throws Exception {
130 ArgumentCaptor<Collection> argument = ArgumentCaptor.forClass(Collection.class);
132 rpc.registerRpcListener(listener);
134 verify(listener).onRpcAvailable(argument.capture());
135 final Collection<DOMRpcIdentifier> argValue = argument.getValue();
136 final Collection<? extends RpcDefinition> operations = SCHEMA_CONTEXT.getOperations();
137 assertEquals(argValue.size(), operations.size());
138 for (RpcDefinition operation : operations) {
139 final DOMRpcIdentifier domRpcIdentifier = DOMRpcIdentifier.create(operation.getQName());
140 assertTrue(argValue.contains(domRpcIdentifier));
144 private static ContainerNode createNode(final String namespace, final String date, final String localName) {
145 return Builders.containerBuilder().withNodeIdentifier(
146 new NodeIdentifier(QName.create(namespace, date, localName))).build();