Desired Capabilities是由客户端发送给Appium服务器端的用来告诉服务器去启动哪种我们想要的会话的一套键值对集合。当中也有一些键值对是用来在 自动化的过程中修改服务器端的行为方式的。比如,我们可以把键为platformName的capability的值设置成iOS来告诉服务器我们想要开 启的是一个iOS的会话,而非Anddroid的会话。或者我们可以把键为safariAllowPopups 的capability的值设置成true来确保在Safari自动化会话的过程中,我们可以使用JavaScript来弹出一个新窗口。要查看 Appium支持的完整的capabilities列表,请查看capabilities doc或以下文档。
请注意以下列表中高亮的项,这些都是必填的项目。当中有以下几点需要注意的:
deviceName :我无论填写什么值,在我的HTC Incredable S机器上都可以跑通测试,但是这项又是必须要填的。我用得Appium版本是V1.2.2。app :如果填写了,appium会在目标机器上安装测试目标app,如果没有的话,会根据appActivity和appPackage去目标机器查找目标appappPackage : 可以通过sdk自带工具aapt获得appActivity:同样可以通过以上工具获得。有一点需要注意的是,值可以附加packageName,也可以不附加,也就是说以下两种填写方式都是对的“.NotesList"和”com.example.android.notepad.NotesList"
Appium server capabilities
Capability | Description | Values |
---|---|---|
automationName |
Which automation engine to use | Appium (default) or |
platformName |
Which mobile OS platform to use | iOS, |
platformVersion |
Mobile OS version | e.g., 7.1, |
deviceName |
The kind of mobile device or emulator to use | iPhone Simulator, |
app |
The absolute local path or remote http URL to an .ipa or |
/abs/path/to/my.apk or |
browserName |
Name of mobile web browser to automate. Should be an empty string if automating an app instead. | ‘Safari’ for iOS and ‘Chrome’, ‘Chromium’, or ‘Browser’ for Android |
newCommandTimeout |
How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session | e.g. 60 |
autoLaunch |
Whether to have Appium install and launch the app automatically. Default true |
true, |
language |
(Sim/Emu-only) Language to set for the simulator / emulator | e.g. fr |
locale |
(Sim/Emu-only) Locale to set for the simulator / emulator | e.g. fr_CA |
udid |
Unique device identifier of the connected physical device | e.g. 1ae203187fc012g |
orientation |
(Sim/Emu-only) start in a certain orientation | LANDSCAPE or |
autoWebview |
Move directly into Webview context. Default false |
true, |
noReset |
Don’t reset app state before this session. Default false |
true, |
fullReset |
(iOS) Delete the entire simulator folder. (Android) Reset app state by uninstalling app instead of clearing app data. On Android, this will also remove the app after the session is complete. Default false |
true, |
Capability | Description | Values |
---|---|---|
appActivity |
Activity name for the Android activity you want to launch from your package | MainActivity, |
appPackage |
Java package of the Android app you want to run | com.example.android.myApp, |
appWaitActivity |
Activity name for the Android activity you want to wait for | SplashActivity |
appWaitPackage |
Java package of the Android app you want to wait for | com.example.android.myApp, |
deviceReadyTimeout |
Timeout in seconds while waiting for device to become ready | 5 |
androidCoverage |
Fully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true -w | com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation |
enablePerformanceLogging |
(Chrome and webview only) Enable Chromedriver’s performance logging (default false) |
true, |
androidDeviceReadyTimeout |
Timeout in seconds used to wait for a device to become ready after booting | e.g., 30 |
androidDeviceSocket |
Devtools socket name. Needed only when tested app is a Chromium embedding browser. The socket is open by the browser and Chromedriver connects to it as a devtools client. | e.g., chrome_devtools_remote |
avd |
Name of avd to launch | e.g., api19 |
avdLaunchTimeout |
How long to wait in milliseconds for an avd to launch and connect to ADB (default 120000) |
300000 |
avdReadyTimeout |
How long to wait in milliseconds for an avd to finish its boot animations (default 120000) |
300000 |
avdArgs |
Additional emulator arguments used when launching an avd | e.g., -netfast |
useKeystore |
Use a custom keystore to sign apks, default false |
true or |
keystorePath |
Path to custom keystore, default ~/.android/debug.keystore | e.g., /path/to.keystore |
keystorePassword |
Password for custom keystore | e.g., foo |
keyAlias |
Alias for key | e.g., androiddebugkey |
keyPassword |
Password for key | e.g., foo |
chromedriverExecutable |
The absolute local path to webdriver executable (if Chromium embedder provides its own webdriver, it should be used instead of original chromedriver bundled with Appium) | /abs/path/to/webdriver |
specialChromedriverSessionArgs |
Custom arguments passed directly to chromedriver in chromeOptions capability. Passed as object which properties depend on a specific webdriver. | e.g., {'androidDeviceSocket': 'opera_beta_devtools_remote',} |
autoWebviewTimeout |
Amount of time to wait for Webview context to become active, in ms. Defaults to 2000 |
e.g. 4 |
intentAction |
Intent action which will be used to start activity (default android.intent.action.MAIN) |
e.g.android.intent.action.MAIN, |
intentCategory |
Intent category which will be used to start activity (default android.intent.category.LAUNCHER) |
e.g. android.intent.category.LAUNCHER, |
intentFlags |
Flags that will be used to start activity (default 0x10200000) |
e.g. 0x10200000 |
optionalIntentArguments |
Additional intent arguments that will be used to start activity. See Intent arguments | e.g. --esn <EXTRA_KEY>, |
unicodeKeyboard |
Enable Unicode input, default false |
true or |
resetKeyboard |
Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability. Ignored if used alone. Default |
true or |
Capability | Description | Values |
---|---|---|
calendarFormat |
(Sim-only) Calendar format to set for the iOS Simulator | e.g. gregorian |
bundleId |
Bundle ID of the app under test. Useful for starting an app on a real device or for using other caps which require the bundle ID during test startup | e.g. io.appium.TestApp |
launchTimeout |
Amount of time in ms to wait for instruments before assuming it hung and failing the session | e.g. 20000 |
locationServicesEnabled |
(Sim-only) Force location services to be either on or off. Default is to keep current sim setting. | true or |
locationServicesAuthorized |
(Sim-only) Set location services to be authorized or not authorized for app via plist, so that location services alert doesn’t pop up. Default is to keep current sim setting. Note that if you use this setting you MUST also use the bundleId capability to send in your app’s bundle ID. |
true or |
autoAcceptAlerts |
Accept iOS privacy access permission alerts (e.g., location, contacts, photos) automatically if they pop up. Default is false. | true or |
nativeInstrumentsLib |
Use native intruments lib (ie disable instruments-without-delay). | true or |
nativeWebTap |
(Sim-only) Enable “real”, non-javascript-based web taps in Safari. Default: false. Warning: depending on viewport size/ratio this might not accurately tap an element |
true or |
safariAllowPopups |
(Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim setting | true or |
safariIgnoreFraudWarning |
(Sim-only) Prevent Safari from showing a fraudulent website warning. Default keeps current sim setting. | true or |
safariOpenLinksInBackground |
(Sim-only) Whether Safari should allow links to open in new windows. Default keeps current sim setting. | true or |
keepKeyChains |
(Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished | true or |
localizableStringsDir |
Where to look for localizable strings. Default en.lproj |
en.lproj |
processArguments |
Arguments to pass to the AUT using instruments | e.g., -myflag |
interKeyDelay |
The delay, in ms, between keystrokes sent to an element when typing. | e.g., 100 |