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