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