restconf/restconf-nb-bierman02/src/test/java/org/opendaylight/controller/sal/rest/impl/test/providers/TestXmlBodyReaderMountPoint.java

   1 /*
   2  * Copyright (c) 2015 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.controller.sal.rest.impl.test.providers;
   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.Mockito.mock;
  14
  15 import java.io.File;
  16 import java.io.InputStream;
  17 import java.net.URI;
  18 import java.util.Collection;
  19 import javax.ws.rs.core.MediaType;
  20 import org.junit.Assert;
  21 import org.junit.BeforeClass;
  22 import org.junit.Test;
  23 import org.opendaylight.controller.md.sal.rest.common.TestRestconfUtils;
  24 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  25 import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
  26 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  27 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  28 import org.opendaylight.restconf.common.errors.RestconfError;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.QNameModule;
  31 import org.opendaylight.yangtools.yang.common.Revision;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  37 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  40 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  41
  42 public class TestXmlBodyReaderMountPoint extends AbstractBodyReaderTest {
  43     private final XmlNormalizedNodeBodyReader xmlBodyReader;
  44     private static SchemaContext schemaContext;
  45
  46     private static final QNameModule INSTANCE_IDENTIFIER_MODULE_QNAME = QNameModule.create(
  47         URI.create("instance:identifier:module"), Revision.of("2014-01-17"));
  48
  49     public TestXmlBodyReaderMountPoint() {
  50         super(schemaContext, mock(DOMMountPoint.class));
  51         this.xmlBodyReader = new XmlNormalizedNodeBodyReader(controllerContext);
  52     }
  53
  54     @Override
  55     protected MediaType getMediaType() {
  56         return new MediaType(MediaType.APPLICATION_XML, null);
  57     }
  58
  59     @BeforeClass
  60     public static void initialization() throws Exception {
  61         final Collection<File> testFiles = TestRestconfUtils.loadFiles("/instanceidentifier/yang");
  62         testFiles.addAll(TestRestconfUtils.loadFiles("/invoke-rpc"));
  63         schemaContext = YangParserTestUtils.parseYangFiles(testFiles);
  64     }
  65
  66     @Test
  67     public void moduleDataTest() throws Exception {
  68         final DataSchemaNode dataSchemaNode = schemaContext
  69                 .getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
  70         final String uri = "instance-identifier-module:cont/yang-ext:mount/instance-identifier-module:cont";
  71         mockBodyReader(uri, this.xmlBodyReader, false);
  72         final InputStream inputStream = TestXmlBodyReaderMountPoint.class
  73                 .getResourceAsStream("/instanceidentifier/xml/xmldata.xml");
  74         final NormalizedNodeContext returnValue = this.xmlBodyReader.readFrom(null,
  75                 null, null, this.mediaType, null, inputStream);
  76         checkMountPointNormalizedNodeContext(returnValue);
  77         checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue);
  78     }
  79
  80     @Test
  81     public void moduleSubContainerDataPutTest() throws Exception {
  82         final DataSchemaNode dataSchemaNode = schemaContext
  83                 .getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
  84         final String uri = "instance-identifier-module:cont/yang-ext:mount/instance-identifier-module:cont/cont1";
  85         mockBodyReader(uri, this.xmlBodyReader, false);
  86         final InputStream inputStream = TestXmlBodyReaderMountPoint.class
  87                 .getResourceAsStream("/instanceidentifier/xml/xml_sub_container.xml");
  88         final NormalizedNodeContext returnValue = this.xmlBodyReader.readFrom(null,
  89                 null, null, this.mediaType, null, inputStream);
  90         checkMountPointNormalizedNodeContext(returnValue);
  91         checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue,
  92                 QName.create(dataSchemaNode.getQName(), "cont1"));
  93     }
  94
  95     @Test
  96     public void moduleSubContainerDataPostTest() throws Exception {
  97         final DataSchemaNode dataSchemaNode = schemaContext
  98                 .getDataChildByName(QName.create(INSTANCE_IDENTIFIER_MODULE_QNAME, "cont"));
  99         final String uri = "instance-identifier-module:cont/yang-ext:mount/instance-identifier-module:cont";
 100         mockBodyReader(uri, this.xmlBodyReader, true);
 101         final InputStream inputStream = TestXmlBodyReaderMountPoint.class
 102                 .getResourceAsStream("/instanceidentifier/xml/xml_sub_container.xml");
 103         final NormalizedNodeContext returnValue = this.xmlBodyReader.readFrom(null,
 104                 null, null, this.mediaType, null, inputStream);
 105         checkMountPointNormalizedNodeContext(returnValue);
 106         checkExpectValueNormalizeNodeContext(dataSchemaNode, returnValue);
 107     }
 108
 109     @Test
 110     public void rpcModuleInputTest() throws Exception {
 111         final String uri = "instance-identifier-module:cont/yang-ext:mount/invoke-rpc-module:rpc-test";
 112         mockBodyReader(uri, this.xmlBodyReader, true);
 113         final InputStream inputStream = TestXmlBodyReaderMountPoint.class
 114                 .getResourceAsStream("/invoke-rpc/xml/rpc-input.xml");
 115         final NormalizedNodeContext returnValue = this.xmlBodyReader.readFrom(null,
 116                 null, null, this.mediaType, null, inputStream);
 117         checkNormalizedNodeContext(returnValue);
 118         final ContainerNode contNode = (ContainerNode) returnValue.getData();
 119         final YangInstanceIdentifier yangCont = YangInstanceIdentifier.of(QName.create(contNode.getNodeType(), "cont"));
 120         final java.util.Optional<DataContainerChild<? extends PathArgument, ?>> contDataNodePotential = contNode
 121                 .getChild(yangCont.getLastPathArgument());
 122         assertTrue(contDataNodePotential.isPresent());
 123         final ContainerNode contDataNode = (ContainerNode) contDataNodePotential.get();
 124         final YangInstanceIdentifier yangLeaf =
 125                 YangInstanceIdentifier.of(QName.create(contDataNode.getNodeType(), "lf"));
 126         final java.util.Optional<DataContainerChild<? extends PathArgument, ?>> leafDataNode = contDataNode.getChild(
 127             yangLeaf.getLastPathArgument());
 128         assertTrue(leafDataNode.isPresent());
 129         assertTrue("lf-test".equalsIgnoreCase(leafDataNode.get().getValue().toString()));
 130     }
 131
 132     private void checkExpectValueNormalizeNodeContext(
 133             final DataSchemaNode dataSchemaNode,
 134             final NormalizedNodeContext nnContext) {
 135         checkExpectValueNormalizeNodeContext(dataSchemaNode, nnContext, null);
 136     }
 137
 138     protected void checkExpectValueNormalizeNodeContext(
 139             final DataSchemaNode dataSchemaNode,
 140             final NormalizedNodeContext nnContext, final QName qualifiedName) {
 141         YangInstanceIdentifier dataNodeIdent = YangInstanceIdentifier
 142                 .of(dataSchemaNode.getQName());
 143         final DOMMountPoint mountPoint = nnContext
 144                 .getInstanceIdentifierContext().getMountPoint();
 145         final DataSchemaNode mountDataSchemaNode = mountPoint
 146                 .getSchemaContext().getDataChildByName(
 147                         dataSchemaNode.getQName());
 148         assertNotNull(mountDataSchemaNode);
 149         if (qualifiedName != null && dataSchemaNode instanceof DataNodeContainer) {
 150             final DataSchemaNode child = ((DataNodeContainer) dataSchemaNode)
 151                     .getDataChildByName(qualifiedName);
 152             dataNodeIdent = YangInstanceIdentifier.builder(dataNodeIdent)
 153                     .node(child.getQName()).build();
 154             assertTrue(nnContext.getInstanceIdentifierContext().getSchemaNode()
 155                     .equals(child));
 156         } else {
 157             assertTrue(mountDataSchemaNode.equals(dataSchemaNode));
 158         }
 159         assertNotNull(NormalizedNodes.findNode(nnContext.getData(),
 160                 dataNodeIdent));
 161     }
 162
 163     /**
 164      * Test when container with the same name is placed in two modules (foo-module and bar-module). Namespace must be
 165      * used to distinguish between them to find correct one. Check if container was found not only according to its name
 166      * but also by correct namespace used in payload.
 167      */
 168     @Test
 169     public void findFooContainerUsingNamespaceTest() throws Exception {
 170         mockBodyReader("instance-identifier-module:cont/yang-ext:mount", this.xmlBodyReader, true);
 171         final InputStream inputStream = TestXmlBodyReader.class
 172                 .getResourceAsStream("/instanceidentifier/xml/xmlDataFindFooContainer.xml");
 173         final NormalizedNodeContext returnValue = this.xmlBodyReader
 174                 .readFrom(null, null, null, this.mediaType, null, inputStream);
 175
 176         // check return value
 177         checkMountPointNormalizedNodeContext(returnValue);
 178         // check if container was found both according to its name and namespace
 179         assertEquals("Not correct container found, name was ignored",
 180                 "foo-bar-container", returnValue.getData().getNodeType().getLocalName());
 181         assertEquals("Not correct container found, namespace was ignored",
 182                 "foo:module", returnValue.getData().getNodeType().getNamespace().toString());
 183     }
 184
 185     /**
 186      * Test when container with the same name is placed in two modules (foo-module and bar-module). Namespace must be
 187      * used to distinguish between them to find correct one. Check if container was found not only according to its name
 188      * but also by correct namespace used in payload.
 189      */
 190     @Test
 191     public void findBarContainerUsingNamespaceTest() throws Exception {
 192         mockBodyReader("instance-identifier-module:cont/yang-ext:mount", this.xmlBodyReader, true);
 193         final InputStream inputStream = TestXmlBodyReader.class
 194                 .getResourceAsStream("/instanceidentifier/xml/xmlDataFindBarContainer.xml");
 195         final NormalizedNodeContext returnValue = this.xmlBodyReader
 196                 .readFrom(null, null, null, this.mediaType, null, inputStream);
 197
 198         // check return value
 199         checkMountPointNormalizedNodeContext(returnValue);
 200         // check if container was found both according to its name and namespace
 201         assertEquals("Not correct container found, name was ignored",
 202                 "foo-bar-container", returnValue.getData().getNodeType().getLocalName());
 203         assertEquals("Not correct container found, namespace was ignored",
 204                 "bar:module", returnValue.getData().getNodeType().getNamespace().toString());
 205     }
 206
 207     /**
 208      * Test PUT operation when message root element is not the same as the last element in request URI.
 209      * PUT operation message should always start with schema node from URI otherwise exception should be
 210      * thrown.
 211      */
 212     @Test
 213     public void wrongRootElementTest() throws Exception {
 214         mockBodyReader("instance-identifier-module:cont/yang-ext:mount", this.xmlBodyReader, false);
 215         final InputStream inputStream = TestXmlBodyReader.class.getResourceAsStream(
 216                 "/instanceidentifier/xml/bug7933.xml");
 217         try {
 218             this.xmlBodyReader.readFrom(null, null, null, this.mediaType, null, inputStream);
 219             Assert.fail("Test should fail due to malformed PUT operation message");
 220         } catch (final RestconfDocumentedException exception) {
 221             final RestconfError restconfError = exception.getErrors().get(0);
 222             Assert.assertEquals(RestconfError.ErrorType.PROTOCOL, restconfError.getErrorType());
 223             Assert.assertEquals(RestconfError.ErrorTag.MALFORMED_MESSAGE, restconfError.getErrorTag());
 224         }
 225     }
 226 }