Xpp3DomBuilderTest.java

package org.codehaus.plexus.util.xml;

/*
 * Copyright The Codehaus Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;

import org.codehaus.plexus.util.xml.pull.MXParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

/**
 * Test the Xpp3DomBuilder.
 *
 * @author <a href="mailto:brett@codehaus.org">Brett Porter</a>
 * @version $Id: $Id
 * @since 3.4.0
 */
public class Xpp3DomBuilderTest {
    private static final String LS = System.lineSeparator();

    /**
     * <p>testBuildFromReader.</p>
     *
     * @throws java.lang.Exception if any.
     */
    @Test
    public void testBuildFromReader() throws Exception {
        String domString = createDomString();

        Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(domString));

        Xpp3Dom expectedDom = createExpectedDom();

        assertEquals(expectedDom, dom, "check DOMs match");
    }

    /**
     * <p>testBuildTrimming.</p>
     *
     * @throws java.lang.Exception if any.
     */
    @Test
    public void testBuildTrimming() throws Exception {
        String domString = createDomString();

        Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(domString), true);

        assertEquals("element1", dom.getChild("el1").getValue(), "test with trimming on");

        dom = Xpp3DomBuilder.build(new StringReader(domString), false);

        assertEquals(" element1\n ", dom.getChild("el1").getValue(), "test with trimming off");
    }

    /**
     * <p>testBuildFromXpp3Dom.</p>
     *
     * @throws java.lang.Exception if any.
     */
    @Test
    public void testBuildFromXpp3Dom() throws Exception {
        Xpp3Dom expectedDom = createExpectedDom();
        Xpp3Dom dom = null;

        XmlPullParser parser = new MXParser();

        String domString = "<newRoot><configuration>" + createDomString() + "</configuration></newRoot>";
        parser.setInput(new StringReader(domString));

        int eventType = parser.getEventType();

        boolean configurationClosed = false;
        boolean newRootClosed = false;
        boolean rootClosed = false;

        while (eventType != XmlPullParser.END_DOCUMENT) {
            if (eventType == XmlPullParser.START_TAG) {
                String rawName = parser.getName();

                if ("root".equals(rawName)) {
                    dom = Xpp3DomBuilder.build(parser);
                }
            } else if (eventType == XmlPullParser.END_TAG) {
                String rawName = parser.getName();

                if ("configuration".equals(rawName)) {
                    configurationClosed = true;
                } else if ("newRoot".equals(rawName)) {
                    newRootClosed = true;
                } else if ("root".equals(rawName)) {
                    rootClosed = true;
                }
            }
            eventType = parser.next();
        }

        assertEquals(expectedDom, dom, "Check DOM matches");
        assertFalse(rootClosed, "Check closing root was consumed");
        assertTrue(configurationClosed, "Check continued to parse configuration");
        assertTrue(newRootClosed, "Check continued to parse newRoot");
    }

    /**
     * Test we get an error from the parser, and don't hit the IllegalStateException.
     */
    @Test
    public void testUnclosedXml() {
        String domString = "<newRoot>" + createDomString();
        try {
            Xpp3DomBuilder.build(new StringReader(domString));
        } catch (XmlPullParserException expected) {
            // correct
            assertTrue(true);
        } catch (IOException expected) {
            // this will do too
            assertTrue(true);
        }
    }

    /**
     * <p>testEscapingInContent.</p>
     *
     * @throws java.io.IOException if any.
     * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
     */
    @Test
    public void testEscapingInContent() throws IOException, XmlPullParserException {
        Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(getEncodedString()));

        assertEquals("\"text\"", dom.getChild("el").getValue(), "Check content value");
        assertEquals("<b>\"text\"</b>", dom.getChild("ela").getValue(), "Check content value");
        assertEquals("<b>\"text\"</b>", dom.getChild("elb").getValue(), "Check content value");

        StringWriter w = new StringWriter();
        Xpp3DomWriter.write(w, dom);
        assertEquals(getExpectedString(), w.toString(), "Compare stringified DOMs");
    }

    /**
     * <p>testEscapingInAttributes.</p>
     *
     * @throws java.io.IOException if any.
     * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
     */
    @Test
    public void testEscapingInAttributes() throws IOException, XmlPullParserException {
        String s = getAttributeEncodedString();
        Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(s));

        assertEquals("<foo>", dom.getChild("el").getAttribute("att"), "Check attribute value");

        StringWriter w = new StringWriter();
        Xpp3DomWriter.write(w, dom);
        String newString = w.toString();
        assertEquals(newString, s, "Compare stringified DOMs");
    }

    /**
     * <p>testInputLocationTracking.</p>
     *
     * @throws java.io.IOException if any.
     * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if any.
     */
    @Test
    public void testInputLocationTracking() throws IOException, XmlPullParserException {
        Xpp3DomBuilder.InputLocationBuilder ilb = new Xpp3DomBuilder.InputLocationBuilder() {
            public Object toInputLocation(XmlPullParser parser) {
                return parser.getLineNumber(); // store only line number as a simple Integer
            }
        };
        Xpp3Dom dom = Xpp3DomBuilder.build(new StringReader(createDomString()), true, ilb);
        Xpp3Dom expectedDom = createExpectedDom();
        assertEquals(expectedDom.getInputLocation(), dom.getInputLocation(), "root input location");
        for (int i = 0; i < dom.getChildCount(); i++) {
            Xpp3Dom elt = dom.getChild(i);
            Xpp3Dom expectedElt = expectedDom.getChild(i);
            assertEquals(expectedElt.getInputLocation(), elt.getInputLocation(), elt.getName() + " input location");

            if ("el2".equals(elt.getName())) {
                Xpp3Dom el3 = elt.getChild(0);
                Xpp3Dom expectedEl3 = expectedElt.getChild(0);
                assertEquals(expectedEl3.getInputLocation(), el3.getInputLocation(), el3.getName() + " input location");
            }
        }
    }

    private static String getAttributeEncodedString() {
        StringBuilder domString = new StringBuilder();
        domString.append("<root>");
        domString.append(LS);
        domString.append("  <el att=\"&lt;foo&gt;\">bar</el>");
        domString.append(LS);
        domString.append("</root>");

        return domString.toString();
    }

    private static String getEncodedString() {
        StringBuilder domString = new StringBuilder();
        domString.append("<root>\n");
        domString.append("  <el>\"text\"</el>\n");
        domString.append("  <ela><![CDATA[<b>\"text\"</b>]]></ela>\n");
        domString.append("  <elb>&lt;b&gt;&quot;text&quot;&lt;/b&gt;</elb>\n");
        domString.append("</root>");

        return domString.toString();
    }

    private static String getExpectedString() {
        StringBuilder domString = new StringBuilder();
        domString.append("<root>");
        domString.append(LS);
        domString.append("  <el>&quot;text&quot;</el>");
        domString.append(LS);
        domString.append("  <ela>&lt;b&gt;&quot;text&quot;&lt;/b&gt;</ela>");
        domString.append(LS);
        domString.append("  <elb>&lt;b&gt;&quot;text&quot;&lt;/b&gt;</elb>");
        domString.append(LS);
        domString.append("</root>");

        return domString.toString();
    }

    //
    // HELPER METHODS
    //

    private static String createDomString() {
        StringBuilder buf = new StringBuilder();
        buf.append("<root>\n");
        buf.append(" <el1> element1\n </el1>\n");
        buf.append(" <el2 att2='attribute2&#10;nextline'>\n");
        buf.append("  <el3 att3='attribute3'>element3</el3>\n");
        buf.append(" </el2>\n");
        buf.append(" <el4></el4>\n");
        buf.append(" <el5/>\n");
        buf.append(" <el6 xml:space=\"preserve\">  do not trim  </el6>\n");
        buf.append("</root>\n");

        return buf.toString();
    }

    private static Xpp3Dom createExpectedDom() {
        int line = 1;
        Xpp3Dom expectedDom = new Xpp3Dom("root");
        expectedDom.setInputLocation(line);
        Xpp3Dom el1 = new Xpp3Dom("el1");
        el1.setInputLocation(++line);
        el1.setValue("element1");
        expectedDom.addChild(el1);
        ++line; // newline trimmed in Xpp3Dom but not in source
        Xpp3Dom el2 = new Xpp3Dom("el2");
        el2.setInputLocation(++line);
        el2.setAttribute("att2", "attribute2\nnextline");
        expectedDom.addChild(el2);
        Xpp3Dom el3 = new Xpp3Dom("el3");
        el3.setInputLocation(++line);
        el3.setAttribute("att3", "attribute3");
        el3.setValue("element3");
        el2.addChild(el3);
        ++line;
        Xpp3Dom el4 = new Xpp3Dom("el4");
        el4.setInputLocation(++line);
        el4.setValue("");
        expectedDom.addChild(el4);
        Xpp3Dom el5 = new Xpp3Dom("el5");
        el5.setInputLocation(++line);
        expectedDom.addChild(el5);
        Xpp3Dom el6 = new Xpp3Dom("el6");
        el6.setInputLocation(++line);
        el6.setAttribute("xml:space", "preserve");
        el6.setValue("  do not trim  ");
        expectedDom.addChild(el6);
        return expectedDom;
    }
}