appium capabilities各个参数含义

本文详细介绍了Appium自动化测试中各种参数的使用,包括通用参数、安卓特有参数及苹果参数,帮助开发者理解如何配置Appium以适配不同的测试需求。

文章目录


在这里插入图片描述

这里官网链接,无需魔法上网 http://appium.io/docs/en/writing-running-appium/caps/

想要使 inspector 连接安卓的模拟器或手机需要以下参数

  • platformName
  • deviceName
  • appPackage
  • appActivity
  • automationName

一般写代码脚本需要以下基本参数(本人测安卓机)

  • platformName
  • udid(这个是唯一设备 id)
  • deviceName(名字可以随便填写)
  • appPackage
  • appActivity

至于 noReset 这个参数可以设置,接收布尔值,表示测试用例执行完后 app 的 session 信息是否被清除,如果是真,则下一个用例运行时候可以还是保持登录状态

avd 这个参数也可以加,作用是不手动打开模拟器,用代码来打开指定模拟器,它的值是emulator -list-avds中的设备名称。可能只支持原生的模拟器

常规通用参数介绍

CapabilityDescriptionValues
automationNameWhich automation engine to useAppium (default), or UiAutomator2, Espresso, or UiAutomator1 for Android, or XCUITest or Instruments for iOS, or YouiEngine for application built with You.i Engine
platformNameWhich mobile OS platform to useiOS, Android, or FirefoxOS
platformVersionMobile OS versione.g., 7.1, 4.4
deviceNameThe kind of mobile device or emulator to useiPhone 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, though it remains required.
appThe absolute local path or remote http URL to a .ipa file (IOS), .app folder (IOS Simulator), .apk file (Android) or .apks file (Android App Bundle), or a .zip file 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). UiAutomator2 and XCUITest allow to start the session without app or appPackage. Incompatible with browserName. See here about .apks file./abs/path/to/my.apk or http://myapp.com/app.ipa
otherAppsApp or list of apps (as a JSON array) to install prior to running tests. Note that it will not work with automationName of Espresso and iOS real devicese.g., "/path/to/app.apk", https://www.example.com/url/to/app.apk, ["http://appium.github.io/appium/assets/TestApp9.4.app.zip", "/path/to/app-b.app"]
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
languageLanguage to set for iOS (XCUITest driver only) and Android.e.g. fr
localeLocale to set for iOS (XCUITest driver only) and Android. fr_CA format for iOS. CA format (country name abbreviation) for Androide.g. fr_CA, 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 falsetrue, false
noResetDon’t reset app state before this session. See here for more detailstrue, false
fullResetPerform a complete reset. See here for more detailstrue, false
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)true, false
printPageSourceOnFindFailureWhen a find operation fails, print the current page source. Defaults to false.e.g., true
clearSystemFilesDelete any generated files at the end of a session. Default to false.true, false

只针对于使用在安卓上的是这些参数

CapabilityDescriptionValues
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)com.example.android.myApp, com.android.settings
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. You can also use wildcards (*).SplashActivity, SplashActivity,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 appActivitycom.example.android.myApp, com.android.settings
appWaitDurationTimeout in milliseconds used to wait for the appWaitActivity to launch (default 20000)30000
deviceReadyTimeoutTimeout in seconds while waiting for device to become ready5
allowTestPackagesAllow to install a test package which has android:testOnly="true" in the manifest. false by defaulttrue or false
androidCoverageFully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true -wcom.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation
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 or appium-espresso-driver. The default is 8200 in general and selects one port from 8200 to 8299 for appium-uiautomator2-server, it is 8300 from 8300 to 8399 for appium-espresso-driver. 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.: 192.168.0.101
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 60000)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
chromedriverArgsAn array of arguments to be passed to the chromedriver binary when it’s run by Appium. By default no CLI args are added beyond what Appium uses internally (such as --url-base, --port, --adb-port, and --log-path.e.g., ["--disable-gpu", "--disable-web-security"]
chromedriverExecutableDirThe absolute path to a directory to look for Chromedriver executables in, for automatic discovery of compatible Chromedrivers. Ignored if chromedriverUseSystemExecutable is true/abs/path/to/chromedriver/directory
chromedriverChromeMappingFileThe absolute path to a file which maps Chromedriver versions to the minimum Chrome that it supports. Ignored if chromedriverUseSystemExecutable is true/abs/path/to/mapping.json
chromedriverUseSystemExecutableIf true, bypasses automatic Chromedriver configuration and uses the version that comes downloaded with Appium. Ignored if chromedriverExecutable is set. Defaults to falsee.g., true
autoWebviewTimeoutAmount of time to wait for Webview context to become active, in ms. Defaults to 2000e.g. 4
chromedriverPortNumeric port to start Chromedriver on. Note that use of this capability is discouraged as it will cause undefined behavior in case there are multiple webviews present. By default Appium will find a free port.e.g. 8000
chromedriverPortsA list of valid ports for Appium to use for communication with Chromedrivers. This capability supports multiple webview scenarios. The form of this capability is an array of numeric ports, where array items can themselves be arrays of length 2, where the first element is the start of an inclusive range and the second is the end. By default, Appium will use any free port.e.g. [8000, [9000, 9005]]
ensureWebviewsHavePagesWhether or not Appium should augment its webview detection with page detection, guaranteeing that any webview contexts which show up in the context list have active pages. This can prevent an error if a context is selected where Chromedriver cannot find any pages. Defaults to falsee.g. true
webviewDevtoolsPortTo support the ensureWebviewsHavePages feature, it is necessary to open a TCP port for communication with the webview on the device under test. This capability allows overriding of the default port of 9222, in case multiple sessions are running simultaneously (to avoid port clash), or in case the default port is not appropriate for your system.e.g. 9543
enableWebviewDetailsCollectionEnables collection of detailed WebView information via /json/version CDP (Chrome Developer Protocol) endpoint since Appium 1.18.0+. This helps to properly match Chromedriver version which supports the given WebView. Without this flag enabled, Appium tries to guess the version of the WebView based on the version of the corresponding installed package (which usually fails for custom web views). Defaults to falsetrue or false
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, 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 setting as 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, 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 false. If noReset is true, this capability doesn’t work.true 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
adbExecTimeoutTimeout in milliseconds used to wait for adb command execution. Defaults to 20000e.g., 50000
localeScriptSets the locale scripte.g., "Cyrl" (Cyrillic)
skipDeviceInitializationSkip device initialization which includes i.a.: installation and running of Settings app or setting of permissions. Can be used to improve startup performance when the device was already used for automation and it’s prepared for the next automation. Defaults to falsetrue or false
chromedriverDisableBuildCheckSets the chromedriver flag --disable-build-check for Chrome webview teststrue or false
skipUnlockSkips unlock during session creation. Defaults to falsetrue or false
unlockTypeUnlock the target device with particular lock pattern instead of just waking up the device with a helper app. It works with unlockKey capability. Defaults to undefined. fingerprint is available only for Android 6.0+ and emulators. Read unlock doc in android driver.['pin', 'password', 'pattern', 'fingerprint']
unlockKeyA key pattern to unlock used by unlockType.e.g., ‘1111’
autoLaunchInitializing the app under test automatically. Appium does not install/launch the app under test if this is false. Defaults to truetrue or false
skipLogcatCaptureSkips to start capturing logcat. It might improve performance such as network. Log related commands will not work. Defaults to false.true or false
uninstallOtherPackagesA package, list of packages or * to uninstall package/s before installing apks for test. '*' uninstall all of thrid-party packages except for packages which is necessary for Appium to test such as io.appium.settings or io.appium.uiautomator2.server since Appium already contains the logic to manage them.e.g. "io.appium.example", ["io.appium.example1", "io.appium.example2"], '*'
disableWindowAnimationSet device animation scale zero if the value is true. After session is complete, Appium restores the animation scale to it’s original value. Defaults to falsetrue, false
remoteAppsCacheLimitSet the maximum number of remote cached apks (default is 10) which are pushed to the device-under-test’s local storage. Caching apks remotely speeds up the execution of sequential test cases, when using the same set of apks, by avoiding the need to be push an apk to the remote file system every time a reinstall is needed. Set this capability to 0 to disable caching.e.g. 0, 5, 20
buildToolsVersionSpecify the Android build-tools version to be something different than the default, which is to use the most recent version. It is helpful to use a non-default version if your environment uses alpha/beta build tools.e.g. '28.0.3'
androidNaturalOrientationAllow for correct handling of orientation on landscape-oriented devices. Set to true to basically flip the meaning of PORTRAIT and LANDSCAPE. Defaults to falsetrue, false
enforceAppInstallBy default application installation is skipped if newer or the same version of this app is already present on the device under test. Setting this option to true will enforce Appium to always install the current application build independently of the currently installed version of it. Defaults to false.true , false
ignoreHiddenApiPolicyErrorIgnores Security exception: Permission denial alert and allows to continue the session creation process since Appium 1.18.0+. The error happens when Appium tries to relax hidden API policy, although some devices with a customized firmware deny such requests. Defaults to false.true, false
mockLocationAppSets the package identifier of the app, which is used as a system mock location provider since Appium 1.18.0+. This capability has no effect on emulators. If the value is set to null or an empty string, then Appium will skip the mocked location provider setup procedure. Defaults to Appium Setting package identifier (io.appium.settings).e.g., null, io.appium.settings, example.your.app
logcatFormatSet the output format for logcat messages since Appium 1.18.0. Supported formats are listed in here. Please read logcat#outputFormat for more details about each format. Defaults to threadtime.e.g., process
logcatFilterSpecsSet the output filter rule for logcat messages since Appium 1.18.0. Please read logcat#filteringOutput for more details about the rule. Write and View Logs with Logcat is also helpful.e.g., ['*:W', 'MyActivity:D'] (MyActivity is a tag)

苹果的我没有给出,需要的可以去官网查看!

### 启动Appium并使用模拟器进行自动化测试 要使用 Appium 启动 Android 模拟器并进行自动化测试,需要完成以下几个关键步骤: #### 1. 环境准备 确保以下工具和库已经安装并配置好: - **Python**:安装 Python 3.x 版本,并确保其环境变量已添加到系统路径中。 - **Appium-Python-Client**:通过 pip 安装 Appium 的 Python 客户端库: ```bash pip install Appium-Python-Client ``` - **Java JDK**:安装 Java 开发工具包(JDK),并设置 `JAVA_HOME` 环境变量。 - **Android SDK**:安装 Android SDK 并配置 `ANDROID_HOME` 环境变量,确保 `adb` 命令可以在终端中运行。 - **模拟器**:可以使用 Android Studio 自带的 AVD Manager 创建并管理模拟器,或者使用第三方模拟器如夜神模拟器[^3]。 #### 2. 启动 Appium Server 启动 Appium Server 的方式有多种,可以使用命令行或者通过 Appium Desktop 工具启动: - **命令行启动**: ```bash appium ``` 这将在默认端口 `4723` 上启动 Appium Server。如果需要更改端口,可以使用如下命令: ```bash appium --port 4724 ``` #### 3. 启动 Android 模拟器 可以通过 Android Studio 的 AVD Manager 或者命令行来启动模拟器: - **使用命令行启动**: ```bash emulator -avd <AVD_NAME> ``` 其中 `<AVD_NAME>` 是你在 AVD Manager 中创建的虚拟设备名称。 #### 4. 配置 Desired Capabilities 在编写测试脚本之前,需要配置 `Desired Capabilities`,这些参数用于告诉 Appium 你想要启动的设备和应用信息。以下是一个示例配置: ```python from appium import webdriver desired_caps = { 'platformName': 'Android', 'platformVersion': '11', # 根据你的模拟器版本填写 'deviceName': 'emulator-5554', # 可以通过 adb devices 查看设备名称 'app': '/path/to/your/app.apk', # 应用的绝对路径 'automationName': 'Appium', 'newCommandTimeout': 60 } driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps) ``` #### 5. 编写并运行测试脚本 一旦 Appium Server 和模拟器都已启动,并且 `Desired Capabilities` 配置正确,就可以开始编写测试脚本了。以下是一个简单的示例,展示如何启动应用并查找一个元素: ```python from appium import webdriver from selenium.webdriver.common.by import By import time # 配置 Desired Capabilities desired_caps = { 'platformName': 'Android', 'platformVersion': '11', 'deviceName': 'emulator-5554', 'app': '/path/to/your/app.apk', 'automationName': 'Appium', 'newCommandTimeout': 60 } # 启动 Appium 会话 driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps) # 等待应用启动 time.sleep(5) # 查找并点击一个按钮 button = driver.find_element(By.ID, 'com.example.app:id/button') button.click() # 关闭会话 driver.quit() ``` #### 6. 使用 UiAutomatorViewer 定位元素 为了更方便地定位 UI 元素,可以使用 Android SDK 自带的 `uiautomatorviewer` 工具。该工具可以帮助你查看当前屏幕上的 UI 层次结构,并获取元素的 ID、类名等信息。启动 `uiautomatorviewer` 的命令如下: ```bash uiautomatorviewer ``` 在工具中,点击 "Device Screenshot" 按钮,可以捕获当前模拟器屏幕的快照,并通过鼠标悬停查看各个元素的属性。 #### 7. 注意事项 - **模拟器性能**:模拟器的性能通常不如真机,因此在测试时可能会遇到一些延迟或卡顿的情况。如果需要更高效的测试,建议使用真机进行测试。 - **应用签名问题**:某些情况下,模拟器可能无法安装从应用市场下载的应用。为了避免这种情况,建议使用本地打包的 release 版本或让开发人员提供专门用于测试的应用包[^3]。 - **Appium 日志**:在测试过程中,Appium 会生成详细的日志信息。如果遇到问题,可以通过查看日志来排查原因。 --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

abcnull

您的打赏是我创作的动力之一

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值