-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathTestUtils.java
More file actions
221 lines (208 loc) · 8.12 KB
/
TestUtils.java
File metadata and controls
221 lines (208 loc) · 8.12 KB
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.test;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.AbstractMap;
import java.util.Map;
import org.scijava.util.FileUtils;
import org.scijava.util.Types;
/**
* A bunch of helpful functions for unit tests.
*
* @author Johannes Schindelin
* @author Curtis Rueden
*/
public class TestUtils {
/**
* Creates an empty file at the given path, creating intermediate directories
* as necessary.
*
* @param parent The parent directory of the relative path.
* @param path The forward-slash-separated path to create.
* @return a {@link File} pointing at the newly created empty path.
* @throws IOException if the file cannot be created.
*/
public static File createPath(final File parent, final String path)
throws IOException
{
File file = parent;
final String[] elements = path.split("/");
for (int i=0; i<elements.length; i++) {
file = new File(file, elements[i]);
if (i == elements.length - 1) file.createNewFile();
else file.mkdir();
}
return file;
}
/**
* Makes a temporary directory for use with unit tests.
* <p>
* When the unit test runs in a Maven context, the temporary directory will be
* created in the {@code target/} directory corresponding to the calling class
* instead of {@code /tmp/}.
* </p>
*
* @param prefix the prefix for the directory's name
* @return the reference to the newly-created temporary directory
* @throws IOException
*/
public static File createTemporaryDirectory(final String prefix) throws IOException {
final Map.Entry<Class<?>, String> calling = getCallingCodeLocation(null);
return createTemporaryDirectory(prefix, calling.getKey(), calling.getValue());
}
/**
* Makes a temporary directory for use with unit tests.
* <p>
* When the unit test runs in a Maven context, the temporary directory will be
* created in the corresponding {@code target/} directory instead of
* {@code /tmp/}.
* </p>
*
* @param prefix the prefix for the directory's name
* @param forClass the class for context (to determine whether there's a
* {@code target/} directory)
* @return the reference to the newly-created temporary directory
* @throws IOException
*/
public static File createTemporaryDirectory(final String prefix,
final Class<?> forClass) throws IOException
{
return createTemporaryDirectory(prefix, forClass, "" + temporaryDirectoryCounter++);
}
private static int temporaryDirectoryCounter = 1;
/**
* Makes a temporary directory for use with unit tests.
* <p>
* When the unit test runs in a Maven context, the temporary directory will be
* created in the corresponding {@code target/} directory instead of
* {@code /tmp/}.
* </p>
*
* @param prefix the prefix for the directory's name
* @param forClass the class for context (to determine whether there's a
* {@code target/} directory)
* @param suffix the suffix for the directory's name
* @return the reference to the newly-created temporary directory
* @throws IOException
*/
public static File createTemporaryDirectory(final String prefix,
final Class<?> forClass, final String suffix) throws IOException
{
final URL directory = Types.location(forClass);
if (directory == null) {
throw new IllegalArgumentException("No location for class " + forClass);
}
if (!"file".equals(directory.getProtocol())) {
throw new IllegalArgumentException("Invalid directory: " + directory);
}
final String path = directory.getPath();
if (path == null) throw new IllegalArgumentException("Directory has null path");
final File baseDirectory;
if (path.endsWith("/target/test-classes/")) {
baseDirectory = new File(path).getParentFile();
} else {
baseDirectory = new File(path);
}
File file = new File(baseDirectory, prefix + suffix);
if (file.isDirectory()) {
if (!FileUtils.deleteRecursively(file)) {
// Oh, how I *love* Windows. Love, love, love.
for (int i = -1; file.isDirectory(); i--) {
file = new File(baseDirectory, prefix + i + suffix);
}
}
}
else if (file.exists() && !file.delete()) {
throw new IOException("Could not remove " + file);
}
if (!file.mkdir()) throw new IOException("Could not make directory " + file);
return file;
}
/**
* Returns the class of the caller (excluding the specified class).
* <p>
* Sometimes it is convenient to determine the caller's context, e.g. to
* determine whether running in a maven-surefire-plugin context (in which case
* the location of the caller's class would end in
* {@code target/test-classes/}).
* </p>
*
* @param excluding the class to exclude (or null)
* @return the class of the caller
*/
public static Class<?> getCallingClass(final Class<?> excluding) {
return getCallingCodeLocation(excluding).getKey();
}
/**
* Returns the class and the method/line number of the caller (excluding the specified class).
* <p>
* Sometimes it is convenient to determine the caller's context, e.g. to
* determine whether running in a maven-surefire-plugin context (in which case
* the location of the caller's class would end in
* {@code target/test-classes/}).
* </p>
*
* @param excluding the class to exclude (or null)
* @return the class of the caller and the method and line number
*/
public static Map.Entry<Class<?>, String> getCallingCodeLocation(final Class<?> excluding) {
final String thisClassName = TestUtils.class.getName();
final String thisClassName2 = excluding == null ? null : excluding.getName();
final Thread currentThread = Thread.currentThread();
for (final StackTraceElement element : currentThread.getStackTrace()) {
final String thatClassName = element.getClassName();
if (thatClassName == null || thatClassName.equals(thisClassName) ||
thatClassName.equals(thisClassName2) ||
thatClassName.endsWith("TestUtils") ||
thatClassName.startsWith("java.lang.")) {
continue;
}
final ClassLoader loader = currentThread.getContextClassLoader();
final Class<?> clazz;
try {
clazz = loader.loadClass(element.getClassName());
final URL url = clazz.getResource("/" + clazz.getName().replace('.', '/') + ".class");
if (url == null || !"file".equals(url.getProtocol())) {
// the calling code location must be unpacked; Maven artifacts in $HOME/.m2/ are excluded
continue;
}
}
catch (ClassNotFoundException e) {
throw new UnsupportedOperationException("Could not load " +
element.getClassName() + " with the current context class loader (" +
loader + ")!");
}
final String suffix = element.getMethodName() + "-L" + element.getLineNumber();
return new AbstractMap.SimpleEntry<>(clazz, suffix);
}
throw new UnsupportedOperationException("No calling class outside " + thisClassName + " found!");
}
}