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