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
|
package com.vaadin.tests.tb3;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Modifier;
import java.net.JarURLConnection;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
public class TB3TestLocator {
/**
* Traverses the directory on the classpath (inside or outside a Jar file)
* specified by 'basePackage'. Collects all classes inside the location
* which can be assigned to 'baseClass' except for classes inside packages
* listed in 'ignoredPackages'.
*
* @param baseClass
* @param basePackage
* @param ignorePackages
* @return
*/
public Class<?>[] findTests(Class<? extends AbstractTB3Test> baseClass,
String basePackage, String[] ignorePackages) {
try {
List<?> l = findClasses(baseClass, basePackage, ignorePackages);
return l.toArray(new Class[] {});
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
/**
* Traverses the directory on the classpath (inside or outside a Jar file)
* specified by 'basePackage'. Collects all classes inside the location
* which can be assigned to 'baseClass' except for classes inside packages
* listed in 'ignoredPackages'.
*
* @param baseClass
* @param basePackage
* @param ignoredPackages
* @return
* @throws IOException
*/
protected <T> List<Class<? extends T>> findClasses(Class<T> baseClass,
String basePackage, String[] ignoredPackages) throws IOException {
List<Class<? extends T>> classes = new ArrayList<>();
String basePackageDirName = "/" + basePackage.replace('.', '/');
URL location = baseClass.getResource(basePackageDirName);
if (location.getProtocol().equals("file")) {
try {
File f = new File(location.toURI());
if (!f.exists()) {
throw new IOException("Directory " + f + " does not exist");
}
findPackages(f, basePackage, baseClass, classes,
ignoredPackages);
} catch (URISyntaxException e) {
throw new IOException(e.getMessage());
}
} else if (location.getProtocol().equals("jar")) {
JarURLConnection juc = (JarURLConnection) location.openConnection();
findClassesInJar(juc, basePackage, baseClass, classes);
}
Collections.sort(classes,
(o1, o2) -> o1.getName().compareTo(o2.getName()));
return classes;
}
/**
* Traverses the given directory and collects all classes which are inside
* the given 'javaPackage' and can be assigned to the given 'baseClass'. The
* found classes are added to 'result'.
*
* @param parent
* The directory to traverse
* @param javaPackage
* The java package which 'parent' contains
* @param baseClass
* The class which the target classes extend
* @param result
* The collection to which found classes are added
* @param ignoredPackages
* A collection of packages (including sub packages) to ignore
*/
private <T> void findPackages(File parent, String javaPackage,
Class<T> baseClass, Collection<Class<? extends T>> result,
String[] ignoredPackages) {
for (String ignoredPackage : ignoredPackages) {
if (javaPackage.equals(ignoredPackage)) {
return;
}
}
for (File file : parent.listFiles()) {
if (file.isDirectory()) {
findPackages(file, javaPackage + "." + file.getName(),
baseClass, result, ignoredPackages);
} else if (file.getName().endsWith(".class")) {
String fullyQualifiedClassName = javaPackage + "."
+ file.getName().replace(".class", "");
addClassIfMatches(result, fullyQualifiedClassName, baseClass);
}
}
}
/**
* Traverses a Jar file using the given connection and collects all classes
* which are inside the given 'javaPackage' and can be assigned to the given
* 'baseClass'. The found classes are added to 'result'.
*
* @param javaPackage
* The java package containing the classes (classes may be in a
* sub package)
* @param baseClass
* The class which the target classes extend
* @param result
* The collection to which found classes are added
* @throws IOException
*/
private <T> void findClassesInJar(JarURLConnection juc, String javaPackage,
Class<T> baseClass, Collection<Class<? extends T>> result)
throws IOException {
String javaPackageDir = javaPackage.replace('.', '/');
Enumeration<JarEntry> ent = juc.getJarFile().entries();
while (ent.hasMoreElements()) {
JarEntry e = ent.nextElement();
if (e.getName().endsWith(".class")
&& e.getName().startsWith(javaPackageDir)) {
String fullyQualifiedClassName = e.getName().replace('/', '.')
.replace(".class", "");
addClassIfMatches(result, fullyQualifiedClassName, baseClass);
}
}
}
/**
* Verifies that the class represented by 'fullyQualifiedClassName' can be
* loaded, assigned to 'baseClass' and is not an abstract or anonymous
* class.
*
* @param result
* The collection to add to
* @param fullyQualifiedClassName
* The candidate class
* @param baseClass
* The class 'fullyQualifiedClassName' should be assignable to
*/
@SuppressWarnings("unchecked")
protected <T> void addClassIfMatches(Collection<Class<? extends T>> result,
String fullyQualifiedClassName, Class<T> baseClass) {
try {
// Try to load the class
Class<?> c = Class.forName(fullyQualifiedClassName);
if (!baseClass.isAssignableFrom(c)) {
return;
}
if (!includeInSuite(c)) {
return;
}
if (!Modifier.isAbstract(c.getModifiers())
&& !c.isAnonymousClass()) {
result.add((Class<? extends T>) c);
}
} catch (Exception e) {
// Could ignore that class cannot be loaded
e.printStackTrace();
} catch (LinkageError e) {
// Ignore. Client side classes will at least throw LinkageErrors
}
}
/**
* @return true if the class should be included in the suite, false if not
*/
private boolean includeInSuite(Class<?> c) {
if (c.getAnnotation(ExcludeFromSuite.class) != null) {
return false;
}
IncludeIfProperty includeIfProperty = c
.getAnnotation(IncludeIfProperty.class);
if (includeIfProperty != null) {
String includeValue = includeIfProperty.value();
String systemPropertyValue = System
.getProperty(includeIfProperty.property());
if (!includeValue.equals(systemPropertyValue)) {
return false;
}
}
return true;
}
}
|
