Appium server capabilities详解
Appium server capability详解
| Capability | Description | Values |
|---|---|---|
| automationName | Which automation engine to use 使用的自动化引擎 | Appium (default) or Selendroid |
| platformName | Which mobile OS platform to use 使用的手机测试平台 | iOS, Android, or FirefoxOS |
| platformVersion | Mobile OS version 手机系统版本 | e.g., 7.1, 4.4 |
| deviceName | The kind of mobile device or emulator to use 使用真机测试还是模拟器测试 | iPhone Simulator, iPad Simulator, iPhone Retina 4-inch, Android Emulator, Galaxy S4, etc…. On iOS, this should be one of the valid devices returned by instruments with instruments -s devices. On Android this capability is currently ignored. |
| app | The absolute local path or remote http URL to an .ipa or .apk file, or a .zip containing one of these. Appium will attempt to install this app binary on the appropriate device first. Note that this capability is not required for Android if you specify appPackage and appActivitycapabilities (see below). Incompatible with browserName. 本地绝对路径、.ipad,.apk的远程http链接或者含有安装包的.zip压缩包。 | /abs/path/to/my.apk or http://myapp.com/app.ipa |
| browserName | Name of mobile web browser to automate. Should be an empty string if automating an app instead. 自动化运行的手机网页浏览器名称，如果自动化测试一个app，则为空。 | ‘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 在假设客户端停止结束回话之前，Appium等待客户端新命令的时间（秒）， | e.g. 60 |
| autoLaunch | Whether to have Appium install and launch the app automatically. Default true Appium是否自动安装和启动app，默认true | true, false |
| 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 PORTRAIT |
| autoWebview | Move directly into Webview context. Default false 直接进入Webview的上下文 | true, false |
| noReset | Don’t reset app state before this session. Default false 在回话之前不重置应用状态 | true, false |
| 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 (iOS)删除模拟器全部文件夹。(Android)通过卸载应用，而不是清除应用数据，来重置app状态。在Android上，也会在会话结束之后移除应用。默认false |
true, false |
iOS特有
| Capability | Description | Values |
|---|---|---|
| calendarFormat | (Sim-only) Calendar format to set for the iOS Simulator 为iOS模拟器设置的日历样式 |
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. To run a test on a real device using the bundle ID, you may omit the ‘app’ capability, but you must provide ‘udid’. 被测应用的Bundle ID。在测试过程中，用来在真机上启动应用，或者需要bundle ID的其他的帽。在真机上测试需要bundle ID，你可以漏掉参数app，但是必须提供udid。 |
e.g. io.appium.TestApp |
| udid | Unique device identifier of the connected physical device 所连接的真机的唯一的设备标识码 |
e.g. 1ae203187fc012g |
| launchTimeout | Amount of time in ms to wait for instruments before assuming it hung and failing the session 在假定会话悬挂且失败之前，instrument等待的时间。 |
e.g. 20000 |
| locationServicesEnabled | (Sim-only) Force location services to be either on or off. Default is to keep current sim setting. 定位服务是否打开，默认保持当前SIM设置。 |
true or false |
| 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. 是否通过plist授权app定位服务，所以定位服务弹窗不弹出。默认保持当前SIM设置。 注意，如果你使用这个设置，你必须使用bundle参数来设置。 |
true or false |
| autoAcceptAlerts | Accept iOS privacy access permission alerts (e.g., location, contacts, photos) automatically if they pop up. Default is false. |
true or false |
| autoDismissAlerts | Dismiss iOS privacy access permission alerts (e.g., location, contacts, photos) automatically if they pop up. Default is false. |
true or false |
| nativeInstrumentsLib | Use native intruments lib (ie disable instruments-without-delay). | true or false |
| 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 false |
| safariInitialUrl | (Sim-only) (>= 8.1) Initial safari url, default is a local welcome page | e.g. https://www.github.com |
| safariAllowPopups | (Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim setting | true or false |
| safariIgnoreFraudWarning | (Sim-only) Prevent Safari from showing a fraudulent website warning. Default keeps current sim setting. | true or false |
| safariOpenLinksInBackground | (Sim-only) Whether Safari should allow links to open in new windows. Default keeps current sim setting. | true or false |
| keepKeyChains | (Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished | true or false |
| 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 |
| showIOSLog | Whether to show any logs captured from a device in the appium logs. Default false | true or false |
| sendKeyStrategy | strategy to use to type test into a test field. Simulator default: oneByOne. Real device default: grouped | oneByOne, groupedor setValue |
| screenshotWaitTimeout | Max timeout in sec to wait for a screenshot to be generated. default: 10 | e.g., 5 |
| waitForAppScript | The ios automation script used to determined if the app has been launched, by default the system wait for the page source not to be empty. The result must be a boolean |
e.g. true;, target.elements().length > 0;, $.delay(5000); true; |
| webviewConnectRetries | Number of times to send connection message to remote debugger, to get webview. Default: 8 | e.g., 12 |
ANDROID ONLY
| Capability | Description | Values |
|---|---|---|
| appActivity | Activity name for the Android activity you want to launch from your package. This often needs to be preceded by a . (e.g., .MainActivity instead of MainActivity) |
MainActivity, .Settings |
| appPackage | Java package of the Android app you want to run | com.example.android.myApp, com.android.settings |
| 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, com.android.settings |
| 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, false |
| 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 false |
| 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 web driver, it should be used instead of original chromedriver bundled with Appium) |
/abs/path/to/webdriver |
| 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, android.intent.action.VIEW |
| intentCategory | Intent category which will be used to start activity (default android.intent.category.LAUNCHER) | e.g. android.intent.category.LAUNCHER, android.intent.category.APP_CONTACTS |
| 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 --ez |
| dontStopAppOnReset | Doesn’t stop the process of the app under test, before starting the app using adb. If the app under test is created by another anchor app, setting this false, allows the process of the anchor app to be still alive, during the start of the test app using adb. In other words, with dontStopAppOnReset set to true, we will not include the -S flag in the adb shell am start call. With this capability omitted or set to false, we include the -S flag. Default false |
true or false |
| unicodeKeyboard | Enable Unicode input, default false | true or false |
| resetKeyboard | Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability. Ignored if used alone. Default false |
true or false |
| noSign | Skip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default false |
true or false |
| ignoreUnimportantViews | Calls the setCompressedLayoutHierarchy() uiautomator function. This capability can speed up test execution,since Accessibility commands will run faster ignoring some elements. The ignored elements will not be findable, which is why this capability has also been implemented as a toggle-able setting as well as a capability. Defaults to false |
true or false |
| disableAndroidWatchers | Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator. This capability will work only with UiAutomator and not with selendroid, default false |
true or false |
| chromeOptions | Allows passing chromeOptions capability for chrome driver. For more information see chromeOptions | chromeOptions: {args: ['--disable-popup-blocking']} |