aboutsummaryrefslogtreecommitdiff
path: root/src/io/appium/droiddriver/runner/TestRunner.java
blob: e3fbe79216581ff5e5dac90c2aaec43088174fa5 (plain)
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
/*
 * Copyright (C) 2013 DroidDriver committers
 *
 * 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 io.appium.droiddriver.runner;

import android.app.Activity;
import android.os.Build;
import android.os.Bundle;
import android.test.AndroidTestRunner;
import android.test.InstrumentationTestRunner;
import android.test.suitebuilder.TestMethod;
import android.util.Log;

import com.android.internal.util.Predicate;

import junit.framework.AssertionFailedError;
import junit.framework.Test;
import junit.framework.TestListener;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import io.appium.droiddriver.helpers.DroidDrivers;
import io.appium.droiddriver.util.ActivityUtils;
import io.appium.droiddriver.util.ActivityUtils.Supplier;
import io.appium.droiddriver.util.InstrumentationUtils;
import io.appium.droiddriver.util.Logs;

/**
 * Adds activity watcher to InstrumentationTestRunner.
 *
 * @deprecated Use android.support.test.runner.AndroidJUnitRunner instead.
 */
@Deprecated
public class TestRunner extends InstrumentationTestRunner {
  private final Set<Activity> activities = new HashSet<Activity>();
  private final AndroidTestRunner androidTestRunner = new AndroidTestRunner();
  private volatile Activity runningActivity;

  /**
   * Returns an {@link AndroidTestRunner} that is shared by this and super, such
   * that we can add custom {@link TestListener}s.
   */
  @Override
  protected AndroidTestRunner getAndroidTestRunner() {
    return androidTestRunner;
  }

  /**
   * {@inheritDoc}
   * <p>
   * Initializes {@link InstrumentationUtils}.
   */
  @Override
  public void onCreate(Bundle arguments) {
    InstrumentationUtils.init(this, arguments);
    super.onCreate(arguments);
  }

  /**
   * {@inheritDoc}
   * <p>
   * Adds a {@link TestListener} that finishes all created activities.
   */
  @Override
  public void onStart() {
    getAndroidTestRunner().addTestListener(new TestListener() {
      @Override
      public void endTest(Test test) {
        // Try to finish activity on best-effort basis - TestListener should
        // not throw.
        final Activity[] activitiesCopy;
        synchronized (activities) {
          if (activities.isEmpty()) {
            return;
          }
          activitiesCopy = activities.toArray(new Activity[activities.size()]);
        }

        try {
          InstrumentationUtils.runOnMainSyncWithTimeout(new Runnable() {
            @Override
            public void run() {
              for (Activity activity : activitiesCopy) {
                if (!activity.isFinishing()) {
                  try {
                    Logs.log(Log.INFO, "Stopping activity: " + activity);
                    activity.finish();
                  } catch (Throwable e) {
                    Logs.log(Log.ERROR, e, "Failed to stop activity");
                  }
                }
              }
            }
          });
        } catch (Throwable e) {
          Logs.log(Log.ERROR, e);
        }

        // We've done what we can. Clear activities if any are left.
        synchronized (activities) {
          activities.clear();
          runningActivity = null;
        }
      }

      @Override
      public void addError(Test arg0, Throwable arg1) {}

      @Override
      public void addFailure(Test arg0, AssertionFailedError arg1) {}

      @Override
      public void startTest(Test arg0) {}
    });

    ActivityUtils.setRunningActivitySupplier(new Supplier<Activity>() {
      @Override
      public Activity get() {
        return runningActivity;
      }
    });

    super.onStart();
  }

  // Overrides InstrumentationTestRunner
  List<Predicate<TestMethod>> getBuilderRequirements() {
    List<Predicate<TestMethod>> requirements = new ArrayList<Predicate<TestMethod>>();
    requirements.add(new Predicate<TestMethod>() {
      @Override
      public boolean apply(TestMethod arg0) {
        MinSdkVersion minSdkVersion = getAnnotation(arg0, MinSdkVersion.class);
        if (minSdkVersion != null && minSdkVersion.value() > Build.VERSION.SDK_INT) {
          Logs.logfmt(Log.INFO, "filtered %s#%s: MinSdkVersion=%d", arg0.getEnclosingClassname(),
              arg0.getName(), minSdkVersion.value());
          return false;
        }

        UseUiAutomation useUiAutomation = getAnnotation(arg0, UseUiAutomation.class);
        if (useUiAutomation != null && !DroidDrivers.hasUiAutomation()) {
          Logs.logfmt(Log.INFO,
              "filtered %s#%s: Has @UseUiAutomation, but ro.build.version.sdk=%d",
              arg0.getEnclosingClassname(), arg0.getName(), Build.VERSION.SDK_INT);
          return false;
        }
        return true;
      }

      private <T extends Annotation> T getAnnotation(TestMethod testMethod, Class<T> clazz) {
        T annotation = testMethod.getAnnotation(clazz);
        if (annotation == null) {
          annotation = testMethod.getEnclosingClass().getAnnotation(clazz);
        }
        return annotation;
      }
    });
    return requirements;
  }

  @Override
  public void callActivityOnDestroy(Activity activity) {
    super.callActivityOnDestroy(activity);
    synchronized (activities) {
      activities.remove(activity);
    }
  }

  @Override
  public void callActivityOnCreate(Activity activity, Bundle bundle) {
    super.callActivityOnCreate(activity, bundle);
    synchronized (activities) {
      activities.add(activity);
    }
  }

  @Override
  public void callActivityOnResume(Activity activity) {
    super.callActivityOnResume(activity);
    runningActivity = activity;
  }

  @Override
  public void callActivityOnPause(Activity activity) {
    super.callActivityOnPause(activity);
    if (activity == runningActivity) {
      runningActivity = null;
    }
  }
}