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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* 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.vaadin.tests.tb3;
import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runners.BlockJUnit4ClassRunner;
import org.junit.runners.Parameterized;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.Statement;
import org.openqa.selenium.remote.DesiredCapabilities;
import com.vaadin.tests.annotations.TestCategory;
import com.vaadin.tests.tb3.AbstractTB3Test.BrowserUtil;
import com.vaadin.tests.tb3.AbstractTB3Test.RunLocally;
/**
* This runner is loosely based on FactoryTestRunner by Ted Young
* (http://tedyoung.me/2011/01/23/junit-runtime-tests-custom-runners/). The
* generated test names give information about the parameters used (unlike
* {@link Parameterized}).
*
* @since 7.1
*/
public class TB3Runner extends BlockJUnit4ClassRunner {
/**
* This is the total limit of actual JUnit test instances run in parallel
*/
private static final int MAX_CONCURRENT_TESTS;
/**
* This is static so it is shared by all tests running concurrently on the
* same machine and thus can limit the number of threads in use.
*/
private static final ExecutorService service;
static {
if (localWebDriverIsUsed()) {
MAX_CONCURRENT_TESTS = 10;
} else {
MAX_CONCURRENT_TESTS = 50;
}
service = Executors.newFixedThreadPool(MAX_CONCURRENT_TESTS);
}
protected static boolean localWebDriverIsUsed() {
String useLocalWebDriver = System.getProperty("useLocalWebDriver");
return useLocalWebDriver != null && useLocalWebDriver.toLowerCase().equals("true");
}
public TB3Runner(Class<?> klass) throws InitializationError {
super(klass);
setScheduler(new ParallelScheduler(service));
}
@Override
protected List<FrameworkMethod> computeTestMethods() {
List<FrameworkMethod> tests = new LinkedList<FrameworkMethod>();
if (!AbstractTB3Test.class.isAssignableFrom(getTestClass()
.getJavaClass())) {
throw new RuntimeException(getClass().getName() + " only supports "
+ AbstractTB3Test.class.getName());
}
try {
AbstractTB3Test testClassInstance = getTestClassInstance();
Collection<DesiredCapabilities> desiredCapabilities = getDesiredCapabilities(testClassInstance);
TestNameSuffix testNameSuffixProperty = findAnnotation(
testClassInstance.getClass(), TestNameSuffix.class);
for (FrameworkMethod m : getTestMethods()) {
// No browsers available for this test, so we need to
// wrap the test method inside IgnoredTestMethod.
// This will add @Ignore annotation to it.
if (desiredCapabilities.size() <= 0
|| categoryIsExcludedOrNotExcplicitlyIncluded()) {
tests.add(new IgnoredTestMethod(m.getMethod()));
} else {
for (DesiredCapabilities capabilities : desiredCapabilities) {
TB3Method method = new TB3Method(m.getMethod(),
capabilities);
if (testNameSuffixProperty != null) {
method.setTestNameSuffix("-"
+ System.getProperty(testNameSuffixProperty
.property()));
}
tests.add(method);
}
}
}
} catch (Exception e) {
throw new RuntimeException("Error retrieving browsers to run on", e);
}
return tests;
}
private boolean categoryIsExcludedOrNotExcplicitlyIncluded() {
Class<?> c = getTestClass().getJavaClass();
if (categoryIsExcluded(c)) {
return true;
}
if (explicitInclusionIsUsed()) {
return !categoryIsIncluded(c);
}
return false;
}
private boolean categoryIsIncluded(Class<?> c) {
String include = System.getProperty("categories.include");
if (include != null && include.trim().length() > 0) {
return hasCategoryFor(c, include.toLowerCase().trim());
}
return false;
}
private static boolean explicitInclusionIsUsed() {
String include = System.getProperty("categories.include");
return include != null && include.trim().length() > 0;
}
private static boolean categoryIsExcluded(Class<?> c) {
String exclude = System.getProperty("categories.exclude");
if (exclude != null && exclude.trim().length() > 0) {
return hasCategoryFor(c, exclude.toLowerCase().trim());
}
return false;
}
private static boolean hasCategoryFor(Class<?> c, String searchString) {
if (hasCategory(c)) {
return searchString.contains(getCategory(c).toLowerCase());
}
return false;
}
private static boolean hasCategory(Class<?> c) {
return c.getAnnotation(TestCategory.class) != null;
}
private static String getCategory(Class<?> c) {
return c.getAnnotation(TestCategory.class).value();
}
private List<FrameworkMethod> getTestMethods() {
return getTestClass().getAnnotatedMethods(Test.class);
}
/*
* Returns a list of desired browser capabilities according to browsers
* defined in the test class, filtered by possible filter parameters. Use
* {@code @RunLocally} annotation to override all capabilities.
*/
private Collection<DesiredCapabilities> getDesiredCapabilities(
AbstractTB3Test testClassInstance) {
Collection<DesiredCapabilities> desiredCapabilites = getFilteredCapabilities(testClassInstance);
if (isRunLocally(testClassInstance)) {
desiredCapabilites = new ArrayList<DesiredCapabilities>();
desiredCapabilites.add(testClassInstance.getClass()
.getAnnotation(RunLocally.class).value()
.getDesiredCapabilities());
}
return desiredCapabilites;
}
/*
* Takes the desired browser capabilities defined in the test class and
* returns a list of browser capabilities filtered browsers.include and
* browsers.exclude system properties. (if present)
*/
private Collection<DesiredCapabilities> getFilteredCapabilities(
AbstractTB3Test testClassInstance) {
Collection<DesiredCapabilities> desiredCapabilites = testClassInstance
.getBrowsersToTest();
ArrayList<DesiredCapabilities> filteredCapabilities = new ArrayList<DesiredCapabilities>();
String include = System.getProperty("browsers.include");
String exclude = System.getProperty("browsers.exclude");
for (DesiredCapabilities d : desiredCapabilites) {
String browserName = (d.getBrowserName() + d.getVersion())
.toLowerCase();
if (include != null && include.trim().length() > 0) {
if (include.trim().toLowerCase().contains(browserName)) {
filteredCapabilities.add(d);
}
} else {
filteredCapabilities.add(d);
}
if (exclude != null && exclude.trim().length() > 0) {
if (exclude.trim().toLowerCase().contains(browserName)) {
filteredCapabilities.remove(d);
}
}
}
return filteredCapabilities;
}
private boolean isRunLocally(AbstractTB3Test testClassInstance) {
return testClassInstance.getClass().getAnnotation(RunLocally.class) != null;
}
private AbstractTB3Test getTestClassInstance()
throws InstantiationException, IllegalAccessException,
InvocationTargetException {
AbstractTB3Test testClassInstance = (AbstractTB3Test) getTestClass()
.getOnlyConstructor().newInstance();
return testClassInstance;
}
// This is a FrameworkMethod class that will always
// return @Ignore and @Test annotations for the wrapped method.
private class IgnoredTestMethod extends FrameworkMethod {
private class IgnoreTestAnnotations {
// We use this method to easily get our hands on
// the Annotation instances for @Ignore and @Test
@Ignore
@Test
public void ignoredTest() {
}
}
public IgnoredTestMethod(Method method) {
super(method);
}
@Override
public Annotation[] getAnnotations() {
return getIgnoredTestMethod().getAnnotations();
}
private Method getIgnoredTestMethod() {
try {
return IgnoreTestAnnotations.class.getMethod("ignoredTest",
null);
} catch (Exception e) {
return null;
}
}
@Override
public <T extends Annotation> T getAnnotation(Class<T> annotationType) {
return getIgnoredTestMethod().getAnnotation(annotationType);
}
}
/**
* Finds the given annotation in the given class or one of its super
* classes. Return the first found annotation
*
* @param searchClass
* @param annotationClass
* @return
*/
private <T extends Annotation> T findAnnotation(Class<?> searchClass,
Class<T> annotationClass) {
if (searchClass == Object.class) {
return null;
}
if (searchClass.getAnnotation(annotationClass) != null) {
return searchClass.getAnnotation(annotationClass);
}
return findAnnotation(searchClass.getSuperclass(), annotationClass);
}
/*
* (non-Javadoc)
*
* @see
* org.junit.runners.BlockJUnit4ClassRunner#withBefores(org.junit.runners
* .model.FrameworkMethod, java.lang.Object,
* org.junit.runners.model.Statement)
*/
@Override
protected Statement withBefores(final FrameworkMethod method,
final Object target, Statement statement) {
if (!(method instanceof TB3Method)) {
throw new RuntimeException("Unexpected method type "
+ method.getClass().getName() + ", expected TB3Method");
}
final TB3Method tb3method = (TB3Method) method;
// setDesiredCapabilities before running the real @Befores (which use
// capabilities)
final Statement realBefores = super.withBefores(method, target,
statement);
return new Statement() {
@Override
public void evaluate() throws Throwable {
((AbstractTB3Test) target)
.setDesiredCapabilities(tb3method.capabilities);
try {
realBefores.evaluate();
} catch (Throwable t) {
// Give the test a chance to e.g. produce an error
// screenshot before failing the test by re-throwing the
// exception
((AbstractTB3Test) target).onUncaughtException(t);
throw t;
}
}
};
}
private static class TB3Method extends FrameworkMethod {
private DesiredCapabilities capabilities;
private String testNameSuffix = "";
public TB3Method(Method method, DesiredCapabilities capabilities) {
super(method);
this.capabilities = capabilities;
}
public void setTestNameSuffix(String testNameSuffix) {
this.testNameSuffix = testNameSuffix;
}
@Override
public Object invokeExplosively(final Object target, Object... params)
throws Throwable {
// Executes the test method with the supplied parameters
return super.invokeExplosively(target);
}
@Override
public String getName() {
return String.format("%s[%s]", getMethod().getName()
+ testNameSuffix,
BrowserUtil.getUniqueIdentifier(capabilities));
}
}
}
|