jelly-tags/xml/src/test/java/org/apache/commons/jelly/tags/xml/TestXMLTags.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.commons.jelly.tags.xml;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import junit.framework.Assert;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import junit.textui.TestRunner;

import org.apache.commons.jelly.JellyContext;
import org.apache.commons.jelly.JellyException;
import org.apache.commons.jelly.Script;
import org.apache.commons.jelly.XMLOutput;
import org.apache.commons.jelly.parser.XMLParser;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Node;
import org.dom4j.io.SAXContentHandler;
import org.dom4j.io.XMLWriter;

/** Tests the parser, the engine and the XML tags
  *
  * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
  * @version $Revision$
  */
public class TestXMLTags extends TestCase {

    /** The Log to which logging calls will be made. */
    private static final Log log = LogFactory.getLog(TestXMLTags.class);

    /** basedir for test source */
    private static final String testBaseDir ="target/test-classes/org/apache/commons/jelly/tags/xml";

    /** Regular expression for multiple namespace attributes. */
    private static final String REG_NS = "( xmlns(:(\\w)+)?=\".+\")+";

    public static void main(String[] args) {
        TestRunner.run(suite());
    }

    public static Test suite() {
        return new TestSuite(TestXMLTags.class);
    }

    /**
     * Returns a matcher for a namespace XML fragment.
     * @param s the fragment to be checked
     * @param pre the part before the namespace expression
     * @param post the part after the namespace expression
     * @return the matcher
     */
    private static Matcher matcherForNamespaceFragment(String s, String pre, String post) {
        Pattern pattern = Pattern.compile(Pattern.quote(pre) + REG_NS + Pattern.quote(post));
        return pattern.matcher(s);
    }

    /**
     * Checks an XML fragment with a namespace expression. Namespaces are
     * generated in arbitrary order. Therefore, they cannot be checked
     * directly.
     * @param s the fragment to be checked
     * @param pre the part before the namespace expression
     * @param post the part after the namespace expression
     * @return the extracted namespace expression
     */
    private static String checkNamespaceFragment(String s, String pre, String post) {
        Matcher matcher = matcherForNamespaceFragment(s, pre, post);
        assertTrue("Pattern '" + pre + REG_NS + post + "' does not match " + s,
                matcher.matches());
        return matcher.group(1);
    }

    /**
     * Tries to find a fragment with the specified namespaces in the given
     * string.
     * @param s the string
     * @param pre the part before the namespace expression
     * @param post the part after the namespace expression
     * @param ns the namespaces to be matched in the fragment
     */
    private static void findNamespaceFragment(String s, String pre, String post,
                                                String... ns) {
        Matcher matcher = matcherForNamespaceFragment(s, pre, post);
        assertTrue("Pattern '" + pre + REG_NS + post + "' does not match " + s,
                matcher.find());
        String match = matcher.group(1);
        for (String namespace : ns) {
            assertTrue("Namespace '" + namespace + "' not found in '" + match + "':",
                    match.contains(namespace));
        }
    }

    public TestXMLTags(String testName) {
        super(testName);
    }

    public void testUnitTests() throws Exception {
        runUnitTest( testBaseDir + "/testForEach.jelly" );
    }

    public void testExpressions() throws Exception {
        runUnitTest( testBaseDir + "/testExpressions.jelly");
    }

    public void testParse() throws Exception {
        InputStream in = new FileInputStream(testBaseDir + "/example.jelly");
        XMLParser parser = new XMLParser();
        Script script = parser.parse(in);
        script = script.compile();
        log.debug("Found: " + script);
        assertTrue("Parsed a Script", script instanceof Script);
        StringWriter buffer = new StringWriter();
        script.run(parser.getContext(), XMLOutput.createXMLOutput(buffer));
        String text = buffer.toString().trim();
        if (log.isDebugEnabled()) {
            log.debug("Evaluated script as...");
            log.debug(text);
        }
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testElementWithNameSpace() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/elementWithNameSpace.jelly");
        assertEquals("Should produce the correct output",
                "<env:Envelope "+
                "xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\" "+
                "env:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">"+
                "</env:Envelope>", text);
    }

    public void testElementWithNameSpaceError() throws Exception {
        try {
            evaluateScriptAsText(testBaseDir + "/elementWithNameSpaceError.jelly");
            Assert.fail("We should have bailed out with an JellyException");
        } catch (JellyException jex) {
            assertTrue(jex.getReason().startsWith("Cannot set same prefix to different URI in same node"));
        }
    }

    public void testNamespaceReplace() throws Exception {
        // For this test when we not set "ns" var with expected namespace, it
        // is expected to repeat the same two times
        String text = evaluateScriptAsText(testBaseDir + "/namespaceReplace.jelly");
        String repeatingText = "<test-subnode attr=\"test\"><test-anotherSubNode></test-anotherSubNode><test-anotherSubNodeAgain xmlns:other=\"\" other:abc=\"testValue\"></test-anotherSubNodeAgain></test-subnode>";
        assertEquals("Should produce the correct output",
                "<test-node xmlns:test=\"http://apache/testNS\" test:abc=\"testValue\">"+
                repeatingText + repeatingText +
                "</test-node>", text);

        Map ctxVars = new HashMap();
        ctxVars.put("ns", "http://java/ns");

        text = evaluateScriptAsText(testBaseDir + "/namespaceReplace.jelly", ctxVars);

        findNamespaceFragment(text,
                "<test-subnode xmlns=\"\" attr=\"test\">"
                        + "<test-anotherSubNode>" + "</test-anotherSubNode>"
                        + "<test-anotherSubNodeAgain",
                " other:abc=\"testValue\">" + "</test-anotherSubNodeAgain>"
                        + "</test-subnode>" + "<test-subnode attr=\"test\">"
                        + "<test-anotherSubNode>" + "</test-anotherSubNode>"
                        + "<test-anotherSubNodeAgain xmlns:other=\"http://java/ns\" other:abc=\"testValue\">"
                        + "</test-anotherSubNodeAgain>" + "</test-subnode>",
                "xmlns:other=\"http://java/ns\"", "xmlns=\"http://java/ns\"");
    }

    public void testAttributeNameSpaceDuplicatedNS() throws Exception {
        try {
            evaluateScriptAsText(testBaseDir + "/attributeNameSpaceDuplicatedNS.jelly");
            Assert.fail("We should have bailed out with an JellyException");
        } catch (JellyException jex) {
            assertTrue(jex.getReason().startsWith("Cannot set same prefix to different URI in same node"));
        }
    }

    public void testAttributeNameSpace() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/attributeNameSpace.jelly");
        System.out.println(text);
        String ns = checkNamespaceFragment(text, "<top-node xmlns=\"abc\"><test-node",
                " test:abc=\"testValue\" abc2=\"testValue\" abc3=\"testValue\">"+
                        "<test:test-subnode><node-at-same-ns-as-top xmlns=\"abc\">"+
                        "</node-at-same-ns-as-top>"+
                        "</test:test-subnode>"+
                        "</test-node>"+
                        "</top-node>");
        assertTrue(ns.contains("xmlns:test=\"http://apache/testNS\""));
        assertTrue(ns.contains("xmlns=\"http://apache/trueNS\""));
    }

    public void testAttributeNameSpaceDefaultNS() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/attributeNameSpaceDefaultNS.jelly");
        System.out.println(text);
        String ns = checkNamespaceFragment(text, "<top-node><test-node",
                " test:abc=\"testValue\" abc2=\"testValue\" abc3=\"testValue\">" +
                        "<test:test-subnode><node-at-same-ns-as-top xmlns=\"\">"+
                        "</node-at-same-ns-as-top>"+
                        "</test:test-subnode>"+
                        "</test-node>"+
                        "</top-node>");
        assertTrue(ns.contains("xmlns:test=\"http://apache/testNS\""));
        assertTrue(ns.contains("xmlns=\"http://apache/trueNS\""));
    }

    public void testAttributeNameSpaceWithInnerElements() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/attributeNameSpaceWithInnerElements.jelly");
        assertEquals("Should produce the correct output",
                "<test-node xmlns:test=\"http://apache/testNS\" test:abc=\"testValue\" abc2=\"testValue\" abc3=\"testValue\">"+
                "<test-sub-node xmlns:test2=\"http://apache/testNS\" xmlns:test3=\"http://apache/anotherNS\" test:abc=\"testValue\" test2:abc2=\"testValue\" test3:abc3=\"testValue\">"+
                "</test-sub-node>"+
                "</test-node>"
                , text);
    }

    public void testTransform() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/transformExample.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformAllInLine() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/transformExampleAllInLine.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformParams() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/transformParamExample.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformParamsInLine() throws Exception {

        String text = evaluateScriptAsText(testBaseDir + "/transformParamExample2.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformSAXOutput() throws Exception {
        String text = evaluateScriptAsText(testBaseDir + "/transformExampleSAXOutput.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformSAXOutputNestedTransforms() throws Exception {
        String text = evaluateScriptAsText(testBaseDir +
            "/transformExampleSAXOutputNestedTransforms.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testTransformSchematron() throws Exception {
        String text = evaluateScriptAsText(testBaseDir +
            "/schematron/transformSchematronExample.jelly");
        assertEquals("Should produce the correct output", "Report count=1:assert count=2", text);
    }

    public void testTransformXmlVar() throws Exception {
        String text = evaluateScriptAsText(testBaseDir +
            "/transformExampleXmlVar.jelly");
        assertEquals("Should produce the correct output", "It works!", text);
    }

    public void testDoctype() throws Exception {
        String text = evaluateScriptAsText(testBaseDir +
            "/testDoctype.jelly");
        assertEquals("Should produce the correct output", "<!DOCTYPE foo PUBLIC \"publicID\" \"foo.dtd\">\n<foo></foo>", text);
    }

    public void runUnitTest(String name) throws Exception {
        Document document = parseUnitTest(name);

        List failures = document.selectNodes( "/*/fail" );
        for ( Iterator iter = failures.iterator(); iter.hasNext(); ) {
            Node node = (Node) iter.next();
            fail( node.getStringValue() );
        }
    }

    public Document parseUnitTest(String name) throws Exception {
        // parse script
        InputStream in = new FileInputStream(name);
        XMLParser parser = new XMLParser();
        Script script = parser.parse(in);
        script = script.compile();
        assertTrue("Parsed a Script", script instanceof Script);
        StringWriter buffer = new StringWriter();
        script.run(parser.getContext(), XMLOutput.createXMLOutput(buffer));

        String text = buffer.toString().trim();
        if (log.isDebugEnabled()) {
            log.debug("Evaluated script as...");
            log.debug(text);
        }

        // now lets parse the output
        return DocumentHelper.parseText( text );
    }

    /**
     * Evaluates the script by the given file name and
     * returns the whitespace trimmed output as text
     */
    protected String evaluateScriptAsText(String fileName) throws Exception {
        return evaluateScriptAsText(fileName, null);
    }

    /**
     * Evaluates the script by the given file name and
     * returns the whitespace trimmed output as text
     */
    protected String evaluateScriptAsText(String fileName, Map ctxVars) throws Exception {
        JellyContext context = new JellyContext();
        if (ctxVars != null) {
            Set keys = ctxVars.keySet();
            for (Iterator iterator = keys.iterator(); iterator.hasNext();) {
                String key = (String) iterator.next();
                Object value = ctxVars.get(key);
                context.setVariable(key, value);
            }
        }

        // allow scripts to refer to any resource inside this project
        // using an absolute URI like /src/test/org/apache/foo.xml
        context.setRootURL(new File(".").toURL());

        // capture the output
        StringWriter buffer = new StringWriter();
        XMLOutput output = XMLOutput.createXMLOutput(buffer);

        context.runScript( new File(fileName), output );
        String text = buffer.toString().trim();
        if (log.isDebugEnabled()) {
            log.debug("Evaluated script as...");
            log.debug(text);
        }
        return text;
    }

    protected String evaluateScriptAsTextUsingSaxContentHandler(String fileName, Map ctxVars) throws Exception {
        org.dom4j.io.OutputFormat outputFormat = new org.dom4j.io.OutputFormat();
        outputFormat.setSuppressDeclaration(true);
        outputFormat.setNewlines(false);
        outputFormat.setIndent(false);
        outputFormat.setExpandEmptyElements(true);
        //outputFormat.setIndentSize(4);

        StringWriter buffer = new StringWriter();
        XMLWriter xmlWriter = new XMLWriter(buffer, outputFormat);
        // xmlWriter.setEscapeText(false);

        SAXContentHandler saxHandler = new SAXContentHandler();
        XMLOutput output = new XMLOutput(saxHandler);

        // now run a script using a URL
        JellyContext context = new JellyContext();
        if (ctxVars != null) {
            Set keys = ctxVars.keySet();
            for (Iterator iterator = keys.iterator(); iterator.hasNext();) {
                String key = (String) iterator.next();
                Object value = ctxVars.get(key);
                context.setVariable(key, value);
            }
        }

        // allow scripts to refer to any resource inside this project
        // using an absolute URI like /src/test/org/apache/foo.xml
        context.setRootURL(new File(".").toURL());

        output.startDocument();
        context.runScript(new File(fileName), output);
        output.endDocument();
        xmlWriter.write(saxHandler.getDocument());
        xmlWriter.flush();

        String text = buffer.toString().trim();
        if (log.isDebugEnabled()) {
            log.debug("Evaluated script as...");
            log.debug(text);
        }
        return text;
    }

}