aboutsummaryrefslogtreecommitdiff
path: root/src/io/appium/droiddriver/uiautomation/UiAutomationDriver.java
blob: 2e5d799481c923456593014bc9377bb371921c54 (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
/*
 * 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.uiautomation;

import android.annotation.TargetApi;
import android.app.Instrumentation;
import android.app.UiAutomation;
import android.content.Context;
import android.os.SystemClock;
import android.view.accessibility.AccessibilityEvent;
import android.view.accessibility.AccessibilityManager;
import android.view.accessibility.AccessibilityNodeInfo;

import io.appium.droiddriver.actions.InputInjector;
import io.appium.droiddriver.base.BaseDroidDriver;
import io.appium.droiddriver.exceptions.TimeoutException;
import io.appium.droiddriver.uiautomation.UiAutomationContext.UiAutomationCallable;
import io.appium.droiddriver.util.Logs;

/**
 * Implementation of DroidDriver that gets attributes via the Accessibility API
 * and is acted upon via synthesized events.
 */
@TargetApi(18)
public class UiAutomationDriver extends BaseDroidDriver<AccessibilityNodeInfo, UiAutomationElement> {
  // TODO: magic const from UiAutomator, but may not be useful
  /**
   * This value has the greatest bearing on the appearance of test execution
   * speeds. This value is used as the minimum time to wait before considering
   * the UI idle after each action.
   */
  private static final long QUIET_TIME_TO_BE_CONSIDERD_IDLE_STATE = 500;// ms

  private final UiAutomationContext context;
  private final InputInjector injector;
  private final UiAutomationUiDevice uiDevice;
  private AccessibilityNodeInfoCacheClearer clearer =
      new WindowStateAccessibilityNodeInfoCacheClearer();

  public UiAutomationDriver(Instrumentation instrumentation) {
    context = new UiAutomationContext(instrumentation, this);
    injector = new UiAutomationInputInjector(context);
    uiDevice = new UiAutomationUiDevice(context);
  }

  @Override
  public InputInjector getInjector() {
    return injector;
  }

  @Override
  protected UiAutomationElement newRootElement() {
    return context.newRootElement(getRootNode());
  }

  @Override
  protected UiAutomationElement newUiElement(AccessibilityNodeInfo rawElement,
      UiAutomationElement parent) {
    return new UiAutomationElement(context, rawElement, parent);
  }

  private AccessibilityNodeInfo getRootNode() {
    final long timeoutMillis = getPoller().getTimeoutMillis();
    context.callUiAutomation(new UiAutomationCallable<Void>() {
      @Override
      public Void call(UiAutomation uiAutomation) {
        try {
          uiAutomation.waitForIdle(QUIET_TIME_TO_BE_CONSIDERD_IDLE_STATE, timeoutMillis);
          return null;
        } catch (java.util.concurrent.TimeoutException e) {
          throw new TimeoutException(e);
        }
      }
    });

    long end = SystemClock.uptimeMillis() + timeoutMillis;
    while (true) {
      AccessibilityNodeInfo root =
          context.callUiAutomation(new UiAutomationCallable<AccessibilityNodeInfo>() {
            @Override
            public AccessibilityNodeInfo call(UiAutomation uiAutomation) {
              return uiAutomation.getRootInActiveWindow();
            }
          });
      if (root != null) {
        return root;
      }
      long remainingMillis = end - SystemClock.uptimeMillis();
      if (remainingMillis < 0) {
        throw new TimeoutException(
            String.format("Timed out after %d milliseconds waiting for root AccessibilityNodeInfo",
                timeoutMillis));
      }
      SystemClock.sleep(Math.min(250, remainingMillis));
    }
  }

  /**
   * Some widgets fail to trigger some AccessibilityEvent's after actions,
   * resulting in stale AccessibilityNodeInfo's. As a work-around, force to
   * clear the AccessibilityNodeInfoCache.
   */
  public void clearAccessibilityNodeInfoCache() {
    Logs.call(this, "clearAccessibilityNodeInfoCache");
    clearer.clearAccessibilityNodeInfoCache(this);
  }

  public interface AccessibilityNodeInfoCacheClearer {
    void clearAccessibilityNodeInfoCache(UiAutomationDriver driver);
  }

  /**
   * Clears AccessibilityNodeInfoCache by turning screen off then on.
   */
  public static class ScreenOffAccessibilityNodeInfoCacheClearer implements
      AccessibilityNodeInfoCacheClearer {
    public void clearAccessibilityNodeInfoCache(UiAutomationDriver driver) {
      driver.getUiDevice().sleep();
      driver.getUiDevice().wakeUp();
    }
  }

  /**
   * Clears AccessibilityNodeInfoCache by exploiting an implementation detail of
   * AccessibilityNodeInfoCache. This is a hack; use it at your own discretion.
   */
  public static class WindowStateAccessibilityNodeInfoCacheClearer implements
      AccessibilityNodeInfoCacheClearer {
    public void clearAccessibilityNodeInfoCache(UiAutomationDriver driver) {
      AccessibilityManager accessibilityManager =
          (AccessibilityManager) driver.context.getInstrumentation().getTargetContext()
              .getSystemService(Context.ACCESSIBILITY_SERVICE);
      accessibilityManager.sendAccessibilityEvent(AccessibilityEvent
          .obtain(AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED));
    }
  }

  public void setAccessibilityNodeInfoCacheClearer(AccessibilityNodeInfoCacheClearer clearer) {
    this.clearer = clearer;
  }

  @Override
  public UiAutomationUiDevice getUiDevice() {
    return uiDevice;
  }
}