Posts Appium-服务关键字


General Capabilities

These Capabilities span multiple drivers.

automationNameWhich automation engine to useAppium (default) or Selendroidor UiAutomator2 or Espresso for Android or XCUITest for iOS or YouiEngine for application built with You.i Engine
platformNameWhich mobile OS platform to useiOSAndroid, or FirefoxOS
platformVersionMobile OS versione.g., 7.14.4
deviceNameThe kind of mobile device or emulator to useiPhone SimulatoriPad SimulatoriPhone Retina 4-inchAndroid EmulatorGalaxy 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, though it remains required.
appThe absolute local path or remote http URL to an .ipa or .apk file, or a .zipcontaining 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./abs/path/to/my.apk or
browserNameName 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
newCommandTimeoutHow long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the sessione.g. 60
language(Sim/Emu-only) Language to set for the simulator / emulator. On Android, available only on API levels 22 and belowe.g. fr
locale(Sim/Emu-only) Locale to set for the simulator / emulator.e.g. fr_CA
udidUnique device identifier of the connected physical devicee.g. 1ae203187fc012g
orientation(Sim/Emu-only) start in a certain orientationLANDSCAPE or PORTRAIT
autoWebviewMove directly into Webview context. Default falsetruefalse
noResetDon’t reset app state before this session. See here for more detailstruefalse
fullResetPerform a complete reset. See here for more detailstruefalse
eventTimingsEnable or disable the reporting of the timings for various Appium-internal events (e.g., the start and end of each command, etc.). Defaults to false. To enable, use true. The timings are then reported as events property on response to querying the current session. See the event timing docs for the the structure of this response.e.g., true
enablePerformanceLogging(Web and webview only) Enable Chromedriver’s (on Android) or Safari’s (on iOS) performance logging (default false)truefalse
printPageSourceOnFindFailureWhen a find operation fails, print the current page source. Defaults to false.e.g., true

Android Only

These Capabilities are available only on Android-based drivers (like UiAutomator2 for example).

appActivityActivity 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). By default this capability is received from the package manifest (action: android.intent.action.MAIN , category: android.intent.category.LAUNCHER)MainActivity.Settings
appPackageJava package of the Android app you want to run. By default this capability is received from the package manifest (@package attribute value)
appWaitActivityActivity name/names, comma separated, for the Android activity you want to wait for. By default the value of this capability is the same as for appActivity. You must set it to the very first focused application activity name in case it is different from the one which is set as appActivity if your capability has appActivity and appPackage.SplashActivitySplashActivity,OtherActivity**.SplashActivity
appWaitPackageJava package of the Android app you want to wait for. By default the value of this capability is the same as for
appWaitDurationTimeout in milliseconds used to wait for the appWaitActivity to launch (default 20000)30000
deviceReadyTimeoutTimeout in seconds while waiting for device to become ready5
androidCoverageFully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true
androidCoverageEndIntentA broadcast action implemented by yourself which is used to dump coverage into file system. Passed to -a in adb shell am broadcast -acom.example.pkg.END_EMMA
androidDeviceReadyTimeoutTimeout in seconds used to wait for a device to become ready after bootinge.g., 30
androidInstallTimeoutTimeout in milliseconds used to wait for an apk to install to the device. Defaults to 90000e.g., 90000
androidInstallPathThe name of the directory on the device in which the apk will be push before install. Defaults to /data/local/tmpe.g. /sdcard/Downloads/
adbPortPort used to connect to the ADB server (default 5037)5037
systemPortsystemPort used to connect to appium-uiautomator2-server, default is 8200 in general and selects one port from 8200 to 8299. When you run tests in parallel, you must adjust the port to avoid conflicts. Read Parallel Testing Setup Guide for more details.e.g., 8201
remoteAdbHostOptional remote ADB server hoste.g.:
androidDeviceSocketDevtools 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
avdName of avd to launche.g., api19
avdLaunchTimeoutHow long to wait in milliseconds for an avd to launch and connect to ADB (default 120000)300000
avdReadyTimeoutHow long to wait in milliseconds for an avd to finish its boot animations (default 120000)300000
avdArgsAdditional emulator arguments used when launching an avde.g., -netfast
useKeystoreUse a custom keystore to sign apks, default falsetrue or false
keystorePathPath to custom keystore, default ~/.android/debug.keystoree.g., /path/to.keystore
keystorePasswordPassword for custom keystoree.g., foo
keyAliasAlias for keye.g., androiddebugkey
keyPasswordPassword for keye.g., foo
chromedriverExecutableThe 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
chromedriverExecutableDirThe absolute path to a directory to look for Chromedriver executables in, for automatic discovery of compatible Chromedrivers/abs/path/to/chromedriver/directory
chromedriverChromeMappingFileThe absolute path to a file which maps Chromedriver versions to the minimum Chrome that it supports/abs/path/to/mapping.json
autoWebviewTimeoutAmount of time to wait for Webview context to become active, in ms. Defaults to 2000e.g. 4
intentActionIntent action which will be used to start activity (default android.intent.action.MAIN)
intentCategoryIntent category which will be used to start activity (default android.intent.category.LAUNCHER)e.g. android.intent.category.LAUNCHERandroid.intent.category.APP_CONTACTS
intentFlagsFlags that will be used to start activity (default 0x10200000)e.g. 0x10200000
optionalIntentArgumentsAdditional intent arguments that will be used to start activity. See Intent argumentse.g. --esn <EXTRA_KEY>--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE>, etc.
dontStopAppOnResetDoesn’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 falsetrue or false
unicodeKeyboardEnable Unicode input, default falsetrue or false
resetKeyboardReset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability. Ignored if used alone. Default falsetrue or false
noSignSkip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default falsetrue or false
ignoreUnimportantViewsCalls 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 settingas well as a capability. Defaults to falsetrue or false
disableAndroidWatchersDisables 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 falsetrue or false
chromeOptionsAllows passing chromeOptions capability for ChromeDriver. For more information see chromeOptionschromeOptions: {args: ['--disable-popup-blocking']}
recreateChromeDriverSessionsKill ChromeDriver session when moving to a non-ChromeDriver webview. Defaults to falsetrue or false
nativeWebScreenshotIn a web context, use native (adb) method for taking a screenshot, rather than proxying to ChromeDriver. Defaults to falsetrue or false
androidScreenshotPathThe name of the directory on the device in which the screenshot will be put. Defaults to /data/local/tmpe.g. /sdcard/screenshots/
autoGrantPermissionsHave Appium automatically determine which permissions your app requires and grant them to the app on install. Defaults to falsetrue or false
networkSpeedSet the network speed emulation. Specify the maximum network upload and download speeds. Defaults to full['full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'] Check -netspeed option more info about speed emulation for avds
gpsEnabledToggle gps location provider for emulators before starting the session. By default the emulator will have this option enabled or not according to how it has been provisioned.true or false
isHeadlessSet this capability to true to run the Emulator headless when device display is not needed to be visible. false is the default value. isHeadless is also support for iOS, check XCUITest-specific capabilities.e.g., true
uiautomator2ServerLaunchTimeoutTimeout in milliseconds used to wait for an uiAutomator2 server to launch. Defaults to 20000e.g., 20000
uiautomator2ServerInstallTimeoutTimeout in milliseconds used to wait for an uiAutomator2 server to be installed. Defaults to 20000e.g., 20000
otherAppsApp or list of apps (as a JSON array) to install prior to running testse.g., "/path/to/app.apk"["/path/to/app-a.apk", "/path/to/app-b.apk"]

iOS Only

These Capabilities are available only on the XCUITest Driver and the deprecated UIAutomation Driver.

calendarFormat(Sim-only) Calendar format to set for the iOS Simulatore.g. gregorian
bundleIdBundle 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’.e.g. io.appium.TestApp
udidUnique device identifier of the connected physical devicee.g. 1ae203187fc012g
launchTimeoutAmount of time in ms to wait for instruments before assuming it hung and failing the sessione.g. 20000
locationServicesEnabled(Sim-only) Force location services to be either on or off. Default is to keep current sim setting.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.true or false
autoAcceptAlertsAccept all iOS alerts automatically if they pop up. This includes privacy access permission alerts (e.g., location, contacts, photos). Default is false. Does not work on XCUITest-based tests.true or false
autoDismissAlertsDismiss all iOS alerts automatically if they pop up. This includes privacy access permission alerts (e.g., location, contacts, photos). Default is false. Does not work on XCUITest-based tests.true or false
nativeInstrumentsLibUse 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 elementtrue or false
safariInitialUrl(Sim-only) (>= 8.1) Initial safari url, default is a local welcome pagee.g.
safariAllowPopups(Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim settingtrue 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/finishedtrue or false
localizableStringsDirWhere to look for localizable strings. Default en.lprojen.lproj
processArgumentsArguments to pass to the AUT using instrumentse.g., -myflag
interKeyDelayThe delay, in ms, between keystrokes sent to an element when typing.e.g., 100
showIOSLogWhether to show any logs captured from a device in the appium logs. Default falsetrue or false
sendKeyStrategystrategy to use to type test into a test field. Simulator default: oneByOne. Real device default: groupedoneByOnegrouped or setValue
screenshotWaitTimeoutMax timeout in sec to wait for a screenshot to be generated. default: 10e.g., 5
waitForAppScriptThe 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 booleane.g. true;target.elements().length > 0;$.delay(5000); true;
webviewConnectRetriesNumber of times to send connection message to remote debugger, to get webview. Default: 8e.g., 12
appNameThe display name of the application under test. Used to automate backgrounding the app in iOS 9+.e.g., UICatalog


This post is licensed under CC BY 4.0 by the author.