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.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertNotNull;
  12 import static org.junit.jupiter.api.Assertions.assertThrows;
  13 import static org.junit.jupiter.api.Assertions.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.jupiter.api.AfterAll;
  25 import org.junit.jupiter.api.BeforeAll;
  26 import org.junit.jupiter.api.BeforeEach;
  27 import org.junit.jupiter.api.Test;
  28 import org.junit.jupiter.api.extension.ExtendWith;
  29 import org.mockito.ArgumentCaptor;
  30 import org.mockito.Mock;
  31 import org.mockito.junit.jupiter.MockitoExtension;
  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 @ExtendWith(MockitoExtension.class)
  59 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     private NetconfMessage reply;
  71
  72     @BeforeAll
  73     static void beforeClass() {
  74         SCHEMA_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfData.class);
  75     }
  76
  77     @AfterAll
  78     static void afterClass() {
  79         SCHEMA_CONTEXT = null;
  80     }
  81
  82     @BeforeEach
  83     void setUp() throws Exception {
  84         final var transformer = new NetconfMessageTransformer(MountPointContext.of(SCHEMA_CONTEXT), true,
  85             BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(Set.of())));
  86         reply = new NetconfMessage(XmlUtil.readXmlToDocument(
  87                 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
  88                         + "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\" message-id=\"101\">\n"
  89                         + "<data>\n"
  90                         + "</data>\n"
  91                         + "</rpc-reply>"));
  92         rpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicator, transformer);
  93
  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);
  96     }
  97
  98     @Test
  99     void testDeadlock() {
 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 var failingRpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicatorMock, failingTransformer)
 108             .domRpcService();
 109         assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, mock(ContainerNode.class)).get());
 110         assertThrows(ExecutionException.class, () -> failingRpc.invokeRpc(type, null).get());
 111     }
 112
 113     @Test
 114     void testInvokeRpc() throws Exception {
 115         final var rpcResult = RpcResultBuilder.success(reply).build();
 116         doReturn(Futures.immediateFuture(rpcResult)).when(communicator).sendRequest(any(NetconfMessage.class),
 117             any(QName.class));
 118         ContainerNode input = createNode("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "filter");
 119         final DOMRpcResult result = rpc.domRpcService().invokeRpc(type, input).get();
 120         assertEquals(expectedReply.value().name(), result.value().name());
 121         assertEquals(resolveNode(expectedReply), resolveNode(result));
 122     }
 123
 124     private static Node resolveNode(final DOMRpcResult result) {
 125         DataContainerChild value = result.value()
 126                 .findChildByArg(NetconfMessageTransformUtil.NETCONF_DATA_NODEID).orElseThrow();
 127         Node node = ((DOMSourceAnyxmlNode)value).body().getNode();
 128         assertNotNull(node);
 129         return node;
 130     }
 131
 132     @Test
 133     void testRegisterRpcListener() {
 134         final var argument = ArgumentCaptor.forClass(Collection.class);
 135
 136         rpc.domRpcService().registerRpcListener(listener);
 137
 138         verify(listener).onRpcAvailable(argument.capture());
 139         final Collection<DOMRpcIdentifier> argValue = argument.getValue();
 140         final Collection<? extends RpcDefinition> operations = SCHEMA_CONTEXT.getOperations();
 141         assertEquals(argValue.size(), operations.size());
 142         for (RpcDefinition operation : operations) {
 143             final DOMRpcIdentifier domRpcIdentifier = DOMRpcIdentifier.create(operation.getQName());
 144             assertTrue(argValue.contains(domRpcIdentifier));
 145         }
 146     }
 147
 148     private static ContainerNode createNode(final String namespace, final String date, final String localName) {
 149         return ImmutableNodes.newContainerBuilder()
 150             .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName)))
 151             .build();
 152     }
 153 }