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
|
/*
* Copyright (C) 2012 The Android Open Source Project
*
* 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 android.support.test.internal.runner;
import android.util.Log;
import org.junit.runner.Description;
import org.junit.runner.notification.Failure;
import java.io.PrintStream;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.LinkedList;
import java.util.List;
/**
* A class for loading JUnit3 and JUnit4 test classes given a set of potential class names.
*/
public class TestLoader {
private static final String LOG_TAG = "TestLoader";
private List<Class<?>> mLoadedClasses = new LinkedList<Class<?>>();
private List<Failure> mLoadFailures = new LinkedList<Failure>();
private PrintStream mWriter;
/**
* Create a {@link TestLoader}.
*
* @param writer a {@link PrintStream} used for reporting errors.
*/
public TestLoader(PrintStream writer) {
mWriter = writer;
}
/**
* Loads the test class from the given class name.
* <p/>
* Will store the result internally. Successfully loaded classes can be retrieved via
* {@link #getLoadedClasses()}, failures via {@link #getLoadFailures()}.
*
* @param className the class name to attempt to load
* @return the loaded class or null.
*/
public Class<?> loadClass(String className) {
Class<?> loadedClass = doLoadClass(className);
if (loadedClass != null) {
mLoadedClasses.add(loadedClass);
}
return loadedClass;
}
private Class<?> doLoadClass(String className) {
try {
// TODO: InstrumentationTestRunner uses Class.forName(className, false,
// getTargetContext().getClassLoader()
// Evaluate if that is needed. Initial testing indicates
// getTargetContext().getClassLoader() == this.getClass().getClassLoader()
ClassLoader myClassLoader = this.getClass().getClassLoader();
return Class.forName(className, false, myClassLoader);
} catch (ClassNotFoundException e) {
String errMsg = String.format("Could not find class: %s", className);
Log.e(LOG_TAG, errMsg);
mWriter.println(errMsg);
Description description = Description.createSuiteDescription(className);
Failure failure = new Failure(description, e);
mLoadFailures.add(failure);
}
return null;
}
/**
* Loads the test class from the given class name.
* <p/>
* Similar to {@link #loadClass(String, PrintStream))}, but will ignore classes that are
* not tests.
*
* @param className the class name to attempt to load
* @return the loaded class or null.
*/
public Class<?> loadIfTest(String className) {
Class<?> loadedClass = doLoadClass(className);
if (loadedClass != null && isTestClass(loadedClass)) {
mLoadedClasses.add(loadedClass);
return loadedClass;
}
return null;
}
/**
* @return whether this {@link TestLoader} contains any loaded classes or load failures.
*/
public boolean isEmpty() {
return mLoadedClasses.isEmpty() && mLoadFailures.isEmpty();
}
/**
* Get the {@link List) of classes successfully loaded via
* {@link #loadTest(String, PrintStream)} calls.
*/
public List<Class<?>> getLoadedClasses() {
return mLoadedClasses;
}
/**
* Get the {@link List) of {@link Failure} that occurred during
* {@link #loadTest(String, PrintStream)} calls.
*/
public List<Failure> getLoadFailures() {
return mLoadFailures;
}
/**
* Determines if given class is a valid test class.
*
* @param loadedClass
* @return <code>true</code> if loadedClass is a test
*/
private boolean isTestClass(Class<?> loadedClass) {
try {
if (Modifier.isAbstract(loadedClass.getModifiers())) {
logDebug(String.format("Skipping abstract class %s: not a test",
loadedClass.getName()));
return false;
}
// TODO: try to find upstream junit calls to replace these checks
if (junit.framework.Test.class.isAssignableFrom(loadedClass)) {
// ensure that if a TestCase, it has at least one test method otherwise
// TestSuite will throw error
if (junit.framework.TestCase.class.isAssignableFrom(loadedClass)) {
return hasJUnit3TestMethod(loadedClass);
}
return true;
}
// TODO: look for a 'suite' method?
if (loadedClass.isAnnotationPresent(org.junit.runner.RunWith.class)) {
return true;
}
for (Method testMethod : loadedClass.getMethods()) {
if (testMethod.isAnnotationPresent(org.junit.Test.class)) {
return true;
}
}
logDebug(String.format("Skipping class %s: not a test", loadedClass.getName()));
return false;
} catch (Exception e) {
// Defensively catch exceptions - Will throw runtime exception if it cannot load methods.
// For earlier versions of Android (Pre-ICS), Dalvik might try to initialize a class
// during getMethods(), fail to do so, hide the error and throw a NoSuchMethodException.
// Since the java.lang.Class.getMethods does not declare such an exception, resort to a
// generic catch all.
// For ICS+, Dalvik will throw a NoClassDefFoundException.
Log.w(LOG_TAG, String.format("%s in isTestClass for %s", e.toString(),
loadedClass.getName()));
return false;
} catch (Error e) {
// defensively catch Errors too
Log.w(LOG_TAG, String.format("%s in isTestClass for %s", e.toString(),
loadedClass.getName()));
return false;
}
}
private boolean hasJUnit3TestMethod(Class<?> loadedClass) {
for (Method testMethod : loadedClass.getMethods()) {
if (isPublicTestMethod(testMethod)) {
return true;
}
}
return false;
}
// copied from junit.framework.TestSuite
private boolean isPublicTestMethod(Method m) {
return isTestMethod(m) && Modifier.isPublic(m.getModifiers());
}
// copied from junit.framework.TestSuite
private boolean isTestMethod(Method m) {
return m.getParameterTypes().length == 0 && m.getName().startsWith("test")
&& m.getReturnType().equals(Void.TYPE);
}
/**
* Utility method for logging debug messages. Only actually logs a message if LOG_TAG is marked
* as loggable to limit log spam during normal use.
*/
private void logDebug(String msg) {
if (Log.isLoggable(LOG_TAG, Log.DEBUG)) {
Log.d(LOG_TAG, msg);
}
}
}
|
