1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
* Copyright (C) 2011 The Guava 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 com.google.common.testing;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.annotations.GwtCompatible;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import junit.framework.AssertionFailedError;
import java.util.List;
/**
* Tests a collection of objects according to the rules specified in a
* {@link RelationshipAssertion}.
*
* @author Gregory Kick
*/
@GwtCompatible
final class RelationshipTester<T> {
static class ItemReporter {
String reportItem(Item item) {
return item.toString();
}
}
private final List<ImmutableList<T>> groups = Lists.newArrayList();
private final RelationshipAssertion<T> assertion;
private final ItemReporter itemReporter;
RelationshipTester(RelationshipAssertion<T> assertion, ItemReporter itemReporter) {
this.assertion = checkNotNull(assertion);
this.itemReporter = checkNotNull(itemReporter);
}
RelationshipTester(RelationshipAssertion<T> assertion) {
this(assertion, new ItemReporter());
}
public RelationshipTester<T> addRelatedGroup(Iterable<? extends T> group) {
groups.add(ImmutableList.copyOf(group));
return this;
}
public void test() {
for (int groupNumber = 0; groupNumber < groups.size(); groupNumber++) {
ImmutableList<T> group = groups.get(groupNumber);
for (int itemNumber = 0; itemNumber < group.size(); itemNumber++) {
// check related items in same group
for (int relatedItemNumber = 0; relatedItemNumber < group.size(); relatedItemNumber++) {
if (itemNumber != relatedItemNumber) {
assertRelated(groupNumber, itemNumber, relatedItemNumber);
}
}
// check unrelated items in all other groups
for (int unrelatedGroupNumber = 0; unrelatedGroupNumber < groups.size();
unrelatedGroupNumber++) {
if (groupNumber != unrelatedGroupNumber) {
ImmutableList<T> unrelatedGroup = groups.get(unrelatedGroupNumber);
for (int unrelatedItemNumber = 0; unrelatedItemNumber < unrelatedGroup.size();
unrelatedItemNumber++) {
assertUnrelated(groupNumber, itemNumber, unrelatedGroupNumber, unrelatedItemNumber);
}
}
}
}
}
}
private void assertRelated(int groupNumber, int itemNumber, int relatedItemNumber) {
ImmutableList<T> group = groups.get(groupNumber);
T item = group.get(itemNumber);
T related = group.get(relatedItemNumber);
try {
assertion.assertRelated(item, related);
} catch (AssertionFailedError e) {
// TODO(gak): special handling for ComparisonFailure?
throw new AssertionFailedError(e.getMessage()
.replace("$ITEM", itemReporter.reportItem(new Item(item, groupNumber, itemNumber)))
.replace("$RELATED",
itemReporter.reportItem(new Item(related, groupNumber, relatedItemNumber))));
}
}
private void assertUnrelated(int groupNumber, int itemNumber, int unrelatedGroupNumber,
int unrelatedItemNumber) {
T item = groups.get(groupNumber).get(itemNumber);
T unrelated = groups.get(unrelatedGroupNumber).get(unrelatedItemNumber);
try {
assertion.assertUnrelated(item, unrelated);
} catch (AssertionFailedError e) {
// TODO(gak): special handling for ComparisonFailure?
throw new AssertionFailedError(e.getMessage()
.replace("$ITEM", itemReporter.reportItem(new Item(item, groupNumber, itemNumber)))
.replace("$UNRELATED", itemReporter.reportItem(
new Item(unrelated, unrelatedGroupNumber, unrelatedItemNumber))));
}
}
static final class Item {
final Object value;
final int groupNumber;
final int itemNumber;
Item(Object value, int groupNumber, int itemNumber) {
this.value = value;
this.groupNumber = groupNumber;
this.itemNumber = itemNumber;
}
@Override public String toString() {
return new StringBuilder()
.append(value)
.append(" [group ")
.append(groupNumber + 1)
.append(", item ")
.append(itemNumber + 1)
.append(']')
.toString();
}
}
/**
* A strategy for testing the relationship between objects. Methods are expected to throw
* {@link AssertionFailedError} whenever the relationship is violated.
*
* <p>As a convenience, any occurrence of {@code $ITEM}, {@code $RELATED} or {@code $UNRELATED} in
* the error message will be replaced with a string that combines the {@link Object#toString()},
* item number and group number of the respective item.
*
*/
static abstract class RelationshipAssertion<T> {
abstract void assertRelated(T item, T related);
abstract void assertUnrelated(T item, T unrelated);
}
}
|
