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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.apache.poi;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.endsWith;
import static org.hamcrest.CoreMatchers.hasItem;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
import java.lang.reflect.Field;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.poi.util.Internal;
import org.apache.poi.util.SuppressForbidden;
import org.mockito.internal.matchers.apachecommons.ReflectionEquals;
/**
* Util class for POI JUnit TestCases, which provide additional features
*/
@Internal
public final class POITestCase {
private POITestCase() {
}
public static void assertStartsWith(String string, String prefix) {
assertNotNull(string);
assertNotNull(prefix);
assertThat(string, startsWith(prefix));
}
public static void assertStartsWith(String message, String string, String prefix) {
assertNotNull(message, string);
assertNotNull(message, prefix);
assertThat(message, string, startsWith(prefix));
}
public static void assertEndsWith(String string, String suffix) {
assertNotNull(string);
assertNotNull(suffix);
assertThat(string, endsWith(suffix));
}
public static void assertContains(String haystack, String needle) {
assertNotNull(haystack);
assertNotNull(needle);
assertThat(haystack, containsString(needle));
}
public static void assertContains(String message, String haystack, String needle) {
assertNotNull(message, haystack);
assertNotNull(message, needle);
assertThat(message, haystack, containsString(needle));
}
public static void assertContainsIgnoreCase(String haystack, String needle, Locale locale) {
assertNotNull(haystack);
assertNotNull(needle);
String hay = haystack.toLowerCase(locale);
String n = needle.toLowerCase(locale);
assertTrue(hay.contains(n), "Unable to find expected text '" + needle + "' in text:\n" + haystack);
}
public static void assertContainsIgnoreCase(String haystack, String needle) {
assertContainsIgnoreCase(haystack, needle, Locale.ROOT);
}
public static void assertNotContained(String haystack, String needle) {
assertNotNull(haystack);
assertNotNull(needle);
assertThat(haystack, not(containsString(needle)));
}
/**
* @param map haystack
* @param key needle
*/
public static <T> void assertContains(Map<T, ?> map, T key) {
assertTrue(map.containsKey(key), "Unable to find " + key + " in " + map);
}
public static <T> void assertNotContained(Set<T> set, T element) {
assertThat("Set should not contain " + element, set, not(hasItem(element)));
}
/**
* Utility method to get the value of a private/protected field.
* Only use this method in test cases!!!
*/
@SuppressWarnings({"unused", "unchecked"})
@SuppressForbidden("For test usage only")
public static <R,T> R getFieldValue(final Class<? super T> clazz, final T instance, final Class<R> fieldType, final String fieldName) {
assertTrue(clazz.getName().startsWith("org.apache.poi."), "Reflection of private fields is only allowed for POI classes.");
try {
return AccessController.doPrivileged((PrivilegedExceptionAction<R>) () -> {
Field f = clazz.getDeclaredField(fieldName);
f.setAccessible(true);
return (R) f.get(instance);
});
} catch (PrivilegedActionException pae) {
throw new RuntimeException("Cannot access field '" + fieldName + "' of class " + clazz, pae.getException());
}
}
/**
* Utility method to shallow compare all fields of the objects
* Only use this method in test cases!!!
*/
public static void assertReflectEquals(final Object expected, Object actual) {
// as long as ReflectionEquals is provided by Mockito, use it ... otherwise use commons.lang for the tests
// JaCoCo Code Coverage adds its own field, don't look at this one here
assertTrue(new ReflectionEquals(expected, "$jacocoData").matches(actual));
}
/**
* Rather than adding {@literal @}Ignore to known-failing tests,
* write the test so that it notifies us if it starts passing.
* This is useful for closing related or forgotten bugs.
*
* An Example:
* <code><pre>
* public static int add(int a, int b) {
* // a known bug in behavior that has not been fixed yet
* raise UnsupportedOperationException("add");
* }
*
* {@literal @}Test
* void knownFailingUnitTest() {
* try {
* assertEquals(2, add(1,1));
* // this test fails because the assumption that this bug had not been fixed is false
* testPassesNow(12345);
* } catch (UnsupportedOperationException e) {
* // test is skipped because the assumption that this bug had not been fixed is true
* skipTest(e);
* }
* }
*
* Once passing, this unit test can be rewritten as:
* {@literal @}Test
* void knownPassingUnitTest() {
* assertEquals(2, add(1,1));
* }
*
* If you have a better idea how to simplify test code while still notifying
* us when a previous known-failing test now passes, please improve these.
* As a bonus, a known-failing test that fails should not be counted as a
* passing test.
*
* One possible alternative is to expect the known exception, but without
* a clear message that it is a good thing to no longer get the expected
* exception once the test passes.
* {@literal @}Test(expected=UnsupportedOperationException.class)
* void knownFailingUnitTest() {
* assertEquals(2, add(1,1));
* }
*
* @param e the exception that was caught that will no longer
* be raised when the bug is fixed
*/
public static void skipTest(Throwable e) {
assumeTrue(e != null, "This test currently fails with");
}
/**
* @see #skipTest(Throwable)
*
* @param bug the bug number corresponding to a known bug in bugzilla
*/
public static void testPassesNow(int bug) {
fail("This test passes now. Please update the unit test and bug " + bug + ".");
}
public static void assertBetween(String message, int value, int min, int max) {
assertTrue(min <= value, message + ": " + value + " is less than the minimum value of " + min);
assertTrue(value <= max, message + ": " + value + " is greater than the maximum value of " + max);
}
}
|
