org.jspringbot.keyword.xml.XMLUtils Maven / Gradle / Ivy

Go to download
package org.jspringbot.keyword.xml;

import com.sun.org.apache.xerces.internal.parsers.DOMParser;
import org.apache.commons.collections.CollectionUtils;
import org.jspringbot.keyword.expression.ExpressionHelper;
import org.jspringbot.spring.ApplicationContextHolder;
import org.jspringbot.syntax.HighlightRobotLogger;
import org.w3c.dom.Element;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

import javax.xml.transform.TransformerException;
import java.io.IOException;
import java.io.StringReader;
import java.util.List;

public class XMLUtils {
    public static final HighlightRobotLogger LOG = HighlightRobotLogger.getLogger(ExpressionHelper.class);

    private static XMLHelper getHelper() {
        return ApplicationContextHolder.get().getBean(XMLHelper.class);
    }

    public static boolean isValidXML(String xmlString) {
        try {
            DOMParser parser = new DOMParser();
            parser.parse(new InputSource(new StringReader(xmlString)));
            parser.getDocument();

            return true;
        } catch(Exception e) {
            return false;
        }
    }

    public static String attr(Object... args) throws TransformerException, IOException, SAXException {
        if(args[0] == null && String.class.isInstance(args[1]) && args.length == 2) {
            return attr(args[1]);
        } else if(Element.class.isInstance(args[0])) {
            Element element = (Element) args[0];
            String attribute = (String) args[1];
            String result = element.getAttribute(attribute);

            LOG.keywordAppender()
                    .appendProperty("Attribute", attribute)
                    .appendProperty("Result", result);

            return result;
        } else if(String.class.isInstance(args[0]) && args.length > 1) {
            String xpath = (String) args[0];
            String attribute = (String) args[1];

            LOG.keywordAppender()
                    .appendProperty("Xpath", xpath)
                    .appendProperty("Attribute", attribute);

            List els = elements(xpath);

            if(CollectionUtils.isEmpty(els)) {
                throw new IllegalArgumentException(String.format("No elements found for xpath '%s'.", xpath));
            }

            String result = els.iterator().next().getAttribute(attribute);

            LOG.keywordAppender().appendProperty("Result", result);

            return result;
        } else if(String.class.isInstance(args[0])) {
            String attribute = (String) args[0];

            LOG.keywordAppender().appendProperty("Root Attribute", attribute);

            String result = getHelper().getDocument().getDocumentElement().getAttribute(attribute);

            LOG.keywordAppender().appendProperty("Result", result);

            return result;
        }

        throw new IllegalArgumentException("Expected 'xml:attr(attrName)' or 'xml:attr(element, attrName)' or 'xml:attr(xpath, attrName)'.");
    }

    public static String text(Object... args) throws TransformerException, IOException, SAXException {
        if(Element.class.isInstance(args[0]) && args.length == 1) {
            Element element = (Element) args[0];
            String result = element.getTextContent();

            LOG.keywordAppender().appendProperty("Result", result);

            return result;
        } else if(args.length == 2 && Element.class.isInstance(args[0]) && String.class.isInstance(args[1])) {
            return element(args).getTextContent();
        } else if(args.length == 2 && args[0] == null && String.class.isInstance(args[1])) {
            return text(args[1]);
        } else if(String.class.isInstance(args[0])) {
            String xpath = (String) args[0];

            LOG.keywordAppender().appendProperty("Xpath", xpath);

            List els = elements(xpath);

            if(CollectionUtils.isEmpty(els)) {
                throw new IllegalArgumentException(String.format("No elements found for xpath '%s'.", xpath));
            }

            String result = els.iterator().next().getTextContent();

            LOG.keywordAppender().appendProperty("Result", result);

            return result;
        }

        throw new IllegalArgumentException("Expected 'xml:text(element)' or 'xml:text(xpath)'.");
    }

    public static Element element(Object... args) throws TransformerException, IOException, SAXException {
        List elements = elements(args);

        if(CollectionUtils.isNotEmpty(elements)) {
            return elements.iterator().next();
        }

        return null;
    }

    public static List elements(Object... args) throws TransformerException, IOException, SAXException {
        if(args.length == 2 && Element.class.isInstance(args[0]) && String.class.isInstance(args[1])) {
            Element element = (Element) args[0];
            String xpath = (String) args[1];

            return getHelper().getXpathElements(element, xpath);
        } else if(args.length == 2 && args[0] == null && String.class.isInstance(args[1])) {
            return elements(args[1]);
        } else if(String.class.isInstance(args[0])) {
            String xpath = (String) args[0];

            return getHelper().getXpathElements(xpath);
        }

        throw new IllegalArgumentException("Expected 'xml:elements(element, xpath)' or 'xml:elements(xpath)'.");
    }
}