yang/yang-data-codec-xml/src/test/java/org/opendaylight/yangtools/yang/data/codec/xml/YT1108Test.java

   1 /*
   2  * Copyright © 2020 Pantheon Technologies, s.r.o. 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.codec.xml;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.StringWriter;
  15 import java.net.URI;
  16 import java.util.Collection;
  17 import javax.xml.stream.XMLOutputFactory;
  18 import javax.xml.stream.XMLStreamException;
  19 import javax.xml.stream.XMLStreamWriter;
  20 import javax.xml.transform.OutputKeys;
  21 import javax.xml.transform.Transformer;
  22 import javax.xml.transform.TransformerException;
  23 import javax.xml.transform.TransformerFactory;
  24 import javax.xml.transform.TransformerFactoryConfigurationError;
  25 import javax.xml.transform.dom.DOMResult;
  26 import javax.xml.transform.dom.DOMSource;
  27 import javax.xml.transform.stream.StreamResult;
  28 import org.custommonkey.xmlunit.Diff;
  29 import org.custommonkey.xmlunit.XMLTestCase;
  30 import org.custommonkey.xmlunit.XMLUnit;
  31 import org.junit.AfterClass;
  32 import org.junit.Before;
  33 import org.junit.BeforeClass;
  34 import org.junit.Test;
  35 import org.junit.runner.RunWith;
  36 import org.junit.runners.Parameterized;
  37 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.QNameModule;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  46 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  47 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  48 import org.w3c.dom.Document;
  49 import org.w3c.dom.Node;
  50 import org.xml.sax.SAXException;
  51
  52 @RunWith(Parameterized.class)
  53 public class YT1108Test {
  54     @Parameterized.Parameters(name = "{0}")
  55     public static Collection<Object[]> data() {
  56         return TestFactories.junitParameters();
  57     }
  58
  59     private QNameModule fooModule;
  60     private QName fooLeafContainer;
  61     private QName fooIdentity;
  62     private QName fooUnionIdentityRefLeaf;
  63     private QName fooIdentityRefLeaf;
  64
  65     private static EffectiveModelContext SCHEMA_CONTEXT;
  66
  67     private final XMLOutputFactory factory;
  68
  69     public YT1108Test(final String factoryMode, final XMLOutputFactory factory) {
  70         this.factory = factory;
  71     }
  72
  73     @BeforeClass
  74     public static void beforeClass() {
  75         SCHEMA_CONTEXT = YangParserTestUtils.parseYangResource("/yt1108/yang/foo.yang");
  76     }
  77
  78     @AfterClass
  79     public static void afterClass() {
  80         SCHEMA_CONTEXT = null;
  81     }
  82
  83     @Before
  84     public void setup() {
  85         fooModule = QNameModule.create(URI.create("foo-namespace"));
  86         fooLeafContainer = QName.create(fooModule, "leaf-container");
  87
  88         fooIdentity = QName.create(fooModule, "ident-one");
  89         fooUnionIdentityRefLeaf = QName.create(fooModule, "union-identityref-leaf");
  90         fooIdentityRefLeaf = QName.create(fooModule, "identityref-leaf");
  91     }
  92
  93     @Test
  94     public void testLeafOfIdentityRefTypeNNToXmlSerialization()
  95             throws XMLStreamException, IOException, SAXException {
  96         final Document doc = loadDocument("/yt1108/xml/foo-leaf-of-identity-ref-type.xml");
  97         final DOMResult domResult = convertNormalizedNodeToXml(buildLeafContainerNodeWithIdentityRefLeaf());
  98
  99         XMLUnit.setIgnoreWhitespace(true);
 100         XMLUnit.setNormalize(true);
 101
 102         final String expectedXml = toString(doc.getDocumentElement());
 103         final String serializedXml = toString(domResult.getNode());
 104         final Diff diff = new Diff(expectedXml, serializedXml);
 105
 106         new XMLTestCase() {}.assertXMLEqual(diff, true);
 107     }
 108
 109     @Test
 110     public void testLeafOfUnionWithIdentityRefNNToXmlSerialization()
 111             throws XMLStreamException, IOException, SAXException {
 112         final Document doc = loadDocument("/yt1108/xml/foo-leaf-of-union-with-identity-ref-type.xml");
 113         final DOMResult domResult = convertNormalizedNodeToXml(buildLeafContainerNodeWithUnionIdentityRefLeaf());
 114
 115         XMLUnit.setIgnoreWhitespace(true);
 116         XMLUnit.setNormalize(true);
 117
 118         final String expectedXml = toString(doc.getDocumentElement());
 119         final String serializedXml = toString(domResult.getNode());
 120         final Diff diff = new Diff(expectedXml, serializedXml);
 121
 122         new XMLTestCase() {}.assertXMLEqual(diff, true);
 123     }
 124
 125     private DOMResult convertNormalizedNodeToXml(NormalizedNode<?, ?> normalizedNode)
 126             throws XMLStreamException, IOException {
 127         final DOMResult domResult = new DOMResult(UntrustedXML.newDocumentBuilder().newDocument());
 128
 129         final XMLStreamWriter xmlStreamWriter = factory.createXMLStreamWriter(domResult);
 130
 131         final NormalizedNodeStreamWriter xmlNormalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(
 132                 xmlStreamWriter, SCHEMA_CONTEXT);
 133
 134         final NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(
 135                 xmlNormalizedNodeStreamWriter);
 136
 137         normalizedNodeWriter.write(normalizedNode);
 138         return domResult;
 139     }
 140
 141     private NormalizedNode<?, ?> buildLeafContainerNodeWithIdentityRefLeaf() {
 142         return Builders.containerBuilder()
 143                 .withNodeIdentifier(NodeIdentifier.create(fooLeafContainer))
 144                 .withChild(Builders.leafBuilder()
 145                         .withNodeIdentifier(NodeIdentifier.create(fooIdentityRefLeaf))
 146                         .withValue(fooIdentity)
 147                         .build())
 148                 .build();
 149     }
 150
 151     private NormalizedNode<?, ?> buildLeafContainerNodeWithUnionIdentityRefLeaf() {
 152         return Builders.containerBuilder()
 153                 .withNodeIdentifier(NodeIdentifier.create(fooLeafContainer))
 154                 .withChild(Builders.leafBuilder()
 155                         .withNodeIdentifier(YangInstanceIdentifier.NodeIdentifier.create(fooUnionIdentityRefLeaf))
 156                         .withValue(fooIdentity)
 157                         .build())
 158                 .build();
 159     }
 160
 161     private static Document loadDocument(final String xmlPath) throws IOException, SAXException {
 162         final InputStream resourceAsStream = NormalizedNodesToXmlTest.class.getResourceAsStream(xmlPath);
 163         return requireNonNull(readXmlToDocument(resourceAsStream));
 164     }
 165
 166     private static Document readXmlToDocument(final InputStream xmlContent) throws IOException, SAXException {
 167         final Document doc = UntrustedXML.newDocumentBuilder().parse(xmlContent);
 168         doc.getDocumentElement().normalize();
 169         return doc;
 170     }
 171
 172     private static String toString(final Node xml) {
 173         try {
 174             final Transformer transformer = TransformerFactory.newInstance().newTransformer();
 175             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
 176             transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
 177
 178             final StreamResult result = new StreamResult(new StringWriter());
 179             final DOMSource source = new DOMSource(xml);
 180             transformer.transform(source, result);
 181
 182             return result.getWriter().toString();
 183         } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) {
 184             throw new RuntimeException("Unable to serialize xml element " + xml, e);
 185         }
 186     }
 187 }