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(
 141                         new NodeIdentifierWithPredicates(
 142                                 getNodeIdentifier("list").getNodeType(), predicates));
 143         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
 144                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
 145
 146         list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
 147
 148         listBuilder.withChild(list1Builder.build());
 149         b.withChild(listBuilder.build());
 150
 151         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
 152                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
 153         booleanBuilder.withValue(Boolean.FALSE);
 154         b.withChild(booleanBuilder.build());
 155
 156         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder = Builders.leafSetBuilder()
 157                 .withNodeIdentifier(getNodeIdentifier("leafList"));
 158
 159         final NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
 160                 .leafSetEntryBuilder().withNodeIdentifier(
 161                         new NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
 162
 163         leafList1Builder.withValue("a");
 164
 165         leafListBuilder.withChild(leafList1Builder.build());
 166         b.withChild(leafListBuilder.build());
 167
 168         return b.build();
 169     }
 170
 171     private static ContainerNode augmentChoiceHell() {
 172
 173         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
 174         b.withNodeIdentifier(getNodeIdentifier("container"));
 175
 176         b.withChild(choiceBuilder()
 177                 .withNodeIdentifier(getNodeIdentifier("ch2"))
 178                 .withChild(
 179                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
 180                 .withChild(
 181                         choiceBuilder()
 182                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
 183                                 .withChild(
 184                                         Builders.leafBuilder()
 185                                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
 186                                                 .withValue("2").build()).build()).build());
 187
 188         b.withChild(choiceBuilder()
 189                 .withNodeIdentifier(getNodeIdentifier("ch3"))
 190                 .withChild(
 191                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
 192                 .build());
 193
 194         b.withChild(augmentationBuilder()
 195                 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
 196                 .withChild(
 197                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
 198                                 .build()).build());
 199
 200         b.withChild(augmentationBuilder()
 201                 .withNodeIdentifier(getAugmentIdentifier("ch"))
 202                 .withChild(
 203                         choiceBuilder()
 204                                 .withNodeIdentifier(getNodeIdentifier("ch"))
 205                                 .withChild(
 206                                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
 207                                                 .withValue("1").build())
 208                                 .withChild(
 209                                         augmentationBuilder()
 210                                                 .withNodeIdentifier(
 211                                                         getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
 212                                                 .withChild(
 213                                                         Builders.leafBuilder()
 214                                                                 .withNodeIdentifier(
 215                                                                         getNodeIdentifier("c1Leaf_AnotherAugment"))
 216                                                                 .withValue("1").build())
 217                                                 .withChild(
 218                                                         choiceBuilder()
 219                                                                 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
 220                                                                 .withChild(
 221                                                                         Builders.leafBuilder()
 222                                                                                 .withNodeIdentifier(
 223                                                                                         getNodeIdentifier("deepLeafc1"))
 224                                                                                 .withValue("1").build()).build())
 225                                                 .build()).build()).build());
 226
 227         return b.build();
 228     }
 229
 230     private static NodeIdentifier getNodeIdentifier(final String localName) {
 231         return new NodeIdentifier(QName.create(URI.create(NAMESPACE), REVISION, localName));
 232     }
 233
 234     private static AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
 235         final Set<QName> qn = new HashSet<>();
 236
 237         for (final String childName : childNames) {
 238             qn.add(getNodeIdentifier(childName).getNodeType());
 239         }
 240
 241         return new AugmentationIdentifier(qn);
 242     }
 243
 244     public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
 245             final ContainerNode expectedNode) {
 246         this.schema = YangParserTestUtils.parseYangResource(yangPath);
 247         this.xmlPath = xmlPath;
 248         this.containerNode = (ContainerSchemaNode) getSchemaNode(schema, "test", "container");
 249         this.expectedNode = expectedNode;
 250     }
 251
 252     private final ContainerNode expectedNode;
 253     private final ContainerSchemaNode containerNode;
 254     private final String xmlPath;
 255
 256     @Test
 257     public void testTranslationRepairing() throws Exception {
 258         testTranslation(TestFactories.REPAIRING_OUTPUT_FACTORY);
 259     }
 260
 261     @Test
 262     public void testTranslation() throws Exception {
 263         testTranslation(TestFactories.DEFAULT_OUTPUT_FACTORY);
 264     }
 265
 266     private void testTranslation(final XMLOutputFactory factory) throws Exception {
 267         final InputStream resourceAsStream = XmlToNormalizedNodesTest.class.getResourceAsStream(xmlPath);
 268
 269         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 270
 271         final NormalizedNodeResult result = new NormalizedNodeResult();
 272         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 273
 274         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schema, containerNode);
 275         xmlParser.parse(reader);
 276
 277         final NormalizedNode<?, ?> built = result.getResult();
 278         assertNotNull(built);
 279
 280         if (expectedNode != null) {
 281             org.junit.Assert.assertEquals(expectedNode, built);
 282         }
 283
 284         final Document document = UntrustedXML.newDocumentBuilder().newDocument();
 285         final DOMResult domResult = new DOMResult(document);
 286
 287         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 288
 289         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter
 290                 .create(xmlStreamWriter, schema);
 291
 292         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 293                 xmlNormalizedNodeStreamWriter);
 294
 295         normalizedNodeWriter.write(built);
 296
 297         final Document doc = loadDocument(xmlPath);
 298
 299         XMLUnit.setIgnoreWhitespace(true);
 300         XMLUnit.setIgnoreComments(true);
 301         XMLUnit.setIgnoreAttributeOrder(true);
 302         XMLUnit.setNormalize(true);
 303
 304         final String expectedXml = toString(doc.getDocumentElement());
 305         final String serializedXml = toString(domResult.getNode());
 306
 307         final Diff diff = new Diff(expectedXml, serializedXml);
 308         diff.overrideDifferenceListener(new IgnoreTextAndAttributeValuesDifferenceListener());
 309         diff.overrideElementQualifier(new ElementNameAndTextQualifier());
 310
 311         // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
 312         // this case
 313         // We need to implement custom qualifier so that the element ordering does not mess the DIFF
 314         // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
 315         // assertTrue(dd.toString(), dd.similar());
 316
 317         //new XMLTestCase() {}.assertXMLEqual(diff, true);
 318     }
 319
 320     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 321         final InputStream resourceAsStream = NormalizedNodeXmlTranslationTest.class.getResourceAsStream(xmlPath);
 322         return requireNonNull(readXmlToDocument(resourceAsStream));
 323     }
 324
 325     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 326         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 327         doc.getDocumentElement().normalize();
 328         return doc;
 329     }
 330
 331     private static String toString(final Node xml) {
 332         try {
 333             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 334             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 335             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 336
 337             final StreamResult result = new StreamResult(new StringWriter());
 338             final DOMSource source = new DOMSource(xml);
 339             transformer.transform(source, result);
 340
 341             return result.getWriter().toString();
 342         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 343             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 344         }
 345     }
 346
 347     private static DataSchemaNode getSchemaNode(final SchemaContext context, final String moduleName,
 348                                                final String childNodeName) {
 349         for (Module module : context.getModules()) {
 350             if (module.getName().equals(moduleName)) {
 351                 DataSchemaNode found = findChildNode(module, childNodeName);
 352                 checkState(found != null, "Unable to find %s", childNodeName);
 353                 return found;
 354             }
 355         }
 356         throw new IllegalStateException("Unable to find child node " + childNodeName);
 357     }
 358
 359     // FIXME: duplicate of NormalizedDataBuilderTest.findChildNode()
 360     private static DataSchemaNode findChildNode(final DataNodeContainer container, final String name) {
 361         for (DataSchemaNode dataSchemaNode : container.getChildNodes()) {
 362             if (dataSchemaNode.getQName().getLocalName().equals(name)) {
 363                 return dataSchemaNode;
 364             }
 365             if (dataSchemaNode instanceof DataNodeContainer) {
 366                 DataSchemaNode retVal = findChildNode((DataNodeContainer) dataSchemaNode, name);
 367                 if (retVal != null) {
 368                     return retVal;
 369                 }
 370             } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
 371                 for (CaseSchemaNode caseNode : ((ChoiceSchemaNode) dataSchemaNode).getCases().values()) {
 372                     DataSchemaNode retVal = findChildNode(caseNode, name);
 373                     if (retVal != null) {
 374                         return retVal;
 375                     }
 376                 }
 377             }
 378         }
 379         return null;
 380     }
 381
 382 }