yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/dom/serializer/NormalizedNodeXmlTranslationTest.java

   1 /*
   2  * Copyright (c) 2013 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 com.google.common.base.Function;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.Collections2;
  13 import com.google.common.collect.Lists;
  14 import com.google.common.collect.Maps;
  15 import com.google.common.collect.Sets;
  16 import java.io.IOException;
  17 import java.io.InputStream;
  18 import java.io.StringWriter;
  19 import java.net.URI;
  20 import java.text.ParseException;
  21 import java.text.SimpleDateFormat;
  22 import java.util.Arrays;
  23 import java.util.Collection;
  24 import java.util.Collections;
  25 import java.util.Date;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import javax.xml.parsers.DocumentBuilder;
  30 import javax.xml.parsers.DocumentBuilderFactory;
  31 import javax.xml.parsers.ParserConfigurationException;
  32 import javax.xml.transform.OutputKeys;
  33 import javax.xml.transform.Transformer;
  34 import javax.xml.transform.TransformerException;
  35 import javax.xml.transform.TransformerFactory;
  36 import javax.xml.transform.TransformerFactoryConfigurationError;
  37 import javax.xml.transform.dom.DOMSource;
  38 import javax.xml.transform.stream.StreamResult;
  39 import org.custommonkey.xmlunit.DetailedDiff;
  40 import org.custommonkey.xmlunit.Diff;
  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.yang.common.QName;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  52 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedDataBuilderTest;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  59 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  61 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.Module;
  63 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  64 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67 import org.w3c.dom.Document;
  68 import org.w3c.dom.Element;
  69 import org.xml.sax.SAXException;
  70
  71 @RunWith(Parameterized.class)
  72 public class NormalizedNodeXmlTranslationTest {
  73     private static final Logger logger = LoggerFactory.getLogger(NormalizedNodeXmlTranslationTest.class);
  74     private final SchemaContext schema;
  75
  76     @Parameterized.Parameters()
  77     public static Collection<Object[]> data() {
  78         return Arrays.asList(new Object[][]{
  79                 {"augment_choice_hell.yang", "augment_choice_hell_ok.xml", augmentChoiceHell()},
  80                 {"augment_choice_hell.yang", "augment_choice_hell_ok2.xml", null},
  81                 {"test.yang", "simple.xml", null},
  82                 {"test.yang", "simple2.xml", null},
  83                 // TODO check attributes
  84                 {"test.yang", "simple_xml_with_attributes.xml", withAttributes()}
  85         });
  86     }
  87
  88
  89     public static final String NAMESPACE = "urn:opendaylight:params:xml:ns:yang:controller:test";
  90     private static Date revision;
  91     static {
  92         try {
  93             revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-03-13");
  94         } catch (final ParseException e) {
  95             throw new RuntimeException(e);
  96         }
  97     }
  98
  99     private static ContainerNode withAttributes() {
 100         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
 101         b.withNodeIdentifier(getNodeIdentifier("container"));
 102
 103         final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = Builders.mapBuilder().withNodeIdentifier(
 104                 getNodeIdentifier("list"));
 105
 106         final Map<QName, Object> predicates = Maps.newHashMap();
 107         predicates.put(getNodeIdentifier("uint32InList").getNodeType(), 3L);
 108
 109         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> list1Builder = Builders
 110                 .mapEntryBuilder().withNodeIdentifier(
 111                         new YangInstanceIdentifier.NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
 112                                 predicates));
 113         final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier,Object,LeafNode<Object>> uint32InListBuilder
 114         = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"));
 115
 116         list1Builder.withChild(uint32InListBuilder.withValue(3L).build());
 117
 118         listBuilder.withChild(list1Builder.build());
 119         b.withChild(listBuilder.build());
 120
 121         final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>> booleanBuilder
 122         = Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("boolean"));
 123         booleanBuilder.withValue(false);
 124         b.withChild(booleanBuilder.build());
 125
 126         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListBuilder
 127         = Builders.leafSetBuilder().withNodeIdentifier(getNodeIdentifier("leafList"));
 128
 129         final NormalizedNodeBuilder<YangInstanceIdentifier.NodeWithValue, Object, LeafSetEntryNode<Object>> leafList1Builder
 130         = Builders.leafSetEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeWithValue(getNodeIdentifier("leafList").getNodeType(), "a"));
 131
 132         leafList1Builder.withValue("a");
 133
 134         leafListBuilder.withChild(leafList1Builder.build());
 135         b.withChild(leafListBuilder.build());
 136
 137         return b.build();
 138     }
 139
 140     private static ContainerNode augmentChoiceHell() {
 141
 142         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
 143         b.withNodeIdentifier(getNodeIdentifier("container"));
 144
 145         b.withChild(
 146                 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch2"))
 147                 .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2Leaf")).withValue("2").build())
 148                 .withChild(
 149                         Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoice"))
 150                         .withChild(Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c2DeepChoiceCase1Leaf2")).withValue("2").build())
 151                         .build()
 152                         )
 153                         .build()
 154                 );
 155
 156         b.withChild(
 157                 Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch3")).withChild(
 158                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c3Leaf")).withValue("3").build())
 159                         .build());
 160
 161         b.withChild(
 162                 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("augLeaf")).withChild(
 163                         Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("augLeaf")).withValue("augment").build())
 164                         .build());
 165
 166         b.withChild(
 167                 Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("ch")).withChild(
 168                         Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("ch"))
 169                         .withChild(
 170                                 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf")).withValue("1").build())
 171                                 .withChild(
 172                                         Builders.augmentationBuilder().withNodeIdentifier(getAugmentIdentifier("c1Leaf_AnotherAugment", "deepChoice"))
 173                                         .withChild(
 174                                                 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("c1Leaf_AnotherAugment")).withValue("1").build())
 175                                                 .withChild(
 176                                                         Builders.choiceBuilder().withNodeIdentifier(getNodeIdentifier("deepChoice"))
 177                                                         .withChild(
 178                                                                 Builders.leafBuilder().withNodeIdentifier(getNodeIdentifier("deepLeafc1")).withValue("1").build()
 179                                                                 ).build()
 180                                                         ).build()
 181                                         ).build()
 182                         ).build());
 183
 184         return b.build();
 185     }
 186
 187     private static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName) {
 188         return new YangInstanceIdentifier.NodeIdentifier(QName.create(URI.create(NAMESPACE), revision, localName));
 189     }
 190
 191     public static YangInstanceIdentifier.AugmentationIdentifier getAugmentIdentifier(final String... childNames) {
 192         final Set<QName> qn = Sets.newHashSet();
 193
 194         for (final String childName : childNames) {
 195             qn.add(getNodeIdentifier(childName).getNodeType());
 196         }
 197
 198         return new YangInstanceIdentifier.AugmentationIdentifier(qn);
 199     }
 200
 201     public NormalizedNodeXmlTranslationTest(final String yangPath, final String xmlPath, final ContainerNode expectedNode) {
 202         schema = parseTestSchema(yangPath);
 203         this.xmlPath = xmlPath;
 204         this.containerNode = (ContainerSchemaNode) NormalizedDataBuilderTest.getSchemaNode(schema, "test", "container");
 205         this.expectedNode = expectedNode;
 206     }
 207
 208     private final ContainerNode expectedNode;
 209     private final ContainerSchemaNode containerNode;
 210     private final String xmlPath;
 211
 212
 213     SchemaContext parseTestSchema(final String... yangPath) {
 214         final YangParserImpl yangParserImpl = new YangParserImpl();
 215         final Set<Module> modules = yangParserImpl.parseYangModelsFromStreams(getTestYangs(yangPath));
 216         return yangParserImpl.resolveSchemaContext(modules);
 217     }
 218
 219     List<InputStream> getTestYangs(final String... yangPaths) {
 220
 221         return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
 222                 new Function<String, InputStream>() {
 223             @Override
 224             public InputStream apply(final String input) {
 225                 final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(input);
 226                 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
 227                 return resourceAsStream;
 228             }
 229         }));
 230     }
 231
 232     @Test
 233     public void testTranslation() throws Exception {
 234         final Document doc = loadDocument(xmlPath);
 235
 236         final ContainerNode built =
 237                 DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider(), schema).getContainerNodeParser().parse(
 238                         Collections.singletonList(doc.getDocumentElement()), containerNode);
 239
 240         if (expectedNode != null) {
 241             org.junit.Assert.assertEquals(expectedNode, built);
 242         }
 243
 244         System.err.println(built);
 245         logger.info("{}", built);
 246
 247         final Iterable<Element> els = DomFromNormalizedNodeSerializerFactory.getInstance(XmlDocumentUtils.getDocument(), DomUtils.defaultValueCodecProvider())
 248                 .getContainerNodeSerializer().serialize(containerNode, built);
 249
 250         final Element el = els.iterator().next();
 251
 252         XMLUnit.setIgnoreWhitespace(true);
 253         XMLUnit.setIgnoreComments(true);
 254         XMLUnit.setIgnoreAttributeOrder(true);
 255
 256
 257         System.err.println(toString(doc.getDocumentElement()));
 258         System.err.println(toString(el));
 259
 260         final Diff diff = new Diff(XMLUnit.buildControlDocument(toString(doc.getDocumentElement())), XMLUnit.buildTestDocument(toString(el)));
 261         DetailedDiff dd = new DetailedDiff(diff);
 262
 263         // FIXME the comparison cannot be performed, since the qualifiers supplied by XMlUnit do not work correctly in this case
 264         // We need to implement custom qualifier so that the element ordering does not mess the DIFF
 265 //        dd.overrideElementQualifier(new ElementNameAndAttributeQualifier());
 266 //        assertTrue(dd.toString(), dd.similar());
 267     }
 268
 269     private Document loadDocument(final String xmlPath) throws Exception {
 270         final InputStream resourceAsStream = NormalizedDataBuilderTest.class.getResourceAsStream(xmlPath);
 271
 272         final Document currentConfigElement = readXmlToDocument(resourceAsStream);
 273         Preconditions.checkNotNull(currentConfigElement);
 274         return currentConfigElement;
 275     }
 276
 277     private static final DocumentBuilderFactory BUILDERFACTORY;
 278
 279     static {
 280         final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 281         factory.setNamespaceAware(true);
 282         factory.setCoalescing(true);
 283         factory.setIgnoringElementContentWhitespace(true);
 284         factory.setIgnoringComments(true);
 285         BUILDERFACTORY = factory;
 286     }
 287
 288     private Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 289         final DocumentBuilder dBuilder;
 290         try {
 291             dBuilder = BUILDERFACTORY.newDocumentBuilder();
 292         } catch (final ParserConfigurationException e) {
 293             throw new RuntimeException("Failed to parse XML document", e);
 294         }
 295         final Document doc = dBuilder.parse(xmlContent);
 296
 297         doc.getDocumentElement().normalize();
 298         return doc;
 299     }
 300
 301     public static String toString(final Element xml) {
 302         try {
 303             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 304             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 305
 306             final StreamResult result = new StreamResult(new StringWriter());
 307             final DOMSource source = new DOMSource(xml);
 308             transformer.transform(source, result);
 309
 310             return result.getWriter().toString();
 311         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 312             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 313         }
 314     }
 315 }