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