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