跨平台iOS自动化测试工具——tidevice

发表于 2021-04-20 分类于自动化测试

前言

一直以来，iOS自动化的实现&执行都依赖 Mac 系统，其主要原因是因为需要通过 Xcodebuild 编译&安装 WDA (WebDriverAgent) 到 iOS 设备中，通过WDA实现对被测应用进行操作。而Windows系统无法运行Xcode工具，所以无法运行iOS自动化测试。

tidevice 简介

针对这种情况，阿里团队开源了一个内部使用的 iOS自动化工具：
tidevice （https://github.com/alibaba/taobao-iphone-device）让我们可以更方便、简单的脱离Mac的限制。

功能

该工具能够用于与iOS设备进行通信, 提供以下功能

截图
获取手机信息
ipa包的安装和卸载
根据bundleID 启动和停止应用
列出安装应用信息
模拟Xcode运行XCTest，常用的如启动WebDriverAgent测试（此方法不依赖xcodebuild)
获取指定应用性能(CPU,MEM,FPS)
其他
支持运行在Mac，Linux，Windows上

tidevice核心原理

usbmux通信协议：实现 Mac/Windows/Linux 与 iOS设备服务间的通信

Mac端：usbmuxd 是苹果的一个服务，这个服务主要用于在USB协议上实现多路TCP连接，将USB通信抽象为TCP通信。苹果的iTunes、Xcode，都直接或间接地用到了这个服务。

Linux / Windows端：本身是没有 usbmux的，不过都有开源项目的实现，可以直接使用参考
Windows 另外依赖 AppleApplicationSupport和AppleMobileDeviceSupport 两个服务，安装Itunes 环境即可安装对应服务。

usbmux 本身是socket 套接字，通过截获、破解等手段，结合开源界的成果，用python 进行模拟，从而实现了当前工具已有的所有功能

tidevice安装

Python 3.6+

tidevice 安装

1 2	pip3 install -U "tidevice[openssl]" （推荐） pip3 install -U tidevice （缺少设备配对功能）

usbmuxd 安装

Mac 自带：/var/run/usbmux
Linux/Windows: 参考官方建议的 https://github.com/alibaba/taobao-iphone-device/issues/7

tidevice 使用

查看版本号

1 2	$ tidevice version 0.1.0

列出连接设备

$ tidevice list
List of apple devices attached
00008030-001A35E40212345678 codeskyblue的iPhoneSE

$ tidevice list --json
[
    {
        "udid": "00008030-001A35E40212345678",
        "name": "codeskyblue的iPhoneSE"
    }
]

应用管理

# 安装应用
$ tidevice install example.ipa

# 指定设备安装
$ tidevice --udid $UDID install https://example.org/example.ipa

# 卸载应用
$ tidevice uninstall com.example.demo

# 启动应用
$ tidevice launch com.example.demo

# 停止应用
$ tidevice kill com.example.demo

# 查看已安装应用
$ tidevice applist
Run XCTest
请先确保手机上已经安装有WebDriverAgent应用

设备管理

# 重启
$ tidevice reboot

# 截图
$ tidevice screenshot screenshot.jpg

# 性能采集 (TODO)
# $ tidevice perf -o fps,mem,cpu -B com.example.demo

# 输出日志 same as idevicesyslog
$ tidevice syslog

运行WDA

运行WAD(WebDriverAgent)之前首先需要将iOS设备安装好WAD应用，具体可以参考 Appium+Mac环境搭建安装好之后使用命令查看WDA名称：

atx:~ atx$ tidevice applist
com.fish.stream Stream 1.0.6
com.tencent.mqqsecure 腾讯手机管家 8.9.5
com.sina.weibo 微博 11.4.0
com.dji.mimo DJI Mimo 1.5.16
com.tencent.QQMusic QQ音乐 10.11.1
com.facebookWebDriverAgentRunner.xctrunner WebDriverAgentRunner-Runner 1.0

打开命令窗口输入如下命令，注意修改端口号为8200，避免与WDA默认端口8100冲突。

atx:~ atx$ tidevice wdaproxy -B com.facebookWebDriverAgentRunner.xctrunner --port 8200
[D 210417 10:04:52 _wdaproxy:116] [6dd5e55bf4204cd5ad8042dc4exxxxxxxxx] launch WDA
[I 210417 10:04:53 _device:990] BundleID: com.facebookWebDriverAgentRunner.xctrunner
[I 210417 10:04:53 _device:992] DeviceIdentifier: 6dd5e55bf4204cd5ad8042dxxxxxxx
[I 210417 10:04:53 _device:834] SignIdentity: 'Apple Development: 技术部门 xx (WKQZHDVG49)'
[I 210417 10:04:53 _device:840] CFBundleExecutable: WebDriverAgentRunner-Runner
[I 210417 10:04:53 _device:871] AppContainer: /private/var/mobile/Containers/Data/Application/A2492414-BF14-4E2F-9130-5C50AB8E503E
[I 210417 10:04:54 _device:911] Launch 'com.facebookWebDriverAgentRunner.xctrunner' pid: 838
[I 210417 10:04:54 _device:1086] ProductVersion: 12.1.2
[I 210417 10:04:55 _device:1034] Start execute test plan with IDE version: 29
[I 210417 10:04:56 _device:947] WebDriverAgent start successfully

运行完成后在打开浏览器输入地址: http://127.0.0.1:8200/status查看返回内容，正常返回如下内容：

{
  "value" : {
    "message" : "WebDriverAgent is ready to accept commands",
    "state" : "success",
    "os" : {
      "testmanagerdVersion" : 26,
      "name" : "iOS",
      "sdkVersion" : "13.0",
      "version" : "12.1.2"
    },
    "ios" : {
      "ip" : "172.28.xxx.xxx"
    },
    "ready" : true,
    "build" : {
      "time" : "Apr 11 2021 10:54:49",
      "productBundleIdentifier" : "com.facebook.WebDriverAgentRunner"
    }
  },
  "sessionId" : null
}

注意：目前已知的两个问题

不支持运行企业证书签名的WDA

未认证的数据线可能导致WDA连接中断，建议使用原装苹果数据线。

运行WDA后启动Appium服务即可开始执行iOS自动化测试。

Win环境运行注意事项

Win环境运行注意需要配置相关参数配置,另外需要安装好iTunes具体如下：

automationName：执行引擎,iOS设备需要设置为XCUITest
webDriverAgentUrl：iOS运行脚本中，需要配置 webDriverAgentUrl 给 appium driver ，才会不触发 appium 内置的用 xcode 启动 wda 这个流程。否则只要触发这个，appium 就会找 xcode 。windows 没有 xcode ，自然跑不下去从而出现报错Error: The usbmuxd socket at '/var/run/usbmuxd' does not exist or is not accessible
usePrebuiltWDA:使用已经编译好的WDA这里填true
useXctestrunFile:使用Xctestrun文件启动WDA。由于此功能期望您已经构建了WDA项目，因此它既不会检查您是否具有必要的依赖关系来构建，WDA也不会尝试构建项目。默认为false。
skipLogCapture:跳过以开始捕获日志，默认为false。

{
  "udid": "6dd5e55bf4204cd5ad8042dc4ecb2xxxxxx",
 "automationName": "XCUITest",
  "deviceName": "iphone8",
  "platformName": "iOS",
  "platforVersion": "12.1.2",
  "bundleId": "com.hxxxxx",
  "webDriverAgentUrl": "http://localhost:8200",
 "usePrebuiltWDA": "true",
  "useXctestrunFile": "false",
"skipLogCapture": "true",
"automationName": "XCUITest"
}

前言