yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/dom/serializer/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.impl.schema.transform.dom.serializer;
   9
  10 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.augmentationBuilder;
  11 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.choiceBuilder;
  12 import static org.opendaylight.yangtools.yang.data.impl.schema.Builders.containerBuilder;
  13 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.leafNode;
  14
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.io.IOException;
  18 import java.io.InputStream;
  19 import java.io.StringWriter;
  20 import java.net.URI;
  21 import java.text.ParseException;
  22 import java.util.Arrays;
  23 import java.util.Collection;
  24 import java.util.Collections;
  25 import java.util.Date;
  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.XMLStreamException;
  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.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.SimpleDateFormatUtil;
  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.MapNode;
  58 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  60 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  61 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  62 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
  63 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  64 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
  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.data.impl.schema.transform.dom.DomUtils;
  70 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  71 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  72 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  73 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  74 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77 import org.w3c.dom.Document;
  78 import org.w3c.dom.Element;
  79 import org.xml.sax.SAXException;
  80
  81 @RunWith(Parameterized.class)
  82 public class NormalizedNodeXmlTranslationTest {
  83     private static final Logger LOG = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
  84     private final SchemaContext schema;
  85
  86     @Parameterized.Parameters()
  87     public static Collection<Object[]> data() {
  88         return Arrays.asList(new Object[][] {
  89                 { "augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell() },
  90                 { "augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null },
  91                 { "augment_choice_hell.yang", "augment_choice_hell_ok3.xml", augmentChoiceHell2() },
  92                 { "test.yang", "simple.xml", null }, { "test.yang", "simple2.xml", null },
  93                 // TODO check attributes
  94                 { "test.yang", "simple_xml_with_attributes.xml", withAttributes() }
  95         });
  96     }
  97
  98     public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
  99     private static final Date REVISION;
 100     static {
 101         try {
 102             REVISION = SimpleDateFormatUtil.getRevisionFormat().parse("2014-03-13");
 103         } catch (final ParseException e) {
 104             throw new RuntimeException(e);
 105         }
 106     }
 107
 108     private static ContainerNode augmentChoiceHell2() {
 109         final NodeIdentifier container = getNodeIdentifier("container");
 110         QName augmentChoice1QName = QName.create(container.getNodeType(), "augment-choice1");
 111         QName augmentChoice2QName = QName.create(augmentChoice1QName, "augment-choice2");
 112         final QName containerQName = QName.create(augmentChoice1QName, "case11-choice-case-container");
 113         final QName leafQName = QName.create(augmentChoice1QName, "case11-choice-case-leaf");
 114
 115         final AugmentationIdentifier aug1Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice1QName));
 116         final AugmentationIdentifier aug2Id = new AugmentationIdentifier(ImmutableSet.of(augmentChoice2QName));
 117         final NodeIdentifier augmentChoice1Id = new NodeIdentifier(augmentChoice1QName);
 118         final NodeIdentifier augmentChoice2Id = new NodeIdentifier(augmentChoice2QName);
 119         final NodeIdentifier containerId = new NodeIdentifier(containerQName);
 120
 121         return containerBuilder().withNodeIdentifier(container)
 122                 .withChild(augmentationBuilder().withNodeIdentifier(aug1Id)
 123                         .withChild(choiceBuilder().withNodeIdentifier(augmentChoice1Id)
 124                                 .withChild(augmentationBuilder().withNodeIdentifier(aug2Id)
 125                                         .withChild(choiceBuilder().withNodeIdentifier(augmentChoice2Id)
 126                                                 .withChild(containerBuilder().withNodeIdentifier(containerId)
 127                                                         .withChild(leafNode(leafQName, "leaf-value"))
 128                                                         .build())
 129                                                 .build())
 130                                         .build())
 131                                 .build())
 132                         .build()).build();
 133     }
 134
 135     private static ContainerNode withAttributes() {
 136         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
 137         b.withNodeIdentifier(getNodeIdentifier("container"));
 138
 139         final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
 140                 getNodeIdentifier("list"));
 141
 142         final Map<QName, Object> predicates = new HashMap<>();
 143         predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
 144
 145         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
 146                 .mapEntryBuilder().withNodeIdentifier(new NodeIdentifierWithPredicates(
 147                     getNodeIdentifier("list").getNodeType(), predicates));
 148         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> uint32InListBuilder = Builders
 149                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
 150
 151         list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
 152
 153         listBuilder.withChild(list1Builder.build());
 154         b.withChild(listBuilder.build());
 155
 156         final NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> booleanBuilder = Builders
 157                 .leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
 158         booleanBuilder.withValue(Boolean.FALSE);
 159         b.withChild(booleanBuilder.build());
 160
 161         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder = Builders.leafSetBuilder()
 162                 .withNodeIdentifier(getNodeIdentifier("leafList"));
 163
 164         final NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder = Builders
 165                 .leafSetEntryBuilder().withNodeIdentifier(
 166                         new NodeWithValue<>(getNodeIdentifier("leafList").getNodeType(), "a"));
 167
 168         leafList1Builder.withValue("a");
 169
 170         leafListBuilder.withChild(leafList1Builder.build());
 171         b.withChild(leafListBuilder.build());
 172
 173         return b.build();
 174     }
 175
 176     private static ContainerNode augmentChoiceHell() {
 177
 178         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> b = containerBuilder();
 179         b.withNodeIdentifier(getNodeIdentifier("container"));
 180
 181         b.withChild(choiceBuilder()
 182                 .withNodeIdentifier(getNodeIdentifier("ch2"))
 183                 .withChild(
 184                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
 185                 .withChild(
 186                         choiceBuilder()
 187                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
 188                                 .withChild(
 189                                         Builders.leafBuilder()
 190                                                 .withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2"))
 191                                                 .withValue("2").build()).build()).build());
 192
 193         b.withChild(choiceBuilder()
 194                 .withNodeIdentifier(getNodeIdentifier("ch3"))
 195                 .withChild(
 196                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
 197                 .build());
 198
 199         b.withChild(augmentationBuilder()
 200                 .withNodeIdentifier(getAugmentIdentifier("augLeaf"))
 201                 .withChild(
 202                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment")
 203                                 .build()).build());
 204
 205         b.withChild(augmentationBuilder()
 206                 .withNodeIdentifier(getAugmentIdentifier("ch"))
 207                 .withChild(
 208                         choiceBuilder()
 209                                 .withNodeIdentifier(getNodeIdentifier("ch"))
 210                                 .withChild(
 211                                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf"))
 212                                                 .withValue("1").build())
 213                                 .withChild(
 214                                         augmentationBuilder()
 215                                                 .withNodeIdentifier(
 216                                                         getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
 217                                                 .withChild(
 218                                                         Builders.leafBuilder()
 219                                                                 .withNodeIdentifier(
 220                                                                         getNodeIdentifier("c1Leaf_AnotherAugment"))
 221                                                                 .withValue("1").build())
 222                                                 .withChild(
 223                                                         choiceBuilder()
 224                                                                 .withNodeIdentifier(getNodeIdentifier("deepChoice"))
 225                                                                 .withChild(
 226                                                                         Builders.leafBuilder()
 227                                                                                 .withNodeIdentifier(
 228                                                                                         getNodeIdentifier("deepLeafc1"))
 229                                                                                 .withValue("1").build()).build())
 230                                                 .build()).build()).build());
 231
 232         return b.build();
 233     }
 234
 235     private static NodeIdentifier getNodeIdentifier(final String localName) {
 236         return new NodeIdentifier(QName.create(URI.create(NAMESPACE), REVISION, localName));
 237     }
 238
 239     public static AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
 240         final Set<QName> qn = new HashSet<>();
 241
 242         for (final String childName : childNames) {
 243             qn.add(getNodeIdentifier(childName).getNodeType());
 244         }
 245
 246         return new AugmentationIdentifier(qn);
 247     }
 248
 249     public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath,
 250             final ContainerNode expectedNode) {
 251         schema = YangParserTestUtils.parseYangResources(NormalizedDataBuilderTest.class, yangPath);
 252         this.xmlPath = xmlPath;
 253         this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
 254         this.expectedNode = expectedNode;
 255     }
 256
 257     private final ContainerNode expectedNode;
 258     private final ContainerSchemaNode containerNode;
 259     private final String xmlPath;
 260
 261     @Test
 262     public void testTranslation() throws Exception {
 263         final Document doc = loadDocument(xmlPath);
 264
 265         final ContainerNode built = DomToNormalizedNodeParserFactory
 266                 .getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser()
 267                 .parse(Collections.singletonList(doc.getDocumentElement()), containerNode);
 268
 269         if (expectedNode != null) {
 270             org.junit.Assert.assertEquals(expectedNode, built);
 271         }
 272
 273         System.err.println(built);
 274         LOG.info("{}", built);
 275
 276         final Element elementNS = XmlDocumentUtils.getDocument().createElementNS(
 277                 containerNode.getQName().getNamespace().toString(), containerNode.getQName().getLocalName());
 278         writeNormalizedNode(built, new DOMResult(elementNS), SchemaPath.create(true), schema);
 279
 280         XMLUnit.setIgnoreWhitespace(true);
 281         XMLUnit.setIgnoreComments(true);
 282         XMLUnit.setIgnoreAttributeOrder(true);
 283         XMLUnit.setNormalize(true);
 284
 285         System.err.println(toString(doc.getDocumentElement()));
 286         System.err.println(toString(elementNS));
 287
 288         final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())),
 289                 XMLUnit.buildTestDocument(toString(elementNS)));
 290
 291         // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in
 292         // this case
 293         // We need to implement custom qualifier so that the element ordering does not mess the DIFF
 294         // dd.overrideElementQualifier(new MultiLevelElementNameAndTextQualifier(100, true));
 295         // assertTrue(dd.toString(), dd.similar());
 296     }
 297
 298     static final XMLOutputFactory XML_FACTORY;
 299     static {
 300         XML_FACTORY = XMLOutputFactory.newFactory();
 301         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.FALSE);
 302     }
 303
 304     private static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result,
 305             final SchemaPath schemaPath, final SchemaContext context) throws IOException, XMLStreamException {
 306         NormalizedNodeWriter normalizedNodeWriter = null;
 307         NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
 308         XMLStreamWriter writer = null;
 309         try {
 310             writer = XML_FACTORY.createXMLStreamWriter(result);
 311             normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
 312             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
 313
 314             normalizedNodeWriter.write(normalized);
 315
 316             normalizedNodeWriter.flush();
 317         } finally {
 318             if (normalizedNodeWriter != null) {
 319                 normalizedNodeWriter.close();
 320             }
 321             if (normalizedNodeStreamWriter != null) {
 322                 normalizedNodeStreamWriter.close();
 323             }
 324             if (writer != null) {
 325                 writer.close();
 326             }
 327         }
 328     }
 329
 330     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 331         final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
 332
 333         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
 334         return Preconditions.checkNotNull(currentConfigElement);
 335     }
 336
 337     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 338         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 339         doc.getDocumentElement().normalize();
 340         return doc;
 341     }
 342
 343     public static String toString(final Element xml) {
 344         try {
 345             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 346             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 347
 348             final StreamResult result = new StreamResult(new StringWriter());
 349             final DOMSource source = new DOMSource(xml);
 350             transformer.transform(source, result);
 351
 352             return result.getWriter().toString();
 353         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 354             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 355         }
 356     }
 357 }