yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/NormalizedNodeXmlTranslationTest.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 com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.junit.Assert.assertNotNull;
  14 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.augmentationBuilder;
  15 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.choiceBuilder;
  16 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.containerBuilder;
  17 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.leafNode;
  18
  19 import com.google.common.collect.ImmutableSet;
  20 import java.io.IOException;
  21 import java.io.InputStream;
  22 import java.io.StringWriter;
  23 import java.net.URI;
  24 import java.util.Arrays;
  25 import java.util.Collection;
  26 import java.util.HashMap;
  27 import java.util.HashSet;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import javax.xml.stream.XMLOutputFactory;
  31 import javax.xml.stream.XMLStreamReader;
  32 import javax.xml.stream.XMLStreamWriter;
  33 import javax.xml.transform.OutputKeys;
  34 import javax.xml.transform.Transformer;
  35 import javax.xml.transform.TransformerException;
  36 import javax.xml.transform.TransformerFactory;
  37 import javax.xml.transform.TransformerFactoryConfigurationError;
  38 import javax.xml.transform.dom.DOMResult;
  39 import javax.xml.transform.dom.DOMSource;
  40 import javax.xml.transform.stream.StreamResult;
  41 import org.custommonkey.xmlunit.Diff;
  42 import org.custommonkey.xmlunit.ElementNameAndTextQualifier;
  43 import org.custommonkey.xmlunit.IgnoreTextAndAttributeValuesDifferenceListener;
  44 import org.custommonkey.xmlunit.XMLUnit;
  45 import org.junit.Test;
  46 import org.junit.runner.RunWith;
  47 import org.junit.runners.Parameterized;
  48 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  49 import org.opendaylight.yangtools.yang.common.QName;
  50 import org.opendaylight.yangtools.yang.common.Revision;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  55 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  58 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  61 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  62 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  63 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  64 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  65 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  66 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  67 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  69 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  70 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  71 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  72 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  73 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  74 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  75 import org.opendaylight.yangtools.yang.model.api.Module;
  76 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  77 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  78 import org.w3c.dom.Document;
  79 import org.w3c.dom.Node;
  80 import org.xml.sax.SAXException;
  81
  82 @RunWith(Parameterized.class)
  83 public class NormalizedNodeXmlTranslationTest {
  84     private final SchemaContext schema;
  85
  86     @Parameterized.Parameters()
  87     public static Collection<Object[]> data() {
  88         return Arrays.asList(new Object[][] {
  89                 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok.xml", augmentChoiceHell() },
  90                 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok2.xml", null },
  91                 { "/schema/augment_choice_hell.yang", "/schema/augment_choice_hell_ok3.xml", augmentChoiceHell2() },
  92                 { "/schema/test.yang", "/schema/simple.xml", null },
  93                 { "/schema/test.yang", "/schema/simple2.xml", null },
  94                 // TODO check attributes
  95                 { "/schema/test.yang", "/schema/simple_xml_with_attributes.xml", withAttributes() }
  96         });
  97     }
  98
  99     private static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
 100     private static final Revision REVISION = Revision.of("2014-03-13");
 101
 102     private static ContainerNode augmentChoiceHell2() {
 103         final NodeIdentifier container = getNodeIdentifier("container");
 104         final QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
 105         final QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
 106         final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
 107         final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
 108
 109         final AugmentationIdentifier aug1Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice1QName));
 110         final AugmentationIdentifier aug2Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice2QName));
 111         final NodeIdentifier augmentChoice1Id = new NodeIdentifier(augmentChoice1QName);
 112         final NodeIdentifier augmentChoice2Id = new NodeIdentifier(augmentChoice2QName);
 113         final NodeIdentifier containerId = new NodeIdentifier(containerQName);
 114
 115         return containerBuilder().withNodeIdentifier(container)
 116                 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
 117                         .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
 118                                 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
 119                                         .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
 120                                                 .withChild(containerBuilder().withNodeIdentifier(containerId)
 121                                                         .withChild(leafNode(leafQName, "leaf-value"))
 122                                                         .build())
 123                                                 .build())
 124                                         .build())
 125                                 .build())
 126                         .build()).build();
 127     }
 128
 129     private static ContainerNode withAttributes() {
 130         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
 131         b.withNodeIdentifier(getNodeIdentifier("container"));
 132
 133         final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
 134                 getNodeIdentifier("list"));
 135
 136         final Map<QName, Object> predicates = new HashMap<>();
 137         predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
 138
 139         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
 140                 .mapEntryBuilder().withNodeIdentifier(NodeIdentifierWithPredicates.of(
 141                                 getNodeIdentifier("list").getNodeType(), predicates));
 142         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
 143                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
 144
 145         list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
 146
 147         listBuilder.withChild(list1Builder.build());
 148         b.withChild(listBuilder.build());
 149
 150         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
 151                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
 152         booleanBuilder.withValue(Boolean.FALSE);
 153         b.withChild(booleanBuilder.build());
 154
 155         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder = Builders.leafSetBuilder()
 156                 .withNodeIdentifier(getNodeIdentifier("leafList"));
 157
 158         final NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
 159                 .leafSetEntryBuilder().withNodeIdentifier(
 160                         new NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
 161
 162         leafList1Builder.withValue("a");
 163
 164         leafListBuilder.withChild(leafList1Builder.build());
 165         b.withChild(leafListBuilder.build());
 166
 167         return b.build();
 168     }
 169
 170     private static ContainerNode augmentChoiceHell() {
 171
 172         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
 173         b.withNodeIdentifier(getNodeIdentifier("container"));
 174
 175         b.withChild(choiceBuilder()
 176                 .withNodeIdentifier(getNodeIdentifier("ch2"))
 177                 .withChild(
 178                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
 179                 .withChild(
 180                         choiceBuilder()
 181                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
 182                                 .withChild(
 183                                         Builders.leafBuilder()
 184                                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
 185                                                 .withValue("2").build()).build()).build());
 186
 187         b.withChild(choiceBuilder()
 188                 .withNodeIdentifier(getNodeIdentifier("ch3"))
 189                 .withChild(
 190                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
 191                 .build());
 192
 193         b.withChild(augmentationBuilder()
 194                 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
 195                 .withChild(
 196                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
 197                                 .build()).build());
 198
 199         b.withChild(augmentationBuilder()
 200                 .withNodeIdentifier(getAugmentIdentifier("ch"))
 201                 .withChild(
 202                         choiceBuilder()
 203                                 .withNodeIdentifier(getNodeIdentifier("ch"))
 204                                 .withChild(
 205                                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
 206                                                 .withValue("1").build())
 207                                 .withChild(
 208                                         augmentationBuilder()
 209                                                 .withNodeIdentifier(
 210                                                         getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
 211                                                 .withChild(
 212                                                         Builders.leafBuilder()
 213                                                                 .withNodeIdentifier(
 214                                                                         getNodeIdentifier("c1Leaf_AnotherAugment"))
 215                                                                 .withValue("1").build())
 216                                                 .withChild(
 217                                                         choiceBuilder()
 218                                                                 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
 219                                                                 .withChild(
 220                                                                         Builders.leafBuilder()
 221                                                                                 .withNodeIdentifier(
 222                                                                                         getNodeIdentifier("deepLeafc1"))
 223                                                                                 .withValue("1").build()).build())
 224                                                 .build()).build()).build());
 225
 226         return b.build();
 227     }
 228
 229     private static NodeIdentifier getNodeIdentifier(final String localName) {
 230         return new NodeIdentifier(QName.create(URI.create(NAMESPACE), REVISION, localName));
 231     }
 232
 233     private static AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
 234         final Set<QName> qn = new HashSet<>();
 235
 236         for (final String childName : childNames) {
 237             qn.add(getNodeIdentifier(childName).getNodeType());
 238         }
 239
 240         return new AugmentationIdentifier(qn);
 241     }
 242
 243     public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
 244             final ContainerNode expectedNode) {
 245         this.schema = YangParserTestUtils.parseYangResource(yangPath);
 246         this.xmlPath = xmlPath;
 247         this.containerNode = (ContainerSchemaNode) getSchemaNode(schema, "test", "container");
 248         this.expectedNode = expectedNode;
 249     }
 250
 251     private final ContainerNode expectedNode;
 252     private final ContainerSchemaNode containerNode;
 253     private final String xmlPath;
 254
 255     @Test
 256     public void testTranslationRepairing() throws Exception {
 257         testTranslation(TestFactories.REPAIRING_OUTPUT_FACTORY);
 258     }
 259
 260     @Test
 261     public void testTranslation() throws Exception {
 262         testTranslation(TestFactories.DEFAULT_OUTPUT_FACTORY);
 263     }
 264
 265     private void testTranslation(final XMLOutputFactory factory) throws Exception {
 266         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(xmlPath);
 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, schema, containerNode);
 274         xmlParser.parse(reader);
 275
 276         final NormalizedNode<?, ?> built = result.getResult();
 277         assertNotNull(built);
 278
 279         if (expectedNode != null) {
 280             org.junit.Assert.assertEquals(expectedNode, built);
 281         }
 282
 283         final Document document = UntrustedXML.newDocumentBuilder().newDocument();
 284         final DOMResult domResult = new DOMResult(document);
 285
 286         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 287
 288         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
 289                 .create(xmlStreamWriter, schema);
 290
 291         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 292                 xmlNormalizedNodeStreamWriter);
 293
 294         normalizedNodeWriter.write(built);
 295
 296         final Document doc = loadDocument(xmlPath);
 297
 298         XMLUnit.setIgnoreWhitespace(true);
 299         XMLUnit.setIgnoreComments(true);
 300         XMLUnit.setIgnoreAttributeOrder(true);
 301         XMLUnit.setNormalize(true);
 302
 303         final String expectedXml = toString(doc.getDocumentElement());
 304         final String serializedXml = toString(domResult.getNode());
 305
 306         final Diff diff = new Diff(expectedXml, serializedXml);
 307         diff.overrideDifferenceListener(new IgnoreTextAndAttributeValuesDifferenceListener());
 308         diff.overrideElementQualifier(new ElementNameAndTextQualifier());
 309
 310         // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
 311         // this case
 312         // We need to implement custom qualifier so that the element ordering does not mess the DIFF
 313         // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
 314         // assertTrue(dd.toString(), dd.similar());
 315
 316         //new XMLTestCase() {}.assertXMLEqual(diff, true);
 317     }
 318
 319     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 320         final InputStream resourceAsStream = NormalizedNodeXmlTranslationTest.class.getResourceAsStream(xmlPath);
 321         return requireNonNull(readXmlToDocument(resourceAsStream));
 322     }
 323
 324     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 325         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 326         doc.getDocumentElement().normalize();
 327         return doc;
 328     }
 329
 330     private static String toString(final Node xml) {
 331         try {
 332             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 333             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 334             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 335
 336             final StreamResult result = new StreamResult(new StringWriter());
 337             final DOMSource source = new DOMSource(xml);
 338             transformer.transform(source, result);
 339
 340             return result.getWriter().toString();
 341         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 342             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 343         }
 344     }
 345
 346     private static DataSchemaNode getSchemaNode(final SchemaContext context, final String moduleName,
 347                                                final String childNodeName) {
 348         for (Module module : context.getModules()) {
 349             if (module.getName().equals(moduleName)) {
 350                 DataSchemaNode found = findChildNode(module, childNodeName);
 351                 checkState(found != null, "Unable to find %s", childNodeName);
 352                 return found;
 353             }
 354         }
 355         throw new IllegalStateException("Unable to find child node " + childNodeName);
 356     }
 357
 358     // FIXME: duplicate of NormalizedDataBuilderTest.findChildNode()
 359     private static DataSchemaNode findChildNode(final DataNodeContainer container, final String name) {
 360         for (DataSchemaNode dataSchemaNode : container.getChildNodes()) {
 361             if (dataSchemaNode.getQName().getLocalName().equals(name)) {
 362                 return dataSchemaNode;
 363             }
 364             if (dataSchemaNode instanceof DataNodeContainer) {
 365                 DataSchemaNode retVal = findChildNode((DataNodeContainer) dataSchemaNode, name);
 366                 if (retVal != null) {
 367                     return retVal;
 368                 }
 369             } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
 370                 for (CaseSchemaNode caseNode : ((ChoiceSchemaNode) dataSchemaNode).getCases().values()) {
 371                     DataSchemaNode retVal = findChildNode(caseNode, name);
 372                     if (retVal != null) {
 373                         return retVal;
 374                     }
 375                 }
 376             }
 377         }
 378         return null;
 379     }
 380
 381 }