1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
5  * except in compliance with the License. You may obtain a copy of the License at
6  *
7  *      http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software distributed under the
10  * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
11  * KIND, either express or implied. See the License for the specific language governing
12  * permissions and limitations under the License.
13  */
14 
15 package android.testing;
16 
17 import android.support.test.internal.runner.junit4.statement.RunAfters;
18 import android.support.test.internal.runner.junit4.statement.RunBefores;
19 import android.support.test.internal.runner.junit4.statement.UiThreadStatement;
20 
21 import android.testing.TestableLooper.LooperFrameworkMethod;
22 import android.testing.TestableLooper.RunWithLooper;
23 
24 import org.junit.After;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.junit.internal.runners.statements.FailOnTimeout;
28 import org.junit.runners.BlockJUnit4ClassRunner;
29 import org.junit.runners.model.FrameworkMethod;
30 import org.junit.runners.model.InitializationError;
31 import org.junit.runners.model.Statement;
32 
33 import java.util.ArrayList;
34 import java.util.List;
35 
36 /**
37  * A runner with support for extra annotations provided by the Testables library.
38  */
39 public class AndroidTestingRunner extends BlockJUnit4ClassRunner {
40 
41     private final long mTimeout;
42     private final Class<?> mKlass;
43 
AndroidTestingRunner(Class<?> klass)44     public AndroidTestingRunner(Class<?> klass) throws InitializationError {
45         super(klass);
46         mKlass = klass;
47         // Can't seem to get reference to timeout parameter from here, so set default to 10 mins.
48         mTimeout = 10 * 60 * 1000;
49     }
50 
51     @Override
methodInvoker(FrameworkMethod method, Object test)52     protected Statement methodInvoker(FrameworkMethod method, Object test) {
53         method = looperWrap(method, test, method);
54         final Statement statement = super.methodInvoker(method, test);
55         return shouldRunOnUiThread(method) ? new UiThreadStatement(statement, true) : statement;
56     }
57 
withBefores(FrameworkMethod method, Object target, Statement statement)58     protected Statement withBefores(FrameworkMethod method, Object target, Statement statement) {
59         List befores = looperWrap(method, target,
60                 this.getTestClass().getAnnotatedMethods(Before.class));
61         return befores.isEmpty() ? statement : new RunBefores(method, statement,
62                 befores, target);
63     }
64 
withAfters(FrameworkMethod method, Object target, Statement statement)65     protected Statement withAfters(FrameworkMethod method, Object target, Statement statement) {
66         List afters = looperWrap(method, target,
67                 this.getTestClass().getAnnotatedMethods(After.class));
68         return afters.isEmpty() ? statement : new RunAfters(method, statement, afters,
69                 target);
70     }
71 
withPotentialTimeout(FrameworkMethod method, Object test, Statement next)72     protected Statement withPotentialTimeout(FrameworkMethod method, Object test, Statement next) {
73         long timeout = this.getTimeout(method.getAnnotation(Test.class));
74         if (timeout <= 0L && mTimeout > 0L) {
75             timeout = mTimeout;
76         }
77 
78         return timeout <= 0L ? next : new FailOnTimeout(next, timeout);
79     }
80 
getTimeout(Test annotation)81     private long getTimeout(Test annotation) {
82         return annotation == null ? 0L : annotation.timeout();
83     }
84 
looperWrap(FrameworkMethod method, Object test, List<FrameworkMethod> methods)85     protected List<FrameworkMethod> looperWrap(FrameworkMethod method, Object test,
86             List<FrameworkMethod> methods) {
87         RunWithLooper annotation = method.getAnnotation(RunWithLooper.class);
88         if (annotation == null) annotation = mKlass.getAnnotation(RunWithLooper.class);
89         if (annotation != null) {
90             methods = new ArrayList<>(methods);
91             for (int i = 0; i < methods.size(); i++) {
92                 methods.set(i, LooperFrameworkMethod.get(methods.get(i),
93                         annotation.setAsMainLooper(), test));
94             }
95         }
96         return methods;
97     }
98 
looperWrap(FrameworkMethod method, Object test, FrameworkMethod base)99     protected FrameworkMethod looperWrap(FrameworkMethod method, Object test,
100             FrameworkMethod base) {
101         RunWithLooper annotation = method.getAnnotation(RunWithLooper.class);
102         if (annotation == null) annotation = mKlass.getAnnotation(RunWithLooper.class);
103         if (annotation != null) {
104             return LooperFrameworkMethod.get(base, annotation.setAsMainLooper(), test);
105         }
106         return base;
107     }
108 
shouldRunOnUiThread(FrameworkMethod method)109     public boolean shouldRunOnUiThread(FrameworkMethod method) {
110         if (mKlass.getAnnotation(UiThreadTest.class) != null) {
111             return true;
112         } else {
113             return UiThreadStatement.shouldRunOnUiThread(method);
114         }
115     }
116 }
117