com.cucumber.utils.engineering.compare.XmlCompare Maven / Gradle / Ivy

Go to download
package com.cucumber.utils.engineering.compare;

import com.cucumber.utils.engineering.compare.comparators.xml.CustomXmlComparator;
import com.cucumber.utils.engineering.compare.comparators.xml.XmlMatchException;
import com.cucumber.utils.engineering.compare.exceptions.CompareException;
import org.w3c.dom.Element;
import org.xmlunit.diff.DefaultNodeMatcher;
import org.xmlunit.diff.DifferenceEvaluators;
import org.xmlunit.diff.ElementSelector;
import org.xmlunit.util.Nodes;

import java.util.Map;

import static com.cucumber.utils.engineering.utils.XmlUtils.isValid;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.xmlunit.matchers.CompareMatcher.isSimilarTo;

public class XmlCompare implements Placeholdable {

    private String expected;
    private String actual;
    private CustomXmlComparator comparator;
    private String message;

    public XmlCompare(Object expected, Object actual) throws CompareException {
        this(null, expected, actual);
    }

    public XmlCompare(String message, Object expected, Object actual) throws CompareException {
        this(message, expected, actual, false, false, false);
    }

    public XmlCompare(String message, Object expected, Object actual, boolean childNodeListLength, boolean childNodeListSequence, boolean elementNumAttributes) throws CompareException {
        this.expected = expected.toString();
        this.actual = actual.toString();
        this.comparator = new CustomXmlComparator(childNodeListLength, childNodeListSequence, elementNumAttributes);
        if (!isValid(this.expected) || !isValid(this.actual)) {
            throw new CompareException("Malformed XML");
        }
        this.message = message == null ? "" : message;
    }

    @Override
    public Map compare() {
        assertThat(message, actual, isSimilarTo(expected).ignoreWhitespace()
                .withNodeMatcher(new DefaultNodeMatcher(new ByNameAttrAndTextSelector()))
                .withDifferenceEvaluator(
                        DifferenceEvaluators.chain(comparator)));
        return comparator.getGeneratedProperties();
    }

    class ByNameAttrAndTextSelector implements ElementSelector {

        @Override
        public boolean canBeCompared(Element controlElement, Element testElement) {
            if (controlElement == null || testElement == null || !Nodes.getQName(controlElement).equals(Nodes.getQName(testElement))) {
                return false;
            }
            try {
                comparator.match(Nodes.getAttributes(controlElement), Nodes.getAttributes(testElement));
                comparator.match(Nodes.getMergedNestedText(controlElement), Nodes.getMergedNestedText(testElement));
                return true;
            } catch (XmlMatchException e) {
                return false;
            }
        }
    }
}