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