plugins/netconf-client-mdsal/src/test/java/org/opendaylight/netconf/client/mdsal/spi/NetconfDeviceRpcTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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.spi;
   9
  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;
  19
  20 import com.google.common.util.concurrent.Futures;
  21 import java.util.Collection;
  22 import java.util.Set;
  23 import java.util.concurrent.ExecutionException;
  24 import org.junit.AfterClass;
  25 import org.junit.Before;
  26 import org.junit.BeforeClass;
  27 import org.junit.Test;
  28 import org.junit.runner.RunWith;
  29 import org.mockito.ArgumentCaptor;
  30 import org.mockito.Mock;
  31 import org.mockito.junit.MockitoJUnitRunner;
  32 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  33 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  34 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  35 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  36 import org.opendaylight.netconf.api.messages.NetconfMessage;
  37 import org.opendaylight.netconf.api.xml.XmlUtil;
  38 import org.opendaylight.netconf.client.mdsal.AbstractBaseSchemasTest;
  39 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
  40 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceCommunicator;
  41 import org.opendaylight.netconf.client.mdsal.api.RpcTransformer;
  42 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
  43 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformer;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfData;
  45 import org.opendaylight.yangtools.yang.common.QName;
  46 import org.opendaylight.yangtools.yang.common.RpcResult;
  47 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  49 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  52 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
  53 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  54 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  55 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  56 import org.w3c.dom.Node;
  57
  58 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  59 public class NetconfDeviceRpcTest extends AbstractBaseSchemasTest {
  60     private static EffectiveModelContext SCHEMA_CONTEXT;
  61
  62     @Mock
  63     private DOMRpcAvailabilityListener listener;
  64     @Mock
  65     private RemoteDeviceCommunicator communicator;
  66
  67     private NetconfDeviceRpc rpc;
  68     private QName type;
  69     private DOMRpcResult expectedReply;
  70
  71     @BeforeClass
  72     public static void beforeClass() {
  73         SCHEMA_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfData.class);
  74     }
  75
  76     @AfterClass
  77     public static void afterClass() {
  78         SCHEMA_CONTEXT = null;
  79     }
  80
  81     @Before
  82     public void setUp() throws Exception {
  83         final var transformer = new NetconfMessageTransformer(MountPointContext.of(SCHEMA_CONTEXT), true,
  84             BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(Set.of())));
  85         final var reply = new NetconfMessage(XmlUtil.readXmlToDocument(
  86                 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
  87                         + "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\" message-id=\"101\">\n"
  88                         + "<data>\n"
  89                         + "</data>\n"
  90                         + "</rpc-reply>"));
  91         final var result = RpcResultBuilder.success(reply).build();
  92         doReturn(Futures.immediateFuture(result))
  93                 .when(communicator).sendRequest(any(NetconfMessage.class), any(QName.class));
  94         rpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicator, transformer);
  95
  96         type = QName.create("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "get-config");
  97         expectedReply = transformer.toRpcResult(RpcResultBuilder.success(reply).build(), type);
  98     }
  99
 100     @Test
 101     public void testDeadlock() throws Exception {
 102         // when rpc is successful, but transformer fails for some reason
 103         final RpcTransformer<ContainerNode, DOMRpcResult> failingTransformer = mock(RpcTransformer.class);
 104         final RemoteDeviceCommunicator communicatorMock = mock(RemoteDeviceCommunicator.class);
 105         final NetconfMessage msg = null;
 106         final RpcResult<NetconfMessage> result = RpcResultBuilder.success(msg).build();
 107         when(communicatorMock.sendRequest(any(), any())).thenReturn(Futures.immediateFuture(result));
 108         when(failingTransformer.toRpcResult(any(), any())).thenThrow(new RuntimeException("FAIL"));
 109         final var failingRpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicatorMock, failingTransformer)
 110             .domRpcService();
 111         assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, mock(ContainerNode.class)).get());
 112         assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, null).get());
 113     }
 114
 115     @Test
 116     public void testInvokeRpc() throws Exception {
 117         ContainerNode input = createNode("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "filter");
 118         final DOMRpcResult result = rpc.domRpcService().invokeRpc(type, input).get();
 119         assertEquals(expectedReply.value().name(), result.value().name());
 120         assertEquals(resolveNode(expectedReply), resolveNode(result));
 121     }
 122
 123     private static Node resolveNode(final DOMRpcResult result) {
 124         DataContainerChild value = result.value()
 125                 .findChildByArg(NetconfMessageTransformUtil.NETCONF_DATA_NODEID).orElseThrow();
 126         Node node = ((DOMSourceAnyxmlNode)value).body().getNode();
 127         assertNotNull(node);
 128         return node;
 129     }
 130
 131     @Test
 132     public void testRegisterRpcListener() throws Exception {
 133         final var argument = ArgumentCaptor.forClass(Collection.class);
 134
 135         rpc.domRpcService().registerRpcListener(listener);
 136
 137         verify(listener).onRpcAvailable(argument.capture());
 138         final Collection<DOMRpcIdentifier> argValue = argument.getValue();
 139         final Collection<? extends RpcDefinition> operations = SCHEMA_CONTEXT.getOperations();
 140         assertEquals(argValue.size(), operations.size());
 141         for (RpcDefinition operation : operations) {
 142             final DOMRpcIdentifier domRpcIdentifier = DOMRpcIdentifier.create(operation.getQName());
 143             assertTrue(argValue.contains(domRpcIdentifier));
 144         }
 145     }
 146
 147     private static ContainerNode createNode(final String namespace, final String date, final String localName) {
 148         return ImmutableNodes.newContainerBuilder()
 149             .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName)))
 150             .build();
 151     }
 152 }