快速搞定 uiautomator2 自动化测试工具使用

霍格沃兹测试学院是 python-uiautomator2 金牌赞助商，跟着开源项目作者学测试开发实战，文末加群。

一、背景简介

Google 官方提供了一个 Android 自动化测试工具（Java 库），基于 Accessibility 服务，功能很强，可以对第三方 App 进行测试，获取屏幕上任意一个 App 的任意一个控件属性，并对其进行任意操作，但有两个缺点：

1. 测试脚本只能使用 Java 语言；
2. 测试脚本要打包成 jar 或者 apk 包上传到设备上才能运行；

实际工作中，我们希望测试逻辑能够用 Python 编写，能够在电脑上运行的时候就控制手机。所以基于这个目的开发了 python-uiautomator2 自动化测试开源工具，其封装了谷歌自带的 uiautomator2 测试框架，可以运行在支持 Python 的任一系统上，目前版本为 V2.10.2。

GitHub 开源地址：

https://github.com/openatx/uiautomator2

二、工作原理

如图所示，python-uiautomator2 主要分为两个部分，python 客户端，移动设备

• python 端: 运行脚本，并向移动设备发送 HTTP 请求；
• 移动设备：移动设备上运行了封装了 uiautomator2 的 HTTP 服务，解析收到的请求，并转化成 uiautomator2 的代码；

整个过程：

1. 在移动设备上安装 atx-agent (守护进程)，随后 atx-agent 启动 uiautomator2 服务(默认 7912 端口)进行监听；
2. 在 PC 上编写测试脚本并执行（相当于发送 HTTP 请求到移动设备的 server 端）；
3. 移动设备通过 WIFI 或 USB 接收到 PC 上发来的 HTTP 请求，执行制定的操作；

三、安装与启动

3.1 安装 uiautomator2

使用 pip 安装

pip install -U uiautomator2

安装完成后，使用如下 python 代码查看环境是事配置成功

说明：后文中所有代码都需要导入 uiautomator2 库，为了简化我使用 u2 代替，d 代表 driver

import uiautomator2 as u2
# 连接并启动
d = u2.connect() 
print(d.info)

能正确打印出设备的信息则表示安装成功

注意：需要安装 adb 工具，并配置到系统环境变量，才能操作手机。

安装有问题可以到 issue 列表查询： https://github.com/openatx/uiautomator2/wiki/Common-issues

3.2 安装 weditor

weditor 是一款基于浏览器的 UI 查看器，用来帮助我们查看 UI 元素定位。

因为 uiautomator 是独占资源，所以当 atx 运行的时候 uiautomatorviewer 是不能用的，为了减少 atx 频繁的启停，就需要用到此工具

使用 pip 安装

pip install -U weditor

查看安装是否成功

weditor --help

出现如下信息表示安装成功

运行 weditor

python -m weditor
#或者直接在命令行运行
weditor

四、元素定位

4.1 使用方法

d(定位方式 = 定位值)
element = d(text='Phone')
#这里返回的是一个列表，当没找到元素时，不会报错，只会返回一个长度为 0 的列表
#当找到多个元素时，会返回多个元素的列表，需要加下标再定位
element[0].click()
#获取元素个数
print(element.count)

4.2 支持的定位方式

ui2 支持 android 中 UiSelector 类中的所有定位方式，详细可以在这个网址查看 https://developer.android.com/reference/android/support/test/uiautomator/UiSelector

整体内容如下 , 所有的属性可以通过 weditor 查看到

4.3 子元素和兄弟定位

子元素定位

child()

#查找类名为 android.widget.ListView 下的 Bluetooth 元素
d(className="android.widget.ListView").child(text="Bluetooth")
# 下面这两种方式定位有点不准确，不建议使用
d(className="android.widget.ListView")\
.child_by_text("Bluetooth",allow_scroll_search=True)
d(className="android.widget.ListView").child_by_description("Bluetooth")

兄弟元素定位

sibling()

#查找与 google 同一级别，类名为 android.widget.ImageView 的元素
d(text="Google").sibling(className="android.widget.ImageView")

链式调用

d(className="android.widget.ListView", resourceId="android:id/list") \
  .child_by_text("Wi‑Fi", className="android.widget.LinearLayout") \
  .child(className="android.widget.Switch") \
  .click()

4.4 相对定位

相对定位支持在 left , right , top , bottom , 即在某个元素的前后左右

d(A).left(B),# 选择 A 左边的 B
d(A).right(B),# 选择 A 右边的 B
d(A).up(B), #选择 A 上边的 B
d(A).down(B),# 选择 A 下边的 B
#选择 WIFI 右边的开关按钮
d(text='Wi‑Fi').right(resourceId='android:id/widget_frame')

4.5 元素常用 API

表格标注有 @property 装饰的类属性方法，均为下方示例方式

d(test="Settings").exists

exists 其它使用方法：

d.exists(text='Wi‑Fi',timeout=5)

info() 输出信息：

{
  "bounds": {
    "bottom": 407,
    "left": 216,
    "right": 323,
    "top": 342
  "childCount": 0,
  "className": "android.widget.TextView",
  "contentDescription": null,
  "packageName": "com.android.settings",
  "resourceName": "android:id/title",
  "text": "Wi‑Fi",
  "visibleBounds": {
    "bottom": 407,
    "left": 216,
    "right": 323,
    "top": 342
  "checkable": false,
  "checked": false,
  "clickable": false,
  "enabled": true,
  "focusable": false,
  "focused": false,
  "longClickable": false,
  "scrollable": false,
  "selected": false
}

可以通过上方信息分别获取元素的所有属性

4.6 XPATH 定位

因为 Java uiautoamtor 中默认是不支持 xpath，这是属于 ui2 的扩展功能，速度会相比其它定位方式慢一些

在 xpath 定位中，ui2 中的 description 定位需要替换为 content-desc，resourceId 需要替换为 resource-id

使用方法

# 只会返回一个元素，如果找不到元素，则会报 XPathElementNotFoundError 错误
# 如果找到多个元素，默认会返回第 0 个
d.xpath('//*[@resource-id="com.android.launcher3:id/icon"]')
# 如果返回的元素有多个，需要使用 all() 方法返回列表
# 使用 all 方法，当未找到元素时，不会报错，会返回一个空列表
d.xpath('//*[@resource-id="com.android.launcher3:id/icon"]').all()

五、设备交互

5.1 单击

d(text='Settings').click()
#单击直到元素消失 , 超时时间 10，点击间隔 1
d(text='Settings').click_gone(maxretry=10, interval=1.0)

5.2 长按

d(text='Settings').long_click()

5.3 拖动

Android<4.3 时不能使用拖动

# 在 0.25S 内将 Setting 拖动至 Clock 上，拖动元素的中心位置
# duration 默认为 0.5, 实际拖动的时间会比设置的要高
d(text="Settings").drag_to(text="Clock", duration=0.25)
# 拖动 settings 到屏幕的某个点上
d(text="Settings").drag_to(877,733, duration=0.25)
#两个点之间的拖动 , 从点 1 拖动至点 2
d.drag(x1,y1,x2,y2)

5.4 滑动

滑动有两个，一个是在 driver 上操作，一个是在元素上操作

元素上操作

从元素的中心向元素边缘滑动

# 在 Setings 上向上滑动。steps 默认为 10
# 1 步约为 5 毫秒，因此 20 步约为 0.1 s
d(text="Settings").swipe("up", steps=20) 

driver 上操作

即对整个屏幕操作

# 实现下滑操作
x,y = d.window_size()
x1 = x / 2
y1 = y * 0.1
y2 = y * 0.9
d.swipe(x1,y1,x1,y2)

driver 滑动的扩展方法，可以直接实现滑动，不需要再自己封装定位点

# 支持前后左右的滑动
# "left", "right", "up", "down"
# 下滑操作
d.swipe_ext("down")

5.5 双指操作

android>4.3

对元素操作