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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
* Copyright (C) 2010 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 com.android.ddmlib.testrunner;
import com.android.ddmlib.IDevice;
import com.android.ddmlib.AdbCommandRejectedException;
import com.android.ddmlib.ShellCommandUnresponsiveException;
import com.android.ddmlib.TimeoutException;
import java.io.IOException;
import java.util.Collection;
/**
* Interface for running a Android test command remotely and reporting result to a listener.
*/
public interface IRemoteAndroidTestRunner {
public static enum TestSize {
/** Run tests annotated with SmallTest */
SMALL("small"),
/** Run tests annotated with MediumTest */
MEDIUM("medium"),
/** Run tests annotated with LargeTest */
LARGE("large");
private String mRunnerValue;
/**
* Create a {@link TestSize}.
*
* @param runnerValue the {@link String} value that represents the size that is passed to
* device. Defined on device in android.test.InstrumentationTestRunner.
*/
TestSize(String runnerValue) {
mRunnerValue = runnerValue;
}
String getRunnerValue() {
return mRunnerValue;
}
/**
* Return the {@link TestSize} corresponding to the given Android platform defined value.
*
* @throws IllegalArgumentException if {@link TestSize} cannot be found.
*/
public static TestSize getTestSize(String value) {
// build the error message in the success case too, to avoid two for loops
StringBuilder msgBuilder = new StringBuilder("Unknown TestSize ");
msgBuilder.append(value);
msgBuilder.append(", Must be one of ");
for (TestSize size : values()) {
if (size.getRunnerValue().equals(value)) {
return size;
}
msgBuilder.append(size.getRunnerValue());
msgBuilder.append(", ");
}
throw new IllegalArgumentException(msgBuilder.toString());
}
}
/**
* Returns the application package name.
*/
public String getPackageName();
/**
* Returns the runnerName.
*/
public String getRunnerName();
/**
* Sets to run only tests in this class
* Must be called before 'run'.
*
* @param className fully qualified class name (eg x.y.z)
*/
public void setClassName(String className);
/**
* Sets to run only tests in the provided classes
* Must be called before 'run'.
* <p>
* If providing more than one class, requires a InstrumentationTestRunner that supports
* the multiple class argument syntax.
*
* @param classNames array of fully qualified class names (eg x.y.z)
*/
public void setClassNames(String[] classNames);
/**
* Sets to run only specified test method
* Must be called before 'run'.
*
* @param className fully qualified class name (eg x.y.z)
* @param testName method name
*/
public void setMethodName(String className, String testName);
/**
* Sets to run all tests in specified package
* Must be called before 'run'.
*
* @param packageName fully qualified package name (eg x.y.z)
*/
public void setTestPackageName(String packageName);
/**
* Sets to run only tests of given size.
* Must be called before 'run'.
*
* @param size the {@link TestSize} to run.
*/
public void setTestSize(TestSize size);
/**
* Adds a argument to include in instrumentation command.
* <p/>
* Must be called before 'run'. If an argument with given name has already been provided, it's
* value will be overridden.
*
* @param name the name of the instrumentation bundle argument
* @param value the value of the argument
*/
public void addInstrumentationArg(String name, String value);
/**
* Removes a previously added argument.
*
* @param name the name of the instrumentation bundle argument to remove
*/
public void removeInstrumentationArg(String name);
/**
* Adds a boolean argument to include in instrumentation command.
* <p/>
* @see RemoteAndroidTestRunner#addInstrumentationArg
*
* @param name the name of the instrumentation bundle argument
* @param value the value of the argument
*/
public void addBooleanArg(String name, boolean value);
/**
* Sets this test run to log only mode - skips test execution.
*/
public void setLogOnly(boolean logOnly);
/**
* Sets this debug mode of this test run. If true, the Android test runner will wait for a
* debugger to attach before proceeding with test execution.
*/
public void setDebug(boolean debug);
/**
* Sets this code coverage mode of this test run.
*/
public void setCoverage(boolean coverage);
/**
* Sets the maximum time allowed between output of the shell command running the tests on
* the devices.
* <p/>
* This allows setting a timeout in case the tests can become stuck and never finish. This is
* different from the normal timeout on the connection.
* <p/>
* By default no timeout will be specified.
*
* @see {@link IDevice#executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, int)}
*/
public void setMaxtimeToOutputResponse(int maxTimeToOutputResponse);
/**
* Set a custom run name to be reported to the {@link ITestRunListener} on {@link #run}
* <p/>
* If unspecified, will use package name
*
* @param runName
*/
public void setRunName(String runName);
/**
* Execute this test run.
* <p/>
* Convenience method for {@link #run(Collection)}.
*
* @param listeners listens for test results
* @throws TimeoutException in case of a timeout on the connection.
* @throws AdbCommandRejectedException if adb rejects the command
* @throws ShellCommandUnresponsiveException if the device did not output any test result for
* a period longer than the max time to output.
* @throws IOException if connection to device was lost.
*
* @see #setMaxtimeToOutputResponse(int)
*/
public void run(ITestRunListener... listeners)
throws TimeoutException, AdbCommandRejectedException, ShellCommandUnresponsiveException,
IOException;
/**
* Execute this test run.
*
* @param listeners collection of listeners for test results
* @throws TimeoutException in case of a timeout on the connection.
* @throws AdbCommandRejectedException if adb rejects the command
* @throws ShellCommandUnresponsiveException if the device did not output any test result for
* a period longer than the max time to output.
* @throws IOException if connection to device was lost.
*
* @see #setMaxtimeToOutputResponse(int)
*/
public void run(Collection<ITestRunListener> listeners)
throws TimeoutException, AdbCommandRejectedException, ShellCommandUnresponsiveException,
IOException;
/**
* Requests cancellation of this test run.
*/
public void cancel();
}
|
