yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlToNormalizedNodesTest.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
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.junit.Assert.fail;
  15
  16 import com.google.common.collect.ImmutableList;
  17 import java.io.IOException;
  18 import java.io.InputStream;
  19 import java.net.URI;
  20 import java.net.URISyntaxException;
  21 import java.util.Collections;
  22 import java.util.HashMap;
  23 import java.util.Map;
  24 import javax.xml.parsers.ParserConfigurationException;
  25 import javax.xml.stream.XMLStreamException;
  26 import javax.xml.stream.XMLStreamReader;
  27 import org.junit.AfterClass;
  28 import org.junit.BeforeClass;
  29 import org.junit.Test;
  30 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.common.QNameModule;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  37 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  48 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  51 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  52 import org.xml.sax.SAXException;
  53
  54 public class XmlToNormalizedNodesTest {
  55
  56     private static final QNameModule FOO_MODULE = QNameModule.create(URI.create("foo-namespace"));
  57     private static final QName PARENT_CONTAINER = QName.create(FOO_MODULE, "parent-container");
  58
  59     private static final QNameModule BAZ_MODULE = QNameModule.create(URI.create("baz-namespace"));
  60     private static final QName OUTER_CONTAINER = QName.create(BAZ_MODULE, "outer-container");
  61
  62     private static final QName MY_CONTAINER_1 = QName.create(BAZ_MODULE, "my-container-1");
  63     private static final QName MY_KEYED_LIST = QName.create(BAZ_MODULE, "my-keyed-list");
  64     private static final QName MY_KEY_LEAF = QName.create(BAZ_MODULE, "my-key-leaf");
  65     private static final QName MY_LEAF_IN_LIST_1 = QName.create(BAZ_MODULE, "my-leaf-in-list-1");
  66     private static final QName MY_LEAF_IN_LIST_2 = QName.create(BAZ_MODULE, "my-leaf-in-list-2");
  67     private static final QName MY_LEAF_1 = QName.create(BAZ_MODULE, "my-leaf-1");
  68     private static final QName MY_LEAFLIST = QName.create(BAZ_MODULE, "my-leaf-list");
  69
  70     private static final QName MY_CONTAINER_2 = QName.create(BAZ_MODULE, "my-container-2");
  71     private static final QName INNER_CONTAINER = QName.create(BAZ_MODULE, "inner-container");
  72     private static final QName MY_LEAF_2 = QName.create(BAZ_MODULE, "my-leaf-2");
  73     private static final QName MY_LEAF_3 = QName.create(BAZ_MODULE, "my-leaf-3");
  74     private static final QName MY_CHOICE = QName.create(BAZ_MODULE, "my-choice");
  75     private static final QName MY_LEAF_IN_CASE_2 = QName.create(BAZ_MODULE, "my-leaf-in-case-2");
  76
  77     private static final QName MY_CONTAINER_3 = QName.create(BAZ_MODULE, "my-container-3");
  78     private static final QName MY_DOUBLY_KEYED_LIST = QName.create(BAZ_MODULE, "my-doubly-keyed-list");
  79     private static final QName MY_FIRST_KEY_LEAF = QName.create(BAZ_MODULE, "my-first-key-leaf");
  80     private static final QName MY_SECOND_KEY_LEAF = QName.create(BAZ_MODULE, "my-second-key-leaf");
  81     private static final QName MY_LEAF_IN_LIST_3 = QName.create(BAZ_MODULE, "my-leaf-in-list-3");
  82
  83     private static SchemaContext schemaContext;
  84     private static ContainerSchemaNode outerContainerSchema;
  85     private static ContainerSchemaNode parentContainerSchema;
  86
  87     @BeforeClass
  88     public static void setup() {
  89         schemaContext = YangParserTestUtils.parseYangResourceDirectory("/");
  90         parentContainerSchema = (ContainerSchemaNode) SchemaContextUtil.findNodeInSchemaContext(schemaContext,
  91                 ImmutableList.of(PARENT_CONTAINER));
  92         outerContainerSchema = (ContainerSchemaNode) SchemaContextUtil.findNodeInSchemaContext(schemaContext,
  93                 ImmutableList.of(OUTER_CONTAINER));
  94     }
  95
  96     @AfterClass
  97     public static void cleanup() {
  98         schemaContext = null;
  99         parentContainerSchema = null;
 100         outerContainerSchema = null;
 101     }
 102
 103     @Test
 104     public void testComplexXmlParsing() throws IOException, SAXException, URISyntaxException, XMLStreamException,
 105             ParserConfigurationException {
 106         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/baz.xml");
 107
 108         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 109
 110         final NormalizedNodeResult result = new NormalizedNodeResult();
 111         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 112
 113         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, outerContainerSchema);
 114         xmlParser.parse(reader);
 115
 116         xmlParser.flush();
 117         xmlParser.close();
 118
 119         final NormalizedNode<?, ?> transformedInput = result.getResult();
 120         assertNotNull(transformedInput);
 121
 122         final NormalizedNode<?, ?> expectedNormalizedNode = buildOuterContainerNode();
 123         assertNotNull(expectedNormalizedNode);
 124
 125         assertEquals(expectedNormalizedNode, transformedInput);
 126     }
 127
 128     @Test
 129     public void testSimpleXmlParsing() throws IOException, URISyntaxException, XMLStreamException,
 130             ParserConfigurationException, SAXException {
 131         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/foo.xml");
 132
 133         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 134
 135         final NormalizedNodeResult result = new NormalizedNodeResult();
 136         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 137
 138         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, parentContainerSchema);
 139         xmlParser.parse(reader);
 140
 141         final NormalizedNode<?, ?> transformedInput = result.getResult();
 142         assertNotNull(transformedInput);
 143     }
 144
 145     @Test
 146     public void shouldFailOnDuplicateLeaf() throws XMLStreamException, IOException,
 147             ParserConfigurationException, SAXException, URISyntaxException {
 148         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-foo.xml");
 149
 150         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 151
 152         final NormalizedNodeResult result = new NormalizedNodeResult();
 153         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 154
 155         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, parentContainerSchema);
 156         try {
 157             xmlParser.parse(reader);
 158             fail("IllegalStateException should have been thrown because of duplicate leaf.");
 159         } catch (IllegalStateException ex) {
 160             assertTrue(ex.getMessage().contains("Duplicate element \"decimal64-leaf\" in XML input"));
 161         }
 162
 163     }
 164
 165     @Test
 166     public void shouldFailOnDuplicateAnyXml() throws XMLStreamException, IOException,
 167             ParserConfigurationException, SAXException, URISyntaxException {
 168         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-foo-2.xml");
 169
 170         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 171
 172         final NormalizedNodeResult result = new NormalizedNodeResult();
 173         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 174
 175         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, parentContainerSchema);
 176         try {
 177             xmlParser.parse(reader);
 178             fail("IllegalStateException should have been thrown because of duplicate anyxml");
 179         } catch (IllegalStateException ex) {
 180             assertTrue(ex.getMessage().contains("Duplicate element \"my-anyxml\" in XML input"));
 181         }
 182     }
 183
 184     @Test
 185     public void shouldFailOnDuplicateContainer() throws XMLStreamException, IOException,
 186             ParserConfigurationException, SAXException, URISyntaxException {
 187         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-foo-3.xml");
 188
 189         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 190
 191         final NormalizedNodeResult result = new NormalizedNodeResult();
 192         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 193
 194         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, parentContainerSchema);
 195         try {
 196             xmlParser.parse(reader);
 197             fail("IllegalStateException should have been thrown because of duplicate container");
 198         } catch (IllegalStateException ex) {
 199             assertTrue(ex.getMessage().contains("Duplicate element \"leaf-container\" in XML input"));
 200         }
 201     }
 202
 203     @Test
 204     public void shouldFailOnUnterminatedLeafElement() throws XMLStreamException, IOException,
 205             ParserConfigurationException, SAXException, URISyntaxException {
 206         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-baz.xml");
 207
 208         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 209
 210         final NormalizedNodeResult result = new NormalizedNodeResult();
 211         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 212
 213         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, outerContainerSchema);
 214         try {
 215             xmlParser.parse(reader);
 216             fail("XMLStreamException should have been thrown because of unterminated leaf element.");
 217         } catch (XMLStreamException ex) {
 218             assertTrue(ex.getMessage().contains("elementGetText() function expects text only elment but "
 219                         + "START_ELEMENT was encountered."));
 220         }
 221     }
 222
 223     @Test
 224     public void shouldFailOnUnterminatedLeafElement2() throws XMLStreamException, IOException,
 225             ParserConfigurationException, SAXException, URISyntaxException {
 226         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-baz-2.xml");
 227
 228         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 229
 230         final NormalizedNodeResult result = new NormalizedNodeResult();
 231         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 232
 233         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, outerContainerSchema);
 234         try {
 235             xmlParser.parse(reader);
 236             fail("XMLStreamException should have been thrown because of unterminated leaf element.");
 237         } catch (XMLStreamException ex) {
 238             assertTrue(ex.getMessage().contains("The element type \"my-leaf-1\" must be terminated by the matching "
 239                         + "end-tag \"</my-leaf-1>\"."));
 240         }
 241     }
 242
 243     @Test
 244     public void shouldFailOnUnterminatedContainerElement() throws XMLStreamException, IOException,
 245             ParserConfigurationException, SAXException, URISyntaxException {
 246         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-baz-4.xml");
 247
 248         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 249
 250         final NormalizedNodeResult result = new NormalizedNodeResult();
 251         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 252
 253         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, outerContainerSchema);
 254         try {
 255             xmlParser.parse(reader);
 256             fail("XMLStreamException should have been thrown because of unterminated container element.");
 257         } catch (XMLStreamException ex) {
 258             assertTrue(ex.getMessage().contains("The element type \"my-container-1\" must be terminated by the "
 259                         + "matching end-tag \"</my-container-1>\"."));
 260         }
 261     }
 262
 263     @Test
 264     public void shouldFailOnUnknownChildNode() throws XMLStreamException, IOException,
 265             ParserConfigurationException, SAXException, URISyntaxException {
 266         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream("/invalid-baz-3.xml");
 267
 268         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 269
 270         final NormalizedNodeResult result = new NormalizedNodeResult();
 271         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 272
 273         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, outerContainerSchema);
 274         try {
 275             xmlParser.parse(reader);
 276             fail("IllegalStateException should have been thrown because of an unknown child node.");
 277         } catch (IllegalStateException ex) {
 278             assertEquals("Schema for node with name my-container-1 and namespace baz-namespace does not exist at "
 279                     + "AbsoluteSchemaPath{path=[(baz-namespace)outer-container, (baz-namespace)my-container-1]}",
 280                     ex.getMessage());
 281         }
 282     }
 283
 284     private static NormalizedNode<?, ?> buildOuterContainerNode() {
 285         // my-container-1
 286         MapNode myKeyedListNode = Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(MY_KEYED_LIST))
 287                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 288                         new NodeIdentifierWithPredicates(MY_KEYED_LIST, MY_KEY_LEAF, "listkeyvalue1"))
 289                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_IN_LIST_1))
 290                                 .withValue("listleafvalue1").build())
 291                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_IN_LIST_2))
 292                                 .withValue("listleafvalue2").build()).build())
 293                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 294                         new NodeIdentifierWithPredicates(MY_KEYED_LIST, MY_KEY_LEAF, "listkeyvalue2"))
 295                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_IN_LIST_1))
 296                                 .withValue("listleafvalue12").build())
 297                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_IN_LIST_2))
 298                                 .withValue("listleafvalue22").build()).build()).build();
 299
 300         LeafNode<?> myLeaf1Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_1))
 301                 .withValue("value1").build();
 302
 303         LeafSetNode<?> myLeafListNode = Builders.leafSetBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAFLIST))
 304                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 305                         new NodeWithValue<>(MY_LEAFLIST, "lflvalue1")).withValue("lflvalue1").build())
 306                 .withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(
 307                         new NodeWithValue<>(MY_LEAFLIST, "lflvalue2")).withValue("lflvalue2").build()).build();
 308
 309         ContainerNode myContainer1Node = Builders.containerBuilder().withNodeIdentifier(
 310                 new NodeIdentifier(MY_CONTAINER_1))
 311                 .withChild(myKeyedListNode)
 312                 .withChild(myLeaf1Node)
 313                 .withChild(myLeafListNode).build();
 314
 315         // my-container-2
 316         ContainerNode innerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 317                 new NodeIdentifier(INNER_CONTAINER))
 318                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_2))
 319                         .withValue("value2").build()).build();
 320
 321         LeafNode<?> myLeaf3Node = Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_3))
 322                 .withValue("value3").build();
 323
 324         ChoiceNode myChoiceNode = Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(MY_CHOICE))
 325                 .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(MY_LEAF_IN_CASE_2))
 326                         .withValue("case2value").build()).build();
 327
 328         ContainerNode myContainer2Node = Builders.containerBuilder().withNodeIdentifier(
 329                 new NodeIdentifier(MY_CONTAINER_2))
 330                 .withChild(innerContainerNode)
 331                 .withChild(myLeaf3Node)
 332                 .withChild(myChoiceNode).build();
 333
 334         // my-container-3
 335         Map<QName, Object> keys = new HashMap<>();
 336         keys.put(MY_FIRST_KEY_LEAF, "listkeyvalue1");
 337         keys.put(MY_SECOND_KEY_LEAF, "listkeyvalue2");
 338
 339         MapNode myDoublyKeyedListNode = Builders.mapBuilder()
 340                 .withNodeIdentifier(new NodeIdentifier(MY_DOUBLY_KEYED_LIST))
 341                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(
 342                         new NodeIdentifierWithPredicates(MY_DOUBLY_KEYED_LIST, keys))
 343                         .withChild(Builders.leafBuilder().withNodeIdentifier(
 344                                 new NodeIdentifier(MY_LEAF_IN_LIST_3)).withValue("listleafvalue1").build()).build())
 345                 .build();
 346
 347         AugmentationNode myDoublyKeyedListAugNode = Builders.augmentationBuilder().withNodeIdentifier(
 348                 new AugmentationIdentifier(Collections.singleton(MY_DOUBLY_KEYED_LIST)))
 349                 .withChild(myDoublyKeyedListNode).build();
 350
 351         ContainerNode myContainer3Node = Builders.containerBuilder().withNodeIdentifier(
 352                 new NodeIdentifier(MY_CONTAINER_3))
 353                 .withChild(myDoublyKeyedListAugNode).build();
 354
 355         AugmentationNode myContainer3AugNode = Builders.augmentationBuilder().withNodeIdentifier(
 356                 new AugmentationIdentifier(Collections.singleton(MY_CONTAINER_3)))
 357                 .withChild(myContainer3Node).build();
 358
 359         ContainerNode outerContainerNode = Builders.containerBuilder().withNodeIdentifier(
 360                 new NodeIdentifier(OUTER_CONTAINER))
 361                 .withChild(myContainer1Node)
 362                 .withChild(myContainer2Node)
 363                 .withChild(myContainer3AugNode).build();
 364
 365         return outerContainerNode;
 366     }
 367 }