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