XPathEvaluationTest

/*
 * Copyright 2010 Fraunhofer Gesellschaft, Munich, Germany,
 * for its Fraunhofer Institute for Computer Architecture and Software
 * Technology (FIRST), Berlin, Germany. All rights reserved.
 * http://www.first.fraunhofer.de/
 */

package net.kwfgrid.gwes;

import junit.framework.Test;
import junit.framework.TestSuite;
import junit.framework.Assert;
import net.kwfgrid.gwes.exception.LoggingException;
import org.apache.log4j.Logger;
import org.jaxen.XPath;
import org.jaxen.JaxenException;
import org.jaxen.SimpleNamespaceContext;
import org.jaxen.NamespaceContext;
import org.jaxen.jdom.JDOMXPath;
import org.jdom.Element;
import org.jdom.Document;
import net.kwfgrid.gworkflowdl.structure.JdomString;

import java.io.IOException;

/**
 * <code>
 * maven -Dtestcase=net.kwfgrid.gwes.XPathEvaluationTest test:single
 * </code>
 *
 * @author Andreas Hoheisel
 *         (<a href="http://www.andreas-hoheisel.de">www.andreas-hoheisel.de</a>)
 * @version $Id: XPathEvaluationTest.java 1529 2011-06-22 16:37:19Z hoheisel $
 */
public final class XPathEvaluationTest extends LocalGWESAbstractTestCase {

    static Logger logger = Logger.getLogger(XPathEvaluationTest.class);

    /**
     * Create the test case.
     *
     * @param testName name of the test case
     */
    public XPathEvaluationTest(String testName) throws LoggingException {
        super(testName);
    }

    /**
     * @return the suite of tests being tested
     */
    public static Test suite() {
        return new TestSuite(XPathEvaluationTest.class);
    }

    /**
     * *******************************************************************************************
     * Begin of public test classes.
     * ********************************************************************************************
     */

    public void testXPathEvaluationDocument() throws JaxenException, IOException {
        SimpleNamespaceContext nsContext = new TransitionOccurrence.DefaultNamespaceContext();
        Element rootElement = new Element("data",JdomString.wfSpace);
        Document context = new Document(rootElement);
        Element v1 = new Element("value1");
        v1.addContent("1");
        rootElement.addContent(v1);
        Element v2 = new Element("value2");
        v2.addContent("2");
        rootElement.addContent(v2);
        logger.info("context:\n"+JdomString.document2string(context));

        Object ret;
        String xpath;
        ret = evaluateXPath(nsContext, context, xpath="*");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <data [Namespace: http://www.gridworkflow.org/gworkflowdl]/>]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <data [Namespace: http://www.gridworkflow.org/gworkflowdl]/>]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value1");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <value1/>]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value2");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <value2/>]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value1 = 1");
        Assert.assertEquals("XPath return value for '"+xpath+"'",Constants.TRUE,ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value1 = 2");
        Assert.assertEquals("XPath return value for '"+xpath+"'",Constants.FALSE,ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value1 + 1 = 2");
        Assert.assertEquals("XPath return value for '"+xpath+"'",Constants.TRUE,ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/value1/text()");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Text: 1]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="normalize-space(/gwdl:data/value1)");
        Assert.assertEquals("XPath return value for '"+xpath+"'","1",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="normalize-space(/gwdl:data/value1 + 1)");
        Assert.assertEquals("XPath return value for '"+xpath+"'","2",ret.toString());
    }


    public void testXPathItemList() throws JaxenException, IOException {
        SimpleNamespaceContext nsContext = new TransitionOccurrence.DefaultNamespaceContext();
        Element rootElement = new Element("data",JdomString.wfSpace);
        Document context = new Document(rootElement);

        Element number = new Element("i");
        number.setText("7.0");
        rootElement.addContent(number);

        Element list = new Element("list");
        for (int i = 1; i<=10; i++ ){
            Element item = new Element("item");
            item.setText(""+i);
            list.addContent(item);
        }

        rootElement.addContent(list);
        logger.info("context:\n"+JdomString.document2string(context));

        Object ret;
        String xpath;

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/i/text()");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Text: 7.0]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/list/item[ 6.0 ]/text()");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Text: 6]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/list/item[ number(/gwdl:data/i) ]/text()");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Text: 7]]",ret.toString());


    }


    public void testXPathEvaluationSOAPReturnDocument() throws JaxenException, IOException {
        SimpleNamespaceContext nsContext = new TransitionOccurrence.DefaultNamespaceContext();
        Element rootElement = new Element("data",JdomString.wfSpace);
        Document context = new Document(rootElement);
        Element v1 = new Element("sortReturn");
        v1.addNamespaceDeclaration(JdomString.NAMESPACE_SOAPENC);
        v1.addNamespaceDeclaration(JdomString.NAMESPACE_XSI);
        v1.setAttribute("type","soapenc:string",JdomString.NAMESPACE_XSI);
        v1.addContent("0\n8\n15");
        rootElement.addContent(v1);
        logger.info("context:\n"+JdomString.document2string(context));

        Object ret;
        String xpath;
        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/sortReturn");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <sortReturn/>]]",ret.toString());

        ret = evaluateXPath(nsContext, context, xpath="/gwdl:data/sortReturn/text()");
        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Text: 0\n" +
                "8\n" +
                "15]]",ret.toString());
    }
    /**
     * XPath evaluation on JDom element lists seems not to work?
     */
//    public void testXPathEvaluationElementList() throws JaxenException, IOException {
//        SimpleNamespaceContext nsContext = new TransitionOccurrence.DefaultNamespaceContext();
//        List<Element> context = new ArrayList<Element>();
//        Element e1 = new Element("e1");
//        e1.addContent("v1");
//        context.add(e1);
//        Element e2 = new Element("e2");
//        e2.addContent("v2");
//        context.add(e2);
//        logger.info("context:");
//        for (Element e : context) {
//            logger.info(JdomString.element2string(e));
//        }
//
//        Object ret;
//        String xpath;
//        ret = evaluateXPath(nsContext, context, xpath="*");
//        Assert.assertEquals("XPath return value for '"+xpath+"'","[[Element: <data [Namespace: http://www.gridworkflow.org/gworkflowdl]/>]]",ret.toString());
//
//    }

    /**
     * *******************************************************************************************
     * End of public test classes.
     * ********************************************************************************************
     */

    private Object evaluateXPath(NamespaceContext nsContext, Object context, String xpathExpression) throws JaxenException {
        XPath xpath = new JDOMXPath(xpathExpression);
        xpath.setNamespaceContext(nsContext);
        Object retObject = xpath.evaluate(context);
        logger.info("Evaluation of expression '" + xpathExpression + "' returns " + retObject.toString());
        return retObject;
    }

}