APP自动化测试系列之Desired Capabilities详解

automationName

使用哪个自动化引擎

Android引擎：Appium（默认）、Selendroid、UiAutomator2或者Espresso。

iOS引擎：XCUITest。

platformName

使用哪个移动操作系统平台

iOS，Android或FirefoxOS

platformVersion

移动操作系统版本

例如：7.1，4.4

deviceName

使用的移动设备或模拟器的种类

iPhone Simulator，iPad Simulator，iPhone Retina 4-inch，Android Emulator，Galaxy S4等等。在iOS上，使用instruments -s devices命令获取。在Android上，这个功能目前被忽略，尽管它仍然是必需的。

app

.apk、.ipa或包含apk或ipa的.zip文件的本地绝对路径或远程http URL。Appium将尝试在适当的设备上安装这个应用程序的二进制文件。注意：如果Android指定了appPackage 和 appActivity参数，则该参数不是必须的。和browserName不兼容。

/abs/path/to/my.apk 或http://myapp.com/app.ipa

browserName

如果测试的是移动浏览器则使用。如果是App则为空。

适用于iOS的“Safari”，适用于Android的“Chrome”，“Chromium”或“Browser”

newCommandTimeout

在下一个命令执行之前的等待最大时长。单位为秒。

例如 60

language

（Sim / Emu-only）为模拟器/仿真器设置的语言。在Android端，只适用于API22及之前的版本。

例如 fr

locale

（Sim / Emu-only）为模拟器/仿真器设置的语言环境

例如 fr_CA

udid

连接的物理设备的唯一设备标识符

例如 1ae203187fc012g

orientation

（Sim / Emu-only）从某个特定方向开始

LANDSCAPE、PORTRAIT

autoWebview

直接进入Webview上下文。默认false

true、false

noReset

在开始会话之前不要重置应用程序状态。

true、false

fullReset

执行完整的重置操作。

true、false

eventTimings

Appium 提供了一个能力，可以获取关于启动信息和命令执行时间的计时信息。这是由 eventTimings 这个初始化参数控制的高级功能（把这个参数设置为 true 来记录事件的计时信息）。打开这个参数，GET /session/:id 这个接口的响应结果（也就是，driver.getSessionDetails() 的响应结果，或者类似的，取决于客户端实现）中会包含 events 属性。

例如：true

enablePerformanceLogging

（仅限Web和webview）启用Chromedriver（Android）或Safari（iOS）性能记录（默认false）

true、false

printPageSourceOnFindFailure

当一个操作失败时，打印当前页面的源代码信息。默认False。

true、false

appActivity

启动app包时需要的activity信息。可以使用adb命令获取。

MainActivity，.Settings

appPackage

你想运行的Android应用的Java程序包。通过adb命令获取。

com.example.android.myApp， com.android.settings

appWaitActivity

设置等待的activity页面。注意和appActivity属性的区别。

SplashActivity，SplashActivity,OtherActivity，*，*.SplashActivity

appWaitPackage

您想等待的Android应用程序的Java包。

com.example.android.myApp， com.android.settings

appWaitDuration

用于等待appWaitActivity启动的超时时间（以毫秒为单位）（默认20000）

30000

deviceReadyTimeout

设置等待一个模拟器或真机准备就绪的超时时间，单位秒。

5

androidCoverage

用于执行测试的 instrumentation 类。作为命令 adb shell am instrument -e coverage true -w 的 -w 参数。

com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation

androidCoverageEndIntent

将androidCoverage信息存储文件。作为命令adb shell am broadcast -a中的-a的参数。

com.example.pkg.END_EMMA

androidDeviceReadyTimeout

等待设备在启动应用后准备就绪的超时时间。以秒为单位。

例如：30

androidInstallTimeout

用于等待apk安装到设备的超时（以毫秒为单位）。默认为90000

例如：90000

androidInstallPath

安装前将apk存储在设备上的默认路径。默认为/data/local/tmp

例如：/sdcard/Downloads/

adbPort

用于连接到ADB服务器的端口（默认5037）

5037

systemPort

用来连接appium-uiautomator

8201

2-server的端口，默认8200。当多线程并行运行测试时要避免该端口冲突。

remoteAdbHost

可选的远程ADB服务器主机

例如：192.168.0.101

androidDeviceSocket

开发工具的 socket 名称。只有在被测应用是一个使用 Chromium 内核的浏览器时需要。 socket 会被浏览器打开，然后Chromedriver把它作为开发者工具来进行连接。

例如：chrome_devtools_remote

avd

需要启动的 AVD (安卓虚拟设备) 名称。

例如：api19

avdLaunchTimeout

以毫秒为单位，等待 AVD 启动并连接到 ADB 的超时时间。(默认值 120000)）

300000

avdReadyTimeout

以毫秒为单位，等待 AVD 完成启动动画的超时时间。(默认值 120000)

300000

avdArgs

启动 AVD 时需要加入的额外的参数。

例如：-netfast

useKeystore

使用一个自定义的 keystore 来对 apk 进行重签名。默认值 false

true、false

keystorePath

自定义 keystore 的路径。默认： ~/.android/debug.keystore

例如：/path/to.keystore

keystorePassword

自定义 keystore 的密码。

例如：foo

keyAlias

key的别名

例如：androiddebugkey

keyPassword

key的密钥

例如：foo

chromedriverExecutable

webdriver 可执行文件的绝对路径 (如果 Chromium 核心提供了对应的 webdriver， 应该用它代替 Appium 自带的 webdriver)

/abs/path/to/webdriver

autoWebviewTimeout

以毫秒为单位，等待 Webview 上下文激活的时间。默认值 2000

例如：4

intentAction

用于启动 activity 的 intent action。 (默认值 android.intent.action.MAIN)

例如：android.intent.action.MAIN，android.intent.action.VIEW

intentCategory

用于启动 activity 的 intent category。 (默认值 android.intent.category.LAUNCHER)

例如：android.intent.category.LAUNCHER，android.intent.category.APP_CONTACTS

intentFlags

用于启动 activity 的标识 ( flags ) (默认值 0x10200000)

例如：0x10200000

optionalIntentArguments

用于启动 activity 的额外 intent 参数。

例如：--esn <EXTRA_KEY>，--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE>等等。

dontStopAppOnReset

在使用 adb 启动应用前不会停止被测应用的进程 ( process ) 。如果被测应用是被另一个应用创建的，当这个参数被设定为true时，允许另一个应用的进程在使用 adb 启动被测应用时继续存活。换句话说，当dontStopAppOnReset设置true时，adb shell am start命令中不会有-S标志参数。否则需要带有-S。

true、false

unicodeKeyboard

使用Unicode输入法，默认 false

true、false

resetKeyboard

在使用了unicode输入法测试结束后，重置输入法到原有状态。如果单独使用，将会被忽略。默认值 false。

true、false

noSign

跳过检查和对应用进行 debug 签名的步骤。只能在使用 UiAutomator 时使用，使用 selendroid 是不行。默认值 false。

true、false

ignoreUnimportantViews

调用uiautomator的函数 setCompressedLayoutHierarchy()。由于 Accessibility 命令在忽略部分元素的情况下执行速度会加快，这个关键字能加快测试执行的速度。被忽略的元素将不能够被找到，因此这个关键字同时也被实现成可以随时改变的 *设置 ( settings ) * 。默认值 false

true、false

disableAndroidWatchers

关闭Android用于监听程序异常的监听器，这将减少设备的CPU使用率。这个功能只能用于UiAutomator，而不能用于selendroid，默认false

true、false

chromeOptions

用于给ChromeDriver传递 chromeOptions参数。

chromeOptions: {args: ['--disable-popup-blocking']}

recreateChromeDriverSessions

在移至非ChromeDriver网页浏览的情况下杀死ChromeDriver会话。默认为false

true、false

nativeWebScreenshot

在Web上下文中，使用本机（adb）方法截取屏幕截图，而不是ChromeDriver代理。默认为false

true、false

androidScreenshotPath

设备上用来存储截图的路径。默认为/data/local/tmp

例如:

/sdcard/screenshots/

autoGrantPermissions

让Appium自动确定您的应用程序需要哪些权限，并在安装时将其授予应用程序。默认为false

true、false

networkSpeed

设置模拟网络速度。指定最大的网络上传和下载速度。默认为full

['full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo']使用-netspeed option查看更多avds速度模拟信息

gpsEnabled

在开始会话之前，切换模拟器的gps位置。默认情况下，模拟器将根据设置的方式启用或不启用此选项。

true、false

isHeadless

当模拟器不需要在运行中显示页面时设置true。默认false。isHeadless也支持iOS，请检查XCUITest的具体功能。

例如：true

uiautomator2ServerLaunchTimeout

等待uiAutomator2服务启动的超时时间，单位毫秒。默认20000

例如：20000

uiautomator2ServerInstallTimeout

等待uiAutomator2服务安装的超时时间，单位毫秒。默认20000

例如：20000

otherApps

测试之前需要安装的app或app列表（类似json格式）

例如："/path/to/app.apk", https://www.example.com/url/to/app.apk, ["/path/to/app-a.apk", "/path/to/app-b.apk"]

calendarFormat

（仅限SIM）为iOS模拟器设置的日历格式

例如 gregorian

bundleId

测试中的应用程序的BundleID。用于在设备上启动应用程序。在真实设备上执行测试使用BundleID时，可以省略app参数，但是必须提供udid参数。

例如 io.appium.TestApp

udid

连接的物理设备的唯一设备标识符

例如 1ae203187fc012g

launchTimeout

instruments 挂起或失败后启动的等待时间。单位毫秒。

例如 20000

locationServicesEnabled

（仅限SIM）强制定位服务处于打开或关闭状态。默认是保持当前的模拟设置。

true，false

locationServicesAuthorized

(Sim-only) 通过修改 plist 文件设定是否允许应用使用定位服务，从而避免定位服务的警告出现。默认值是保持当前模拟器的设定。请注意在使用这个关键字时，你同时需要使用 bundleId 关键字来发送你的应用的 bundle ID。

true、false

autoAcceptAlerts

自动确认所有iOS弹出提示。这包括隐私访问权限提醒（例如：位置，联系人，照片）。默认是false。不适用于基于XCUITest的测试。

true、false

autoDismissAlerts

自动取消所有iOS弹出提示。这包括隐私访问权限提醒（例如：位置，联系人，照片）。默认是false。不适用于基于XCUITest的测试。

true、false

nativeInstrumentsLib

使用原生 intruments 库 (即关闭 instruments-without-delay )

true、false

nativeWebTap

（仅限SIM）在Safari上使用非JavaScript实现的web tap 操作。默认：false。警告：取决于viewport的大小/比例，这可能无法准确地点击一个元素

true、false

safariInitialUrl

（仅限SIM）（> = 8.1）初始Safari浏览器网址，默认为本地欢迎页面

例如https://www.github.com

safariAllowPopups

（仅限Sim）允许JavaScript在Safari中打开新窗口。默认保持当前的模拟设置

true、false

safariIgnoreFraudWarning

（仅限SIM）防止Safari显示欺诈网站警告。默认保持当前的模拟设置。

true、false

safariOpenLinksInBackground

（仅限SIM）Safari是否应允许在新窗口中打开链接。默认保持当前的模拟设置。

true、false

keepKeyChains

(Sim-only) 当 Appium 会话开始/结束时是否保留存放密码存放记录 (keychains) (库(Library)/钥匙串(Keychains))

true、false

localizableStringsDir

从哪里查找本地化字符串。默认值 en.lproj

en.lproj

processArguments

通过 instruments 传递到 AUT 的参数

例如：-myflag

interKeyDelay

以毫秒为单位，按下每一个按键之间的延迟时间。

例如：100

showIOSLog

是否在 Appium 的日志中显示设备的日志。默认值false

true、false

sendKeyStrategy

输入文字到文字框的策略。模拟器默认值：oneByOne(一个接着一个) 。真实设备默认值：grouped (分组输入)

oneByOne，grouped或者setValue

screenshotWaitTimeout

以秒为单位，生成屏幕截图的最长等待时间。默认值10

例如：5

waitForAppScript

用于判断 "应用是否被启动” 的 iOS 自动化脚本代码。默认情况下系统等待直到页面内容非空。结果必须是布尔类型。

例如：’true;’、’target.elements().length > 0;’、’$.delay(5000); true;’

webviewConnectRetries

向远程调试器发送连接消息以获取webview的次数。默认：8

例如：12

appName

被测应用程序的显示名称。用于在iOS 9+在后台自动化应用程序。

例如：UICatalog

customSSLCert

（仅限Sim）向模拟器添加SSL证书。

例如：

-----BEGIN CERTIFICATE-----MIIFWjCCBEKg...

-----END CERTIFICATE-----

webkitResponseTimeout

（仅限真实设备）设置时间（以毫秒为单位）以等待Safari会话中WebKit的响应。默认为5000

例如：10000