yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/dom/serializer/YangModeledAnyXMLDeserializationTest.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.yangtools.yang.data.impl.schema.transform.dom.serializer;
   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 com.google.common.base.Optional;
  15 import com.google.common.base.Preconditions;
  16 import java.io.IOException;
  17 import java.io.InputStream;
  18 import java.net.URI;
  19 import java.util.Collection;
  20 import java.util.Collections;
  21 import java.util.List;
  22 import javax.annotation.Nonnull;
  23 import javax.xml.parsers.DocumentBuilder;
  24 import javax.xml.parsers.DocumentBuilderFactory;
  25 import javax.xml.parsers.ParserConfigurationException;
  26 import javax.xml.stream.XMLOutputFactory;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.QNameModule;
  31 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  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.LeafNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  40 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  45 import org.opendaylight.yangtools.yang.model.api.Status;
  46 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
  48 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  49 import org.w3c.dom.Document;
  50 import org.xml.sax.SAXException;
  51
  52 public class YangModeledAnyXMLDeserializationTest {
  53     private static final XMLOutputFactory XML_FACTORY;
  54     private static final DocumentBuilderFactory BUILDERFACTORY;
  55
  56     static {
  57         XML_FACTORY = XMLOutputFactory.newFactory();
  58         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
  59
  60         BUILDERFACTORY = DocumentBuilderFactory.newInstance();
  61         BUILDERFACTORY.setNamespaceAware(true);
  62         BUILDERFACTORY.setCoalescing(true);
  63         BUILDERFACTORY.setIgnoringElementContentWhitespace(true);
  64         BUILDERFACTORY.setIgnoringComments(true);
  65     }
  66
  67     private QNameModule fooModuleQName;
  68     private QNameModule barModuleQName;
  69     private QName myContainer1;
  70     private QName myContainer2;
  71     private QName innerContainer;
  72     private QName myLeaf3;
  73     private QName myLeaf2;
  74     private QName myLeaf1;
  75     private QName myAnyXMLDataBar;
  76     private QName myAnyXMLDataFoo;
  77     private SchemaContext schemaContext;
  78
  79     @Before
  80     public void Init() throws Exception {
  81         barModuleQName = QNameModule.create(new URI("bar"), SimpleDateFormatUtil.getRevisionFormat()
  82                 .parse("1970-01-01"));
  83         myContainer1 = QName.create(barModuleQName, "my-container-1");
  84         myLeaf1 = QName.create(barModuleQName, "my-leaf-1");
  85         myAnyXMLDataBar = QName.create(barModuleQName, "my-anyxml-data");
  86
  87         fooModuleQName = QNameModule.create(new URI("foo"), SimpleDateFormatUtil.getRevisionFormat()
  88                 .parse("1970-01-01"));
  89         myContainer2 = QName.create(fooModuleQName, "my-container-2");
  90         innerContainer = QName.create(fooModuleQName, "inner-container");
  91         myLeaf3 = QName.create(fooModuleQName, "my-leaf-3");
  92         myLeaf2 = QName.create(fooModuleQName, "my-leaf-2");
  93         myAnyXMLDataFoo = QName.create(fooModuleQName, "my-anyxml-data");
  94         schemaContext = YangParserTestUtils.parseYangSources("/anyxml-support/yang");
  95     }
  96
  97     @Test
  98     public void testRawAnyXMLFromBar() throws Exception {
  99         final Document doc = loadDocument("/anyxml-support/xml/bar.xml");
 100
 101         final DataSchemaNode barContainer = schemaContext.getDataChildByName(QName.create(barModuleQName, "bar"));
 102         assertTrue(barContainer instanceof ContainerSchemaNode);
 103         final YangModeledAnyXmlSchemaNode yangModeledAnyXML = new YangModeledAnyXMLSchemaNodeImplTest(myAnyXMLDataBar,
 104                 (ContainerSchemaNode) barContainer);
 105
 106         final YangModeledAnyXmlNode output = DomToNormalizedNodeParserFactory
 107                 .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext).getYangModeledAnyXmlNodeParser()
 108                 .parse(Collections.singletonList(doc.getDocumentElement()), yangModeledAnyXML);
 109
 110         assertNotNull(output);
 111
 112         final DataSchemaNode schemaOfAnyXmlData = output.getSchemaOfAnyXmlData();
 113         assertEquals(barContainer, schemaOfAnyXmlData);
 114
 115         final Collection<DataContainerChild<? extends PathArgument, ?>> value = output.getValue();
 116         assertEquals(2, value.size());
 117
 118         final Optional<DataContainerChild<? extends PathArgument, ?>> child = output
 119                 .getChild(new NodeIdentifier(myContainer1));
 120         assertTrue(child.orNull() instanceof ContainerNode);
 121         final ContainerNode myContainerNode1 = (ContainerNode) child.get();
 122
 123         final Optional<DataContainerChild<? extends PathArgument, ?>> child2 = myContainerNode1.getChild(new NodeIdentifier(
 124                 myLeaf1));
 125         assertTrue(child2.orNull() instanceof LeafNode);
 126         final LeafNode<?> LeafNode1 = (LeafNode<?>) child2.get();
 127
 128         final Object leafNode1Value = LeafNode1.getValue();
 129         assertEquals("value1", leafNode1Value);
 130     }
 131
 132     @Test
 133     public void testRealSchemaContextFromFoo() throws Exception {
 134         final Document doc = loadDocument("/anyxml-support/xml/foo.xml");
 135
 136         final ContainerNode output = DomToNormalizedNodeParserFactory
 137                 .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext).getContainerNodeParser()
 138                 .parse(Collections.singletonList(doc.getDocumentElement()), schemaContext);
 139
 140         assertNotNull(output);
 141
 142         final Optional<DataContainerChild<? extends PathArgument, ?>> child = output.getChild(new NodeIdentifier(
 143                 myAnyXMLDataFoo));
 144         assertTrue(child.orNull() instanceof YangModeledAnyXmlNode);
 145         final YangModeledAnyXmlNode yangModeledAnyXmlNode = (YangModeledAnyXmlNode) child.get();
 146
 147         final DataSchemaNode schemaOfAnyXmlData = yangModeledAnyXmlNode.getSchemaOfAnyXmlData();
 148         final DataSchemaNode expectedSchemaOfAnyXmlData = schemaContext.getDataChildByName(myContainer2);
 149         assertEquals(expectedSchemaOfAnyXmlData, schemaOfAnyXmlData);
 150
 151         final Collection<DataContainerChild<? extends PathArgument, ?>> value = yangModeledAnyXmlNode.getValue();
 152         assertEquals(2, value.size());
 153
 154         final Optional<DataContainerChild<? extends PathArgument, ?>> child2 = yangModeledAnyXmlNode
 155                 .getChild(new NodeIdentifier(innerContainer));
 156         assertTrue(child2.orNull() instanceof ContainerNode);
 157         final ContainerNode innerContainerNode = (ContainerNode) child2.get();
 158
 159         final Optional<DataContainerChild<? extends PathArgument, ?>> child3 = innerContainerNode
 160                 .getChild(new NodeIdentifier(myLeaf2));
 161         assertTrue(child3.orNull() instanceof LeafNode);
 162         final LeafNode<?> LeafNode2 = (LeafNode<?>) child3.get();
 163
 164         final Object leafNode2Value = LeafNode2.getValue();
 165         assertEquals("any-xml-leaf-2-value", leafNode2Value);
 166
 167         final Optional<DataContainerChild<? extends PathArgument, ?>> child4 = yangModeledAnyXmlNode
 168                 .getChild(new NodeIdentifier(myLeaf3));
 169         assertTrue(child4.orNull() instanceof LeafNode);
 170         final LeafNode<?> LeafNode3 = (LeafNode<?>) child4.get();
 171
 172         final Object leafNode3Value = LeafNode3.getValue();
 173         assertEquals("any-xml-leaf-3-value", leafNode3Value);
 174     }
 175
 176     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 177         final InputStream resourceAsStream = YangModeledAnyXMLDeserializationTest.class.getResourceAsStream(xmlPath);
 178
 179         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
 180         Preconditions.checkNotNull(currentConfigElement);
 181         return currentConfigElement;
 182     }
 183
 184     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 185         final DocumentBuilder dBuilder;
 186         try {
 187             dBuilder = BUILDERFACTORY.newDocumentBuilder();
 188         } catch (final ParserConfigurationException e) {
 189             throw new RuntimeException("Failed to parse XML document", e);
 190         }
 191         final Document doc = dBuilder.parse(xmlContent);
 192
 193         doc.getDocumentElement().normalize();
 194         return doc;
 195     }
 196
 197     static class YangModeledAnyXMLSchemaNodeImplTest implements YangModeledAnyXmlSchemaNode {
 198         private final QName qName;
 199         private final ContainerSchemaNode contentSchema;
 200
 201         public YangModeledAnyXMLSchemaNodeImplTest(final QName qName, final ContainerSchemaNode contentSchema) {
 202             this.qName = qName;
 203             this.contentSchema = contentSchema;
 204         }
 205
 206         @Override
 207         public boolean isAugmenting() {
 208             return false;
 209         }
 210
 211         @Override
 212         public boolean isAddedByUses() {
 213             return false;
 214         }
 215
 216         @Override
 217         public boolean isConfiguration() {
 218             return false;
 219         }
 220
 221         @Override
 222         public ConstraintDefinition getConstraints() {
 223             return null;
 224         }
 225
 226         @Nonnull
 227         @Override
 228         public QName getQName() {
 229             return qName;
 230         }
 231
 232         @Nonnull
 233         @Override
 234         public SchemaPath getPath() {
 235             return null;
 236         }
 237
 238         @Nonnull
 239         @Override
 240         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 241             return null;
 242         }
 243
 244         @Override
 245         public String getDescription() {
 246             return null;
 247         }
 248
 249         @Override
 250         public String getReference() {
 251             return null;
 252         }
 253
 254         @Nonnull
 255         @Override
 256         public Status getStatus() {
 257             return null;
 258         }
 259
 260         @Nonnull
 261         @Override
 262         public ContainerSchemaNode getSchemaOfAnyXmlData() {
 263             return contentSchema;
 264         }
 265     }
 266 }