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