org.appng.testsupport.validation.AttributeValueDifferenceHandler Maven / Gradle / Ivy
/*
* Copyright 2011-2017 the original author or authors.
*
* 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.
*/
package org.appng.testsupport.validation;
import static org.custommonkey.xmlunit.DifferenceConstants.ATTR_VALUE;
import java.util.Arrays;
import java.util.List;
import org.custommonkey.xmlunit.Difference;
import org.custommonkey.xmlunit.DifferenceListener;
import org.w3c.dom.Node;
/**
* A {@link DifferenceListener} which ignores the values of certain attributes.
* For example, if setting up a {@link AttributeValueDifferenceHandler} like this
*
*
* DifferenceHandler handler = new AttributeValueDifferenceHandler("required");
*
*
* the following nodes would be considered as identical:
*
*
* <field name="foo" type="text" required="true">
* <value>bar</value>
* </field>
*
*
* and
*
*
* <field name="foo" type="text" required="false">
* <value>bar</value>
* </field>
*
*
* Note {@link AttributeValueDifferenceHandler} is getting applied to the whole document, ignoring every
* {@link Difference} in the value of any attribute with the defined name. If a more precise distinction is required,
* use {@link XPathDifferenceHandler} instead.
*
* @author Matthias Müller
*
*/
public class AttributeValueDifferenceHandler extends DifferenceHandler {
private List ignored;
/**
*
* @param ignored
* name(s) of the attribute(s) to ignore the value for
*/
public AttributeValueDifferenceHandler(String... ignored) {
this.ignored = Arrays.asList(ignored);
}
@Override
public int differenceFound(Difference difference) {
Node node = difference.getTestNodeDetail().getNode();
if (null != node) {
boolean isIgnoreable = ignored.indexOf(node.getNodeName()) > -1;
boolean isDifferentAttribute = ATTR_VALUE.equals(difference);
if (isDifferentAttribute && isIgnoreable) {
return RETURN_IGNORE_DIFFERENCE_NODES_IDENTICAL;
}
}
return RETURN_ACCEPT_DIFFERENCE;
}
}