首页 > 代码库 > 传递给Appium服务器以开启相应安卓Automation会话的Capabilities的几点说明

传递给Appium服务器以开启相应安卓Automation会话的Capabilities的几点说明

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去目标机器查找目标app
  • appPackage :  可以通过sdk自带工具aapt获得
  • appActivity:同样可以通过以上工具获得。有一点需要注意的是,值可以附加packageName,也可以不附加,也就是说以下两种填写方式都是对的“.NotesList"和”com.example.android.notepad.NotesList"


Appium server capabilities

CapabilityDescriptionValues
automationNameWhich automation engine to useAppium (default) or Selendroid
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…
appThe 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 appActivity capabilities (see below). Incompatible with browserName./abs/path/to/my.apk or http://myapp.com/app.ipa
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
autoLaunchWhether to have Appium install and launch the app automatically. Default truetruefalse
language(Sim/Emu-only) Language to set for the simulator / emulatore.g. fr
locale(Sim/Emu-only) Locale to set for the simulator / emulatore.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. Default falsetruefalse
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 falsetruefalse

ANDROID ONLY

CapabilityDescriptionValues
appActivityActivity name for the Android activity you want to launch from your packageMainActivity.Settings
appPackageJava package of the Android app you want to runcom.example.android.myAppcom.android.settings
appWaitActivityActivity name for the Android activity you want to wait forSplashActivity
appWaitPackageJava package of the Android app you want to wait forcom.example.android.myAppcom.android.settings
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 -wcom.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation
enablePerformanceLogging(Chrome and webview only) Enable Chromedriver’s performance logging (default false)truefalse
androidDeviceReadyTimeoutTimeout in seconds used to wait for a device to become ready after bootinge.g., 30
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
specialChromedriverSessionArgsCustom 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‘,}
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)e.g.android.intent.action.MAINandroid.intent.action.VIEW
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.
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

IOS ONLY

CapabilityDescriptionValues
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 startupe.g. io.appium.TestApp
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 orfalse
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 orfalse
autoAcceptAlertsAccept iOS privacy access permission alerts (e.g., location, contacts, photos) automatically if they pop up. Default is false.true orfalse
nativeInstrumentsLibUse native intruments lib (ie disable instruments-without-delay).true orfalse
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 orfalse
safariAllowPopups(Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim settingtrue orfalse
safariIgnoreFraudWarning(Sim-only) Prevent Safari from showing a fraudulent website warning. Default keeps current sim setting.true orfalse
safariOpenLinksInBackground(Sim-only) Whether Safari should allow links to open in new windows. Default keeps current sim setting.true orfalse
keepKeyChains(Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finishedtrue orfalse
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

以下是一个配置例子:

    public void setUp() throws Exception {
        // set up appium
        File classpathRoot = new File(System.getProperty("user.dir"));
        File appDir = new File(classpathRoot, "apps");
        File app = new File(appDir, "NotePad.apk");
        DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("deviceName","iPad Simulator");
        //capabilities.setCapability("platformVersion", "4.2");
        capabilities.setCapability("platformName", "Android");
        capabilities.setCapability("app", app.getAbsolutePath());
        //capabilities.setCapability("appPackage", "com.example.android.notepad");
        //capabilities.setCapability("appActivity", "com.example.android.notepad.NotesList");
        //capabilities.setCapability("appActivity", ".NotesList");
        driver = new AppiumDriver(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
    }


传递给Appium服务器以开启相应安卓Automation会话的Capabilities的几点说明