（三）Appium的DesiredCapabilities参数

àì夳堔傛蜴生んèń 2022-03-30 03:59 157阅读 0赞

**目录**

前言

基本参数

Android特有

iOS特有

附录

--------------------

## 前言 ##

这个参数是干嘛的，有啥子用，下面我们一一道来。首先Desired Capabilities 是由 keys 和 values 组成的 JSON 对象。它负责启动服务端时的参数设置，启动session的时候是必须提供的。它告诉appium server这样一些事情，比如：

*  本次测试是启动浏览器还是启动移动设备？
 *  是启动andorid还是启动ios？
 *  启动android时，app的package是什么？
 *  启动android时，app的activity是什么？

说白了，我们做app自动化测试的时候，这个是配置连接手机的相关信息。那么有哪些配置呢。

## 基本参数 ##

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>实例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>automationName</code></td> 
   <td>自动化测试引擎</td> 
   <td><code>Appium</code>或&nbsp;<code>Selendroid</code></td> 
  </tr> 
  <tr> 
   <td><code>platformName</code></td> 
   <td>手机操作系统</td> 
   <td><code>iOS</code>,&nbsp;<code>Android</code>, 或&nbsp;<code>FirefoxOS</code></td> 
  </tr> 
  <tr> 
   <td><code>platformVersion</code></td> 
   <td>手机操作系统版本</td> 
   <td>如：&nbsp;<code>7.1</code>,&nbsp;<code>4.4</code>；ios的&nbsp;<code>9.0</code></td> 
  </tr> 
  <tr> 
   <td><code>deviceName</code></td> 
   <td>手机或模拟器设备名称</td> 
   <td>android的忽略，ios如<code>iPhone Simulator</code></td> 
  </tr> 
  <tr> 
   <td><code>app</code></td> 
   <td><code>.ipa</code>&nbsp;<code>.apk</code>文件路径</td> 
   <td>比如<code>/abs/path/to/my.apk</code>或<code>http://myapp.com/app.ipa</code></td> 
  </tr> 
  <tr> 
   <td><code>browserName</code></td> 
   <td>启动手机浏览器</td> 
   <td>iOS如:<code>Safari，Android</code>如:<code>Chrome,Chromium,Browser</code></td> 
  </tr> 
  <tr> 
   <td><code>newCommandTimeout</code></td> 
   <td>设置命令超时时间，单位：秒。</td> 
   <td>比如&nbsp;<code>60</code></td> 
  </tr> 
  <tr> 
   <td><code>autoLaunch</code></td> 
   <td>Appium是否需要自动安装和启动应用。默认值<code>true</code></td> 
   <td><code>true</code>,&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>language</code></td> 
   <td>(Sim/Emu-only) 设定模拟器 ( simulator / emulator ) 的语言。</td> 
   <td>如：&nbsp;<code>fr</code></td> 
  </tr> 
  <tr> 
   <td><code>locale</code></td> 
   <td>(Sim/Emu-only) 设定模拟器 ( simulator / emulator ) 的区域设置。</td> 
   <td>如：&nbsp;<code>fr_CA</code></td> 
  </tr> 
  <tr> 
   <td><code>udid</code></td> 
   <td>ios真机的唯一设备标识</td> 
   <td>如：&nbsp;<code>1ae203187fc012g</code></td> 
  </tr> 
  <tr> 
   <td><code>orientation</code></td> 
   <td>设置横屏或竖屏</td> 
   <td><code>LANDSCAPE</code>&nbsp;(横向) 或&nbsp;<code>PORTRAIT</code>&nbsp;(纵向)</td> 
  </tr> 
  <tr> 
   <td><code>autoWebview</code></td> 
   <td>直接转换到 WebView 上下文。 默认值&nbsp;<code>false</code>、</td> 
   <td><code>true</code>,&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>noReset</code></td> 
   <td>不要在会话前重置应用状态。默认值<code>false</code>。</td> 
   <td><code>true</code>,&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>fullReset</code></td> 
   <td>(iOS) 删除整个模拟器目录。(Android)通过卸载默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>,&nbsp;<code>false</code></td> 
  </tr> 
 </tbody> 
</table>

## Android特有 ##

<table> 
 <thead> 
  <tr> 
   <th>关键字</th> 
   <th>描述</th> 
   <th>实例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>appActivity</code></td> 
   <td>启动app包,一般点开头</td> 
   <td>如：<code>.MainActivity</code>,&nbsp;<code>.Settings</code></td> 
  </tr> 
  <tr> 
   <td><code>appPackage</code></td> 
   <td>Android应用的包名</td> 
   <td>比如<code>com.example.android.myApp</code></td> 
  </tr> 
  <tr> 
   <td><code>appWaitActivity</code></td> 
   <td>等待启动的Activity名称</td> 
   <td><code>SplashActivity</code></td> 
  </tr> 
  <tr> 
   <td><code>deviceReadyTimeout</code></td> 
   <td>设置超时时间</td> 
   <td><code>5</code></td> 
  </tr> 
  <tr> 
   <td><code>androidCoverage</code></td> 
   <td>用于执行测试的 instrumentation类</td> 
   <td><code>com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation</code></td> 
  </tr> 
  <tr> 
   <td><code>enablePerformanceLogging</code></td> 
   <td>(仅适用于 Chrome 和 webview) 开启 Chromedriver 的性能日志。(默认&nbsp;<code>false</code>)</td> 
   <td><code>true</code>,&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>androidDeviceReadyTimeout</code></td> 
   <td>等待设备在启动应用后超时时间，单位秒</td> 
   <td>如&nbsp;<code>30</code></td> 
  </tr> 
  <tr> 
   <td><code>androidDeviceSocket</code></td> 
   <td>开发工具的 socket 名称。Chromedriver 把它作为开发者工具来进行连接。</td> 
   <td>如&nbsp;<code>chrome_devtools_remote</code></td> 
  </tr> 
  <tr> 
   <td><code>avd</code></td> 
   <td>需要启动的 AVD (安卓模拟器设备) 名称。</td> 
   <td>如&nbsp;<code>api19</code></td> 
  </tr> 
  <tr> 
   <td><code>avdLaunchTimeout</code></td> 
   <td>以毫秒为单位，等待 AVD 启动并连接到 ADB的超时时间。(默认值&nbsp;<code>120000</code>)</td> 
   <td><code>300000</code></td> 
  </tr> 
  <tr> 
   <td><code>avdReadyTimeout</code></td> 
   <td>以毫秒为单位，等待 AVD 完成启动动画的超时时间。(默认值&nbsp;<code>120000</code>)</td> 
   <td><code>300000</code></td> 
  </tr> 
  <tr> 
   <td><code>avdArgs</code></td> 
   <td>启动 AVD 时需要加入的额外的参数。</td> 
   <td>如&nbsp;<code>-netfast</code></td> 
  </tr> 
  <tr> 
   <td><code>useKeystore</code></td> 
   <td>使用一个自定义的 keystore 来对 apk 进行重签名。默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;or&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>keystorePath</code></td> 
   <td>自定义keystore路径。默认~/.android/debug.keystore</td> 
   <td>如&nbsp;<code>/path/to.keystore</code></td> 
  </tr> 
  <tr> 
   <td><code>keystorePassword</code></td> 
   <td>自定义 keystore 的密码。</td> 
   <td>如&nbsp;<code>foo</code></td> 
  </tr> 
  <tr> 
   <td><code>keyAlias</code></td> 
   <td>key 的别名</td> 
   <td>如&nbsp;<code>androiddebugkey</code></td> 
  </tr> 
  <tr> 
   <td><code>keyPassword</code></td> 
   <td>key 的密码</td> 
   <td>如&nbsp;<code>foo</code></td> 
  </tr> 
  <tr> 
   <td><code>chromedriverExecutable</code></td> 
   <td>webdriver可执行文件的绝对路径 应该用它代替Appium 自带的 webdriver)</td> 
   <td><code>/abs/path/to/webdriver</code></td> 
  </tr> 
  <tr> 
   <td><code>autoWebviewTimeout</code></td> 
   <td>毫秒为单位，Webview上下文激活的时间。默认<code>2000</code></td> 
   <td>如&nbsp;<code>4</code></td> 
  </tr> 
  <tr> 
   <td><code>intentAction</code></td> 
   <td>用于启动activity的intent action。(默认值&nbsp;<code>android.intent.action.MAIN</code>)</td> 
   <td>如&nbsp;<code>android.intent.action.MAIN</code>,&nbsp;<code>android.intent.action.VIEW</code></td> 
  </tr> 
  <tr> 
   <td><code>intentCategory</code></td> 
   <td>用于启动 activity 的 intent category。 (默认值&nbsp;<code>android.intent.category.LAUNCHER</code>)</td> 
   <td>如&nbsp;<code>android.intent.category.LAUNCHER</code>,&nbsp;<code>android.intent.category.APP_CONTACTS</code></td> 
  </tr> 
  <tr> 
   <td><code>intentFlags</code></td> 
   <td>用于启动activity的标识(flags) (默认值&nbsp;<code>0x10200000</code>)</td> 
   <td>如&nbsp;<code>0x10200000</code></td> 
  </tr> 
  <tr> 
   <td><code>optionalIntentArguments</code></td> 
   <td>用于启动 activity 的额外 intent 参数。请查看&nbsp;<a href="http://developer.android.com/tools/help/adb.html#IntentSpec" rel="nofollow">Intent 参数</a></td> 
   <td>如&nbsp;<code>--esn &lt;EXTRA_KEY&gt;</code>,&nbsp;<code>--ez &lt;EXTRA_KEY&gt; &lt;EXTRA_BOOLEAN_VALUE&gt;</code></td> 
  </tr> 
  <tr> 
   <td><code>dontStopAppOnReset</code></td> 
   <td>在使用 adb 启动应用时不要停止被测应用的进程。默认值：&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>unicodeKeyboard</code></td> 
   <td>使用 Unicode 输入法。默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>resetKeyboard</code></td> 
   <td>重置输入法到原有状态，默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>noSign</code></td> 
   <td>跳过检查和对应用进行 debug 签名的步骤。默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>ignoreUnimportantViews</code></td> 
   <td>调用 uiautomator 的函数这个关键字能加快测试执行的速度。默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>disableAndroidWatchers</code></td> 
   <td>关闭 android 监测应用无响ANR和崩溃crash的监视器默认值：&nbsp;<code>false</code>。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>chromeOptions</code></td> 
   <td>允许传入 chrome driver 使用的 chromeOptions 参数。请查阅&nbsp;<a href="https://sites.google.com/a/chromium.org/chromedriver/capabilities" rel="nofollow">chromeOptions</a>&nbsp;了解更多信息。</td> 
   <td><code>chromeOptions: {args: [‘--disable-popup-blocking‘]}</code></td> 
  </tr> 
 </tbody> 
</table>

## iOS特有 ##

<table> 
 <thead> 
  <tr> 
   <th>关键字</th> 
   <th>描述</th> 
   <th>实例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>calendarFormat</code></td> 
   <td>(Sim-only) 为iOS的模拟器设置日历格式</td> 
   <td>如&nbsp;<code>gregorian</code>&nbsp;(公历)</td> 
  </tr> 
  <tr> 
   <td><code>bundleId</code></td> 
   <td><strong>被测应用的bundle ID，真机上执行测试时，你可以不提供&nbsp;<code>app</code>&nbsp;关键字，但你必须提供udid</strong></td> 
   <td>如&nbsp;<code>io.appium.TestApp</code></td> 
  </tr> 
  <tr> 
   <td><code>udid</code></td> 
   <td><strong>连接真机的唯一设备编号 ( Unique device identifier )</strong></td> 
   <td>如&nbsp;<code>1ae203187fc012g</code></td> 
  </tr> 
  <tr> 
   <td><code>launchTimeout</code></td> 
   <td>以毫秒为单位，在Appium运行失败之前设置一个等待 instruments的时间</td> 
   <td>比如：&nbsp;<code>20000</code></td> 
  </tr> 
  <tr> 
   <td><code>locationServicesEnabled</code></td> 
   <td>(Sim-only) 强制打开或关闭定位服务。默认值是保持当前模拟器的设定</td> 
   <td><code>true</code>&nbsp;或&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>locationServicesAuthorized</code></td> 
   <td>使用这个关键字时，你同时需要使用&nbsp;<code>bundleId</code>&nbsp;关键字来发送你的应用的 bundle ID。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>autoAcceptAlerts</code></td> 
   <td>当 iOS 的个人信息访问警告 (如 位置、联系人、图片) 出现时，自动选择接受( Accept )。默认值&nbsp;<code>false</code>。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>autoDismissAlerts</code></td> 
   <td>当 iOS 的个人信息访问警告 (如 位置、联系人、图片) 出现时，自动选择不接受( Dismiss )。默认值&nbsp;<code>false</code>。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>nativeInstrumentsLib</code></td> 
   <td>使用原生 intruments 库 (即关闭 instruments-without-delay )</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>nativeWebTap</code></td> 
   <td>(Sim-only) 在Safari中允许"真实的"，默认值：&nbsp;<code>false</code>。注意：取决于 viewport 大小/比例， 点击操作不一定能精确地点中对应的元素。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>safariInitialUrl</code></td> 
   <td>(Sim-only) (&gt;= 8.1) Safari 的初始地址。默认值是一个本地的欢迎页面</td> 
   <td>例如：&nbsp;<code>https://www.github.com</code></td> 
  </tr> 
  <tr> 
   <td><code>safariAllowPopups</code></td> 
   <td>(Sim-only) 允许 javascript 在 Safari 中创建新窗口。默认保持模拟器当前设置。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>safariIgnoreFraudWarning</code></td> 
   <td>(Sim-only) 阻止 Safari 显示此网站可能存在风险的警告。默认保持浏览器当前设置。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>safariOpenLinksInBackground</code></td> 
   <td>(Sim-only) Safari 是否允许链接在新窗口打开。默认保持浏览器当前设置。</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>keepKeyChains</code></td> 
   <td>(Sim-only) 当 Appium 会话开始/结束时是否保留存放密码存放记录 (keychains) (库(Library)/钥匙串(Keychains))</td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>localizableStringsDir</code></td> 
   <td>从哪里查找本地化字符串。默认值&nbsp;<code>en.lproj</code></td> 
   <td><code>en.lproj</code></td> 
  </tr> 
  <tr> 
   <td><code>processArguments</code></td> 
   <td>通过 instruments 传递到 AUT 的参数</td> 
   <td>如&nbsp;<code>-myflag</code></td> 
  </tr> 
  <tr> 
   <td><code>interKeyDelay</code></td> 
   <td>以毫秒为单位，按下每一个按键之间的延迟时间。</td> 
   <td>如&nbsp;<code>100</code></td> 
  </tr> 
  <tr> 
   <td><code>showIOSLog</code></td> 
   <td>是否在 Appium 的日志中显示设备的日志。默认值&nbsp;<code>false</code></td> 
   <td><code>true</code>&nbsp;或者&nbsp;<code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>sendKeyStrategy</code></td> 
   <td>输入文字到文字框的策略。模拟器默认值：<code>oneByOne</code>&nbsp;(一个接着一个) 。真实设备默认值：<code>grouped</code>&nbsp;(分组输入)</td> 
   <td><code>oneByOne</code>,&nbsp;<code>grouped</code>&nbsp;或&nbsp;<code>setValue</code></td> 
  </tr> 
  <tr> 
   <td><code>screenshotWaitTimeout</code></td> 
   <td>以秒为单位，生成屏幕截图的最长等待时间。默认值： 10。</td> 
   <td>如&nbsp;<code>5</code></td> 
  </tr> 
  <tr> 
   <td><code>waitForAppScript</code></td> 
   <td>用于判断 "应用是否被启动” 的 iOS 自动化脚本代码。默认情况下系统等待直到页面内容非空。结果必须是布尔类型。</td> 
   <td>例如&nbsp;<code>true;</code>,&nbsp;<code>target.elements().length &gt; 0;</code>,&nbsp;<code>$.delay(5000); true;</code></td> 
  </tr> 
 </tbody> 
</table>

## 附录 ##

**获取设备名称`deviceName`**

**![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70][]**

**获取appPackage和appActivity（打开app，命令行输入）**

**![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70 1][]**

**实例**

# 启动服务端时的参数设置
        desired_caps = {'platformName': 'Android',
                        'deviceName': 'SGEEGEHIQ8I7CIKF',
                        'platformVersion': '6.0',
                        'unicodeKeyboard': True,
                        'resetKeyboard': True,
                        'appPackage': 'com.mengtuiapp.mall',
                        'appActivity': '.business.main.MainActivity'
                        }

--------------------

> 不忘初心，如果您认为这篇文章有价值，认同作者的付出，可以微信二维码打赏任意金额给作者（微信号：cx18375319923）哦，Thanks♪(･ω･)ﾉ
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70 2][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70]: /images/20220330/e53462de0d7c4ba7915d72545c652c35.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70 1]: /images/20220330/199f71f3a39344e59bfd394593d6c39d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N4MjQzNjk4_size_16_color_FFFFFF_t_70 2]: /images/20220330/4542dab7ce004bde8e5e4aa27c1c36f1.png