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