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.AfterClass;
  20 import org.junit.Assert;
  21 import org.junit.Before;
  22 import org.junit.BeforeClass;
  23 import org.junit.Test;
  24 import org.mockito.ArgumentCaptor;
  25 import org.mockito.Mock;
  26 import org.mockito.MockitoAnnotations;
  27 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  28 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  30 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  31 import org.opendaylight.netconf.api.NetconfMessage;
  32 import org.opendaylight.netconf.api.xml.XmlUtil;
  33 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
  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.$YangModuleInfoImpl;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.common.RpcResult;
  39 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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     private static SchemaContext 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         final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
  66         moduleInfoBackedContext.addModuleInfos(Collections.singleton($YangModuleInfoImpl.getInstance()));
  67         SCHEMA_CONTEXT = moduleInfoBackedContext.tryToCreateSchemaContext().get();
  68     }
  69
  70     @AfterClass
  71     public static void afterClass() {
  72         SCHEMA_CONTEXT = null;
  73     }
  74
  75     @Before
  76     public void setUp() throws Exception {
  77         MockitoAnnotations.initMocks(this);
  78         NetconfMessageTransformer transformer = new NetconfMessageTransformer(SCHEMA_CONTEXT, true);
  79         final NetconfMessage reply = new NetconfMessage(XmlUtil.readXmlToDocument(
  80                 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
  81                         + "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\" message-id=\"101\">\n"
  82                         + "<data>\n"
  83                         + "</data>\n"
  84                         + "</rpc-reply>"));
  85         RpcResult<NetconfMessage> result = RpcResultBuilder.success(reply).build();
  86         doReturn(Futures.immediateFuture(result))
  87                 .when(communicator).sendRequest(any(NetconfMessage.class), any(QName.class));
  88         rpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, communicator, transformer);
  89
  90         path = SchemaPath
  91                 .create(true, QName.create("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "get-config"));
  92         expectedReply = transformer.toRpcResult(reply, path);
  93     }
  94
  95     @Test
  96     public void testInvokeRpc() throws Exception {
  97         NormalizedNode<?, ?> input = createNode("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "filter");
  98         final DOMRpcResult result = rpc.invokeRpc(path, input).get();
  99         Assert.assertEquals(expectedReply.getResult().getIdentifier(), result.getResult().getIdentifier());
 100         Assert.assertEquals(resolveNode(expectedReply), resolveNode(result));
 101     }
 102
 103     private static Node resolveNode(final DOMRpcResult result) {
 104         DataContainerChild<?, ?> value = ((ContainerNode) result.getResult())
 105                 .getChild(NetconfMessageTransformUtil.NETCONF_DATA_NODEID).get();
 106         Node node = ((AnyXmlNode)value).getValue().getNode();
 107         assertNotNull(node);
 108         return node;
 109     }
 110
 111     @Test
 112     public void testRegisterRpcListener() throws Exception {
 113         ArgumentCaptor<Collection> argument = ArgumentCaptor.forClass(Collection.class);
 114
 115         rpc.registerRpcListener(listener);
 116
 117         verify(listener).onRpcAvailable(argument.capture());
 118         final Collection<DOMRpcIdentifier> argValue = argument.getValue();
 119         final Set<RpcDefinition> operations = SCHEMA_CONTEXT.getOperations();
 120         Assert.assertEquals(argValue.size(), operations.size());
 121         for (RpcDefinition operation : operations) {
 122             final DOMRpcIdentifier domRpcIdentifier = DOMRpcIdentifier.create(operation.getPath());
 123             Assert.assertTrue(argValue.contains(domRpcIdentifier));
 124
 125         }
 126     }
 127
 128     private static ContainerNode createNode(final String namespace, final String date, final String localName) {
 129         return Builders.containerBuilder().withNodeIdentifier(
 130                 new YangInstanceIdentifier.NodeIdentifier(QName.create(namespace, date, localName))).build();
 131     }
 132 }