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