com.fitbur.assertj.internal.DeepDifference Maven / Gradle / Ivy
The newest version!
/**
* 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.
*
* Copyright 2012-2016 the original author or authors.
*/
package com.fitbur.assertj.internal;
import static com.fitbur.assertj.internal.Objects.getDeclaredFieldsIncludingInherited;
import static com.fitbur.assertj.internal.Objects.propertyOrFieldValuesAreEqual;
import static com.fitbur.assertj.util.Strings.join;
import static com.fitbur.assertj.util.introspection.PropertyOrFieldSupport.COMPARISON;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.concurrent.ConcurrentHashMap;
/**
* Tests two objects for differences by doing a 'deep' comparison.
*
* Based on the deep equals implementation of https://github.com/jdereg/java-util
*
* @author John DeRegnaucourt ([email protected])
* @author Pascal Schumacher
*/
public class DeepDifference {
private static final Map, Boolean> customEquals = new ConcurrentHashMap<>();
private static final Map, Boolean> customHash = new ConcurrentHashMap<>();
private final static class DualKey {
private final List path;
private final Object key1;
private final Object key2;
private DualKey(List path, Object key1, Object key2) {
this.path = path;
this.key1 = key1;
this.key2 = key2;
}
private DualKey(Object key1, Object key2) {
this(new ArrayList(), key1, key2);
}
@Override
public boolean equals(Object other) {
if (!(other instanceof DualKey)) {
return false;
}
DualKey that = (DualKey) other;
return key1 == that.key1 && key2 == that.key2;
}
@Override
public int hashCode() {
int h1 = key1 != null ? key1.hashCode() : 0;
int h2 = key2 != null ? key2.hashCode() : 0;
return h1 + h2;
}
@Override
public String toString() {
return "DualKey [key1=" + key1 + ", key2=" + key2 + "]";
}
public List getPath() {
return path;
}
public String getConcatenatedPath() {
return join(path).with(".");
}
}
public static class Difference {
List path;
Object actual;
Object other;
public Difference(List path, Object actual, Object other) {
this.path = path;
this.actual = actual;
this.other = other;
}
public List getPath() {
return path;
}
public Object getActual() {
return actual;
}
public Object getOther() {
return other;
}
@Override
public String toString() {
return "Difference [path=" + path + ", actual=" + actual + ", other=" + other + "]";
}
}
/**
* Compare two objects for differences by doing a 'deep' comparison. This will traverse the
* Object graph and perform either a field-by-field comparison on each
* object (if not .equals() method has been overridden from Object), or it
* will call the customized .equals() method if it exists.
*
*
* This method handles cycles correctly, for example A->B->C->A.
* Suppose a and a' are two separate instances of the A with the same values
* for all fields on A, B, and C. Then a.deepEquals(a') will return an empty list. It
* uses cycle detection storing visited objects in a Set to prevent endless
* loops.
*
* @param a Object one to compare
* @param b Object two to compare
* @return the list of differences found or an empty list if objects are equivalent.
* Equivalent means that all field values of both subgraphs are the same,
* either at the field level or via the respectively encountered overridden
* .equals() methods during traversal.
*/
public static List determineDifferences(Object a, Object b,
Map> comparatorByPropertyOrField,
Map, Comparator> comparatorByType) {
final Set visited = new HashSet<>();
final Deque toCompare = initStack(a, b, visited);
final List differences = new ArrayList<>();
while (!toCompare.isEmpty()) {
final DualKey dualKey = toCompare.removeFirst();
visited.add(dualKey);
final List currentPath = dualKey.getPath();
final Object key1 = dualKey.key1;
final Object key2 = dualKey.key2;
if (key1 == key2) {
continue;
}
if (key1 == null || key2 == null) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
if (key1 instanceof Collection) {
if (!(key2 instanceof Collection)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
} else if (key2 instanceof Collection) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
if (key1 instanceof SortedSet) {
if (!(key2 instanceof SortedSet)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
} else if (key2 instanceof SortedSet) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
if (key1 instanceof SortedMap) {
if (!(key2 instanceof SortedMap)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
} else if (key2 instanceof SortedMap) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
if (key1 instanceof Map) {
if (!(key2 instanceof Map)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
} else if (key2 instanceof Map) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
// Handle all [] types. In order to be equal, the arrays must be the
// same length, be of the same type, be in the same order, and all
// elements within the array must be deeply equivalent.
if (key1.getClass().isArray()) {
if (!compareArrays(key1, key2, currentPath, toCompare, visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
// Special handle SortedSets because they are fast to compare
// because their elements must be in the same order to be equivalent Sets.
if (key1 instanceof SortedSet) {
if (!compareOrderedCollection((Collection) key1, (Collection) key2, currentPath, toCompare, visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
// Handled unordered Sets. This is a slightly more expensive comparison because order cannot
// be assumed, a temporary Map must be created, however the comparison still runs in O(N) time.
if (key1 instanceof Set) {
if (!compareUnorderedCollection((Collection) key1, (Collection) key2, currentPath, toCompare,
visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
// Check any Collection that is not a Set. In these cases, element
// order matters, therefore this comparison is faster than using unordered comparison.
if (key1 instanceof Collection) {
if (!compareOrderedCollection((Collection) key1, (Collection) key2, currentPath, toCompare, visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
// Compare two SortedMaps. This takes advantage of the fact that these
// Maps can be compared in O(N) time due to their ordering.
if (key1 instanceof SortedMap) {
if (!compareSortedMap((SortedMap) key1, (SortedMap) key2, currentPath, toCompare, visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
// Compare two Unordered Maps. This is a slightly more expensive comparison because
// order cannot be assumed, therefore a temporary Map must be created, however the
// comparison still runs in O(N) time.
if (key1 instanceof Map) {
if (!compareUnorderedMap((Map) key1, (Map) key2, currentPath, toCompare, visited)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
if (hasCustomComparator(dualKey, comparatorByPropertyOrField, comparatorByType)) {
if (propertyOrFieldValuesAreEqual(key1, key2, dualKey.getConcatenatedPath(),
comparatorByPropertyOrField, comparatorByType))
continue;
}
if (hasCustomEquals(key1.getClass())) {
if (!key1.equals(key2)) {
differences.add(new Difference(currentPath, key1, key2));
continue;
}
continue;
}
for (Field field : getDeclaredFieldsIncludingInherited(key1.getClass())) {
List path = new ArrayList(currentPath);
String fieldName = field.getName();
path.add(fieldName);
DualKey dk = new DualKey(path,
COMPARISON.getSimpleValue(fieldName, key1),
COMPARISON.getSimpleValue(fieldName, key2));
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
}
}
return differences;
}
private static boolean hasCustomComparator(DualKey dualKey, Map> comparatorByPropertyOrField,
Map, Comparator> comparatorByType) {
if (dualKey.key1.getClass() == dualKey.key2.getClass()) {
String fieldName = dualKey.getConcatenatedPath();
Comparator fieldComparator = comparatorByPropertyOrField.containsKey(fieldName)
? comparatorByPropertyOrField.get(fieldName) : comparatorByType.get(dualKey.key1.getClass());
return fieldComparator != null;
}
return false;
}
private static Deque initStack(Object a, Object b, Set visited) {
Deque stack = new LinkedList<>();
if (a != null && !isContainerType(a)) {
// disregard the equals method and start comparing fields
Collection fieldsOfRootObject = getDeclaredFieldsIncludingInherited(a.getClass());
if (!fieldsOfRootObject.isEmpty()) {
for (Field field : fieldsOfRootObject) {
String fieldName = field.getName();
DualKey dk = new DualKey(Arrays.asList(fieldName),
COMPARISON.getSimpleValue(fieldName, a),
COMPARISON.getSimpleValue(fieldName, b));
if (!visited.contains(dk)) {
stack.addFirst(dk);
}
}
} else {
stack.addFirst(new DualKey(a, b));
}
} else {
stack.addFirst(new DualKey(a, b));
}
return stack;
}
private static boolean isContainerType(Object o) {
return o instanceof Collection || o instanceof Map;
}
/**
* Deeply compare to Arrays []. Both arrays must be of the same type, same
* length, and all elements within the arrays must be deeply equal in order
* to return true.
*
* @param array1 [] type (Object[], String[], etc.)
* @param array2 [] type (Object[], String[], etc.)
* @param path the path to the arrays to compare
* @param toCompare add items to compare to the Stack (Stack versus recursion)
* @param visited Set of objects already compared (prevents cycles)
* @return true if the two arrays are the same length and contain deeply
* equivalent items.
*/
private static boolean compareArrays(Object array1, Object array2, List path, Deque toCompare,
Set visited) {
int len = Array.getLength(array1);
if (len != Array.getLength(array2)) {
return false;
}
for (int i = 0; i < len; i++) {
DualKey dk = new DualKey(path, Array.get(array1, i), Array.get(array2, i));
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
}
return true;
}
/**
* Deeply compare two Collections that must be same length and in same
* order.
*
* @param col1 First collection of items to compare
* @param col2 Second collection of items to compare
* @param path The path to the collections
* @param toCompare add items to compare to the Stack (Stack versus recursion)
* @param visited
* Set of objects already compared (prevents cycles) value of
* 'true' indicates that the Collections may be equal, and the
* sets items will be added to the Stack for further comparison.
*/
private static boolean compareOrderedCollection(Collection col1, Collection col2,
List path, Deque toCompare,
Set visited) {
if (col1.size() != col2.size()) return false;
Iterator i2 = col2.iterator();
for (K k : col1) {
DualKey dk = new DualKey(path, k, i2.next());
if (!visited.contains(dk)) toCompare.addFirst(dk);
}
return true;
}
/**
* Deeply compare the two sets referenced by dualKey. This method attempts
* to quickly determine inequality by length, then if lengths match, it
* places one collection into a temporary Map by deepHashCode(), so that it
* can walk the other collection and look for each item in the map, which
* runs in O(N) time, rather than an O(N^2) lookup that would occur if each
* item from collection one was scanned for in collection two.
*
* @param col1 First collection of items to compare
* @param col2 Second collection of items to compare
* @param path the path to the collections to compare
* @param toCompare add items to compare to the Stack (Stack versus recursion)
* @param visited Set containing items that have already been compared, so as to
* prevent cycles.
* @return boolean false if the Collections are for certain not equals. A
* value of 'true' indicates that the Collections may be equal, and
* the sets items will be added to the Stack for further comparison.
*/
private static boolean compareUnorderedCollection(Collection col1, Collection col2,
List path, Deque toCompare,
Set visited) {
if (col1.size() != col2.size()) {
return false;
}
Map fastLookup = new HashMap<>();
for (Object o : col2) {
fastLookup.put(deepHashCode(o), o);
}
for (Object o : col1) {
Object other = fastLookup.get(deepHashCode(o));
if (other == null) {
// Item not even found in other Collection, no need to continue.
return false;
}
DualKey dk = new DualKey(path, o, other);
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
}
return true;
}
/**
* Deeply compare two SortedMap instances. This method walks the Maps in
* order, taking advantage of the fact that the Maps are SortedMaps.
*
* @param map1 SortedMap one
* @param map2 SortedMap two
* @param path the path to the maps to compare
* @param toCompare add items to compare to the Stack (Stack versus recursion)
* @param visited Set containing items that have already been compared, to
* prevent cycles.
* @return false if the Maps are for certain not equals. 'true' indicates
* that 'on the surface' the maps are equal, however, it will place
* the contents of the Maps on the stack for further comparisons.
*/
private static boolean compareSortedMap(SortedMap map1, SortedMap map2,
List path, Deque toCompare,
Set visited) {
if (map1.size() != map2.size()) {
return false;
}
Iterator> i2 = map2.entrySet().iterator();
for (Map.Entry entry1 : map1.entrySet()) {
Map.Entry entry2 = i2.next();
// Must split the Key and Value so that Map.Entry's equals() method is not used.
DualKey dk = new DualKey(path, entry1.getKey(), entry2.getKey());
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
dk = new DualKey(path, entry1.getValue(), entry2.getValue());
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
}
return true;
}
/**
* Deeply compare two Map instances. After quick short-circuit tests, this
* method uses a temporary Map so that this method can run in O(N) time.
*
* @param map1 Map one
* @param map2 Map two
* @param path the path to the maps to compare
* @param toCompare add items to compare to the Stack (Stack versus recursion)
* @param visited Set containing items that have already been compared, to
* prevent cycles.
* @return false if the Maps are for certain not equals. 'true' indicates
* that 'on the surface' the maps are equal, however, it will place
* the contents of the Maps on the stack for further comparisons.
*/
private static boolean compareUnorderedMap(Map map1, Map map2,
List path, Deque toCompare,
Set visited) {
if (map1.size() != map2.size()) {
return false;
}
Map> fastLookup = new HashMap<>();
for (Map.Entry entry : map2.entrySet()) {
fastLookup.put(deepHashCode(entry.getKey()), entry);
}
for (Map.Entry entry : map1.entrySet()) {
Map.Entry other = fastLookup.get(deepHashCode(entry.getKey()));
if (other == null) {
return false;
}
DualKey dk = new DualKey(path, entry.getKey(), other.getKey());
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
dk = new DualKey(path, entry.getValue(), other.getValue());
if (!visited.contains(dk)) {
toCompare.addFirst(dk);
}
}
return true;
}
/**
* Determine if the passed in class has a non-Object.equals() method. This
* method caches its results in static ConcurrentHashMap to benefit
* execution performance.
*
* @param c Class to check.
* @return true, if the passed in Class has a .equals() method somewhere
* between itself and just below Object in it's inheritance.
*/
static boolean hasCustomEquals(Class c) {
if (customEquals.containsKey(c)) {
return customEquals.get(c);
}
Class origClass = c;
while (!Object.class.equals(c)) {
try {
c.getDeclaredMethod("equals", Object.class);
customEquals.put(origClass, true);
return true;
} catch (Exception ignored) {}
c = c.getSuperclass();
}
customEquals.put(origClass, false);
return false;
}
/**
* Get a deterministic hashCode (int) value for an Object, regardless of
* when it was created or where it was loaded into memory. The problem with
* java.lang.Object.hashCode() is that it essentially relies on memory
* location of an object (what identity it was assigned), whereas this
* method will produce the same hashCode for any object graph, regardless of
* how many times it is created.
*
*
* This method will handle cycles correctly (A->B->C->A). In this
* case, Starting with object A, B, or C would yield the same hashCode. If
* an object encountered (root, subobject, etc.) has a hashCode() method on
* it (that is not Object.hashCode()), that hashCode() method will be called
* and it will stop traversal on that branch.
*
* @param obj Object who hashCode is desired.
* @return the 'deep' hashCode value for the passed in object.
*/
static int deepHashCode(Object obj) {
Set