Google 官方提供了一个 Android 自动化测试工具(Java 库),基于 Accessibility 服务,功能很强,可以对第三方 App 进行测试,获取屏幕上任意一个 App 的任意一个控件属性,并对其进行任意操作,但有两个缺点:
测试脚本只能使用 Java 语言;
测试脚本要打包成 jar 或者 apk 包上传到设备上才能运行;
实际工作中,我们希望测试逻辑能够用 Python 编写,能够在电脑上运行的时候就控制手机。所以基于这个目的开发了 python-uiautomator2 自动化测试开源工具,其封装了谷歌自带的 uiautomator2 测试框架,可以运行在支持 Python 的任一系统上,目前版本为 V2.10.2。
GitHub 开源地址:
https://github.com/openatx/uiautomator2
如图所示,python-uiautomator2 主要分为两个部分,python 客户端,移动设备
python 端: 运行脚本,并向移动设备发送 HTTP 请求;
移动设备:移动设备上运行了封装了 uiautomator2 的 HTTP 服务,解析收到的请求,并转化成 uiautomator2 的代码;
整个过程:
在移动设备上安装 atx-agent(守护进程),随后 atx-agent 启动 uiautomator2 服务(默认 7912 端口)进行监听;
在 PC 上编写测试脚本并执行(相当于发送 HTTP 请求到移动设备的 server 端);
移动设备通过 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 安装
1
pip install -U weditor
查看安装是否成功
1
weditor --help
出现如下信息表示安装成功
运行 weditor
1
python -m weditor#或者直接在命令行运行weditor
4.1 使用方法
1
d(定位方式 = 定位值)#例:element = d(text=‘Phone’)#这里返回的是一个列表,当没找到元素时,不会报错,只会返回一个长度为 0 的列表#当找到多个元素时,会返回多个元素的列表,需要加下标再定位element[0].click()#获取元素个数print(element.count)
4.2 支持的定位方式
ui2 支持 android 中 UiSelector 类中的所有定位方式,详细可以在这个网址查看 developer.android.com/reference/a…
整体内容如下 , 所有的属性可以通过 weditor 查看到
名称描述
texttext 是指定文本的元素textContainstext 中包含有指定文本的元素textMatchestext 符合指定正则的元素textStartsWithtext 以指定文本开头的元素classNameclassName 是指定类名的元素classNameMatchesclassName 类名符合指定正则的元素descriptiondescription 是指定文本的元素descriptionContainsdescription 中包含有指定文本的元素descriptionMatchesdescription 符合指定正则的元素descriptionStartsWithdescription 以指定文本开头的元素checkable可检查的元素,参数为 True,Falsechecked已选中的元素,通常用于复选框,参数为 True,Falseclickable可点击的元素,参数为 True,FalselongClickable可长按的元素,参数为 True,Falsescrollable可滚动的元素,参数为 True,Falseenabled已激活的元素,参数为 True,Falsefocusable可聚焦的元素,参数为 True,Falsefocused获得了焦点的元素,参数为 True,Falseselected当前选中的元素,参数为 True,FalsepackageNamepackageName 为指定包名的元素packageNameMatchespackageName 为符合正则的元素resourceIdresourceId 为指定内容的元素resourceIdMatchesresourceId 为符合指定正则的元素
4.3 子元素和兄弟定位
子元素定位
child()
1
#查找类名为 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()
1
#查找与 google 同一级别,类名为 android.widget.ImageView 的元素d(text=“Google”).sibling(className=“android.widget.ImageView”)
链式调用
1
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, 即在某个元素的前后左右
1
d(A).left(B),# 选择 A 左边的 Bd(A).right(B),# 选择 A 右边的 Bd(A).up(B), #选择 A 上边的 Bd(A).down(B),# 选择 A 下边的 B#选择 WIFI 右边的开关按钮d(text=‘Wi‑Fi’).right(resourceId=‘android:id/widget_frame’)
4.5 元素常用 API
表格标注有 @property 装饰的类属性方法,均为下方示例方式
1
d(test=“Settings”).exists
方法
描述返回值备注
exists()判断元素是否存在True,Flase@propertyinfo()返回元素的所有信息字典@propertyget_text()返回元素文本字符串
set_text(text)设置元素文本None
clear_text()清空元素文本None
center()返回元素的中心点位置(x,y)基于整个屏幕的点
exists 其它使用方法:
1
d.exists(text=‘Wi‑Fi’,timeout=5)
info() 输出信息:
1
{ “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
使用方法
1
5.1 单击
1
d(text=‘Settings’).click()#单击直到元素消失 , 超时时间 10,点击间隔 1d(text=‘Settings’).click_gone(maxretry=10, interval=1.0)
5.2 长按
1
d(text=‘Settings’).long_click()
5.3 拖动
Android<4.3 时不能使用拖动
1
5.4 滑动
滑动有两个,一个是在 driver 上操作,一个是在元素上操作
元素上操作
从元素的中心向元素边缘滑动
1
driver 上操作
即对整个屏幕操作
1
driver 滑动的扩展方法,可以直接实现滑动,不需要再自己封装定位点
1
5.5 双指操作
android>4.3
对元素操作
1
d(text=‘Settings’).gesture(start1,start2,end1,end2,)# 放大操作d(text=‘Settings’).gesture((525,960),(613,1121),(135,622),(882,1540))
封装好的放大缩小操作
1
5.6 等待元素出现或者消失
1
5.7 滚动界面
设置 scrollable 属性为 True;
滚动类型:horiz 为水平,vert 为垂直;
滚动方向:
forward 向前
backward 向后
toBeginning 滚动至开始
toEnd 滚动至最后
to 滚动直接某个元素出现
所有方法均返回 Bool 值;
1
2
3
Take screenshot of widgetim = d(text=“Settings”).screenshot()im.save(“settings.jpg”)
5.8 输入
5.8.1 输入自定义文本
1
5.8.2 输入按键
两种方法
1
目前 press 支持的按键如下
1
“”" press key via name or key code. Supported key name includes: home, back, left, right, up, down, center, menu, search, enter, delete(or del), recent(recent apps), volume_up, volume_down, volume_mute, camera, power. “”"
keyevent 是通过 “adb shell input keyevent” 方式输入,支持按键更加丰富
更多详细的按键信息 developer.android.com/reference/a…
5.8.3 输入法切换
1
5.8.4 模拟输入法功能
可以模拟的功能有 go ,search ,send ,next, done ,previous。
如果使用 press 输入按键无效,可以尝试使用此方法输入
1
5.9 toast 操作
1
5.10 监控界面
使用 wather 进行界面的监控,可以用来实现跳过测试过程中的弹框
当启动 wather 时,会新建一个线程进行监控
可以添加多个 watcher
用法
1
2.11.0 版本新增了一个 watch_context 方法 , 写法相比 watcher 更简洁,官方推荐使用此方法来实现监控,目前只支持 click() 这一种方法。
1
wct = d.watch_context()# 监控 ALLOWwct.when(“ALLOW”).click()# 监控 OKwct.when(‘OK’).click() # 开启弹窗监控,并等待界面稳定(两个弹窗检查周期内没有弹窗代表稳定)wct.wait_stable()#其它实现代码# 停止监控wct.stop()
5.11 多点滑动
这里可以用来实现图案解锁
使用 touch 类
1
6.1 截图
1
d.screenshot(‘test.png’)
6.2 录制视频
这个感觉是比较有用的一个功能,可以在测试用例开始时录制,结束时停止录制,然后如果测试 fail。则上传到测试报告,完美复原操作现场,具体原理后面再去研究。
首先需要下载依赖,官方推荐使用镜像下载:
1
pip3 install -U “uiautomator2[image]” -i https://pypi.doubanio.com/simple
执行录制:
1
6.3 图片识别点击
下载与录制视频同一套依赖。
这个功能是首先手动截取需要点击目标的图片,然后 ui2 在界面中去匹配这个图片,目前我尝试了精确试不是很高,误点率非常高,不建议使用。
1
7.1 获取当前界面的 APP 信息
1
d.app_current()#返回当前界面的包名,activity 及 pid{ “package”: “com.xueqiu.android”, “activity”: “.common.MainActivity”, “pid”: 23007}
7.2 安装应用
可以从本地路径及 url 下载安装 APP,此方法无返回值,当安装失败时,会抛出 RuntimeError 异常
1
7.3 运行应用
默认当应用在运行状态执行 start 时不会关闭应用,而是继续保持当前界面。
如果需要消除前面的启动状态,则需要加 stop=True 参数。
1
7.4 停止应用
stop 和 clear 的区别是结束应用使用的命令不同
stop 使用的是 “am force-stop”
clear 使用的是 “pm clear”
1
7.5 获取应用信息
1
d.app_info(‘com.xueqiu.android’)#输出{ “packageName”: “com.xueqiu.android”, “mainActivity”: “com.xueqiu.android.common.splash.SplashActivity”, “label”: " 雪球 ", “versionName”: “12.6.1”, “versionCode”: 257, “size”: 72597243}
7.6 获取应用图标
1
img = d.app_icon(‘com.xueqiu.android’)img.save(‘icon.png’)
7.7 等待应用启动
1
7.8 卸载应用
1
卸载全部应用返回的包名列表并一定是卸载成功了,最好使用 verbose=true 打印一下信息,这样可以查看到是否卸载成功
1
uninstalling com.xueqiu.android OKuninstalling com.android.cts.verifier FAIL
或者可以修改一下源码,使其只输出成功的包名,注释的为增加的代码,未注释的是源码
1
def app_uninstall_all(self, excludes=[], verbose=False): “”" Uninstall all apps “”" our_apps = [‘com.github.uiautomator’, ‘com.github.uiautomator.test’] output, _ = self.shell([‘pm’, ‘list’, ‘packages’, ‘-3’]) pkgs = re.findall(r’package:([^\s]+)’, output) pkgs = set(pkgs).difference(our_apps + excludes) pkgs = list(pkgs) # 增加一个卸载成功的列表 #sucess_list = [] for pkg_name in pkgs: if verbose: print(“uninstalling”, pkg_name, " “, end=”", flush=True) ok = self.app_uninstall(pkg_name) if verbose: print(“OK” if ok else “FAIL”) # 增加如下语句,当成功则将包名加入 list #if ok: # sucess_list.append(pkg_name) # 返回成功的列表 # return sucess_list return pkgs
8.1 连接设备
1
#当 PC 只连接了一个设备时,可以使用此种方式d = u2.connect()#返回的是 Device 类 , 此类继承方式如下class Device(_Device, _AppMixIn, _PluginMixIn, _InputMethodMixIn, _DeprecatedMixIn): “”" Device object “”"# for compatible with old codeSession = Device
connect() 可以使用如下其它方式进行连接
1
#当 PC 与设备在同一网段时,可以使用 IP 地址和端口号通过 WIFI 连接,无需连接 USB 线connect(“10.0.0.1:7912”)connect(“10.0.0.1”) # use default 7912 portconnect(“http://10.0.0.1”)connect(“http://10.0.0.1:7912”)#多个设备时,使用设备号指定哪一个设备connect(“cff1123ea”) # adb device serial number
8.2 获取设备及 driver 信息
8.2.1 获取 driver 信息
1
d.info#输出{ “currentPackageName”: “com.android.systemui”, “displayHeight”: 2097, “displayRotation”: 0, “displaySizeDpX”: 360, “displaySizeDpY”: 780, “displayWidth”: 1080, “productName”: “freedom_turbo_XL”, “screenOn”: true, “sdkInt”: 29, “naturalOrientation”: true}
8.2.2 获取设备信息
会输出测试设备的所有信息,包括电池,CPU,内存等
1
d.device_info#输出{ “udid”: “61c90e6a-ba:1b:ba:46:91:0e-freedom_turbo_XL”, “version”: “10”, “serial”: “61c90e6a”, “brand”: “Schok”, “model”: “freedom turbo XL”, “hwaddr”: “ba:1b:ba:46:91:0e”, “port”: 7912, “sdk”: 29, “agentVersion”: “0.9.4”, “display”: { “width”: 1080, “height”: 2340 }, “battery”: { “acPowered”: false, “usbPowered”: true, “wirelessPowered”: false, “status”: 2, “health”: 2, “present”: true, “level”: 98, “scale”: 100, “voltage”: 4400, “temperature”: 292, “technology”: “Li-ion” }, “memory”: { “total”: 5795832, “around”: “6 GB” }, “cpu”: { “cores”: 8, “hardware”: “Qualcomm Technologies, Inc SDM665” }, “arch”: “”, “owner”: null, “presenceChangedAt”: “0001-01-01T00:00:00Z”, “usingBeganAt”: “0001-01-01T00:00:00Z”, “product”: null, “provider”: null}
8.2.3 获取屏幕分辨率
1
8.2.4 获取 IP 地址
1
8.2.4 获取 IP 地址
1
8.3 driver 全局设置
8.3.1 使用 settings 设置
查看 settings 默认设置
1
d.settings#输出{ #点击后的延迟,(0,3)表示元素点击前等待 0 秒,点击后等待 3S 再执行后续操作 ‘operation_delay’: (0, 3), # opretion_delay 生效的方法,默认为 click 和 swipe # 可以增加 press,send_keys,long_click 等方式 ‘operation_delay_methods’: [‘click’, ‘swipe’], # 默认等待时间,相当于 appium 的隐式等待 ‘wait_timeout’: 20.0, # xpath 日志 ‘xpath_debug’: False}
修改默认设置,只需要修改 settings 字典即可
1
#修改延迟为操作前延迟 2S 操作后延迟 4.5Sd.settings[‘operation_delay’] = (2,4.5)#修改延迟生效方法d.settings[‘operation_delay_methods’] = {‘click’,‘press’,‘send_keys’}# 修改默认等待d.settings[‘wait_timeout’] = 10
8.3.2 使用方法或者属性设置
http 默认请求超时时间
默认值 60s, d.HTTP_TIMEOUT = 60
当设备掉线时,等待设备在线时长
仅当 TMQ=true 时有效,支持通过环境变量 WAIT_FOR_DEVICE_TIMEOUT 设置d.WAIT_FOR_DEVICE_TIMEOUT = 70
元素查找默认等待时间
打不到元素时,等待 10 后再报异常d.implicitly_wait(10.0)
打开 HTTP debug 信息
d.debug = Trued.info#输出15:52:04.736 $ curl -X POST -d ‘{“jsonrpc”: “2.0”, “id”: “0eed6e063989e5844feba578399e6ff8”, “method”: “deviceInfo”, “params”: {}}’ 'http://localhost:51046/jsonrpc/0’15:52:04.816 Response (79 ms) >>>{“jsonrpc”:“2.0”,“id”:“0eed6e063989e5844feba578399e6ff8”,“result”:{“currentPackageName”:“com.android.systemui”,“displayHeight”:2097,“displayRotation”:0,“displaySizeDpX”:360,“displaySizeDpY”:780,“displayWidth”:1080,“productName”:“freedom_turbo_XL”,“screenOn”:true,“sdkInt”:29,“naturalOrientation”:true}}<<< END
休眠
相当于 time.sleep(10)d.sleep(10)
8.4 亮灭屏
1
8.5 屏幕方向
1
value 值参考,只要是元组中的任一一个值就可以。
1
8.6 打开通知栏与快速设置
打开通知栏
1
d.open_notification()
打开快速设置
1
d.open_quick_settings()
8.7 文件导入导出
8.7.1 导入文件
1
8.7.2 导出文件
1
d.pull(’/sdcard/test.txt’,‘text.txt’)
8.8 执行 shell 命令
使用 shell 方法执行
8.8.1 执行非阻塞命令
output 返回的是一个整体的字符串,如果需要抽取值,需要对 output 进行解析提取处理
1
8.8.2 执行阻塞命令(持续执行的命令)
1
源码描述
1
def shell(self, cmdargs: Union[str, List[str]], stream=False, timeout=60): “”" Run adb shell command with arguments and return its output. Require atx-agent >=0.3.3 Args: cmdargs: str or list, example: “ls -l” or [“ls”, “-l”] timeout: seconds of command run, works on when stream is False stream: bool used for long running process. Returns: (output, exit_code) when stream is False requests.Response when stream is True, you have to close it after using Raises: RuntimeError For atx-agent is not support return exit code now. When command got something wrong, exit_code is always 1, otherwise exit_code is always 0 “”"
8.9 session(目前已经被弃用)
8.10 停止 UI2 服务
因为有 atx-agent 的存在,Uiautomator 会被一直守护着,如果退出了就会被重新启动起来。但是 Uiautomator 又是霸道的,一旦它在运行,手机上的辅助功能、电脑上的 uiautomatorviewer 就都不能用了,除非关掉该框架本身的 uiautomator
使用代码停止
1
d.service(“uiautomator”).stop()
手动停止
直接打开 ATX APP(init 成功后,就会安装上),点击关闭 UIAutomator
以上,欢迎大家一起交流探讨。
欢迎关注公众号:程序员一凡,领取一份300页pdf文档的Python自动化测试工程师核心知识点总结!软件测试技术交流群:(1079636098) 这些资料的内容都是面试时面试官必问的知识点,篇章包括了很多知识点,其中包括了有基础知识、Linux必备、Shell、互联网程序原理、Mysql数据库、抓包工具专题、接口测试工具、测试进阶-Python编程、Web自动化测试、APP自动化测试、接口自动化测试、测试高级持续集成、测试架构开发测试框架、性能测试、安全测试等。