轉：DesiredCapabilities內容詳解--Appium服務關鍵字

標籤：

## Appium 服務關鍵字<expand_table>|關鍵字|描述|執行個體||----|-----------|-------||`automationName`|你想使用的自動化測試引擎|`Appium` (預設) 或 `Selendroid`||`platformName`|你要測試的手機作業系統|`iOS`, `Android`, 或 `FirefoxOS`||`platformVersion`|手機作業系統版本|例如： `7.1`, `4.4`||`deviceName`|使用的手機類型或模擬器類型|`iPhone Simulator`, `iPad Simulator`, `iPhone Retina 4-inch`, `Android Emulator`, `Galaxy S4`, 等。在 iOS 上，這個關鍵字的值必須是使用 `instruments -s devices` 得到的可使用的裝置名稱之一。在 Android 上，這個關鍵字目前不起作用。||`app`|`.ipa` or `.apk`檔案所在的本地絕對路徑或者遠程路徑,也可以是一個包括兩者之一的`.zip`。 Appium會先嘗試安裝路徑對應的應用在適當的真機或模擬器上。針對Android系統，如果你指定`app-package`和`app-activity`(具體見下面)的話，那麼就可以不指定`app`。 **會與 `browserName` 衝突** |比如`/abs/path/to/my.apk`或`http://myapp.com/app.ipa`||`browserName`|需要進行自動化測試的手機 網頁瀏覽器名稱。如果是對應用進行自動化測試，這個關鍵字的值應為空白。|iOS 系統上可以用 ‘Safari‘ ，Android 系統上可以用 ‘Chrome‘, ‘Chromium‘, 或 ‘Browser‘。||`newCommandTimeout`|設定命令逾時時間，單位：秒。達到逾時時間仍未接收到新的命令時 Appium 會假設用戶端退出然後自動結束會話。|比如 `60`|`autoLaunch`|Appium是否需要自動安裝和啟動應用。預設值`true`|`true`, `false`||`language`|  (Sim/Emu-only) 設定模擬器 ( simulator / emulator ) 的語言。|如： `fr`||`locale`|  (Sim/Emu-only) 設定模擬器 ( simulator / emulator ) 的地區設定。|如： `fr_CA`||`udid`| 串連的物理裝置的唯一裝置標識|如： `1ae203187fc012g`||`orientation`| (Sim/Emu-only) 在一個設定的方向模式中開始測試|`LANDSCAPE` (橫向)  或 `PORTRAIT` (縱向) ||`autoWebview`| 直接轉換到 WebView 上下文。 預設值 `false`、|`true`, `false`||`noReset`|不要在會話前重設應用狀態。預設值`false`。|`true`, `false`||`fullReset`|(iOS) 刪除整個模擬器目錄。(Android) 通過卸載——而不是清空資料——來重設應用狀態。在 Android 上，這也會在會話結束後自動清除被測應用。預設值 `false`|`true`, `false`|### Android特有<expand_table>|關鍵字|描述|執行個體||----|-----------|-------||`appActivity`| 你要從你的應用程式套件中啟動的 Android Activity 名稱。它通常需要在前面添加 `.`  (如：使用`.MainActivity` 而不是 `MainActivity`) |`MainActivity`, `.Settings`||`appPackage`| 你想啟動並執行Android應用的包名|比如`com.example.android.myApp`, `com.android.settings`||`appWaitActivity`| 你想要等待啟動的 Android Activity 名稱|`SplashActivity`||`deviceReadyTimeout`| 設定等待一個模擬器或真機準備就緒的逾時時間|`5`||`androidCoverage`| 用於執行測試的 instrumentation 類。作為命令 `adb shell am instrument -e coverage true -w` 的 `-w` 參數。| `com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation`||`enablePerformanceLogging`| (僅適用於 Chrome 和 webview) 開啟 Chromedriver 的效能日誌。 (預設 `false`) | `true`, `false`||`androidDeviceReadyTimeout`|等待裝置在啟動應用後準備就緒的逾時時間。以秒為單位。|如 `30`||`androidDeviceSocket`|開發工具的 socket 名稱。只有在被測應用是一個使用 Chromium 核心的瀏覽器時需要。 socket 會被瀏覽器開啟，然後 Chromedriver 把它作為開發人員工具來進行串連。|如 `chrome_devtools_remote`||`avd`| 需要啟動的 AVD  (安卓虛擬設備) 名稱。|如 `api19`||`avdLaunchTimeout`| 以毫秒為單位，等待 AVD 啟動並串連到 ADB 的逾時時間。(預設值 `120000`)| `300000`||`avdReadyTimeout`| 以毫秒為單位，等待 AVD 完成啟動動畫的逾時時間。(預設值 `120000`)| `300000`||`avdArgs`| 啟動 AVD 時需要加入的額外的參數。|如 `-netfast`||`useKeystore`| 使用一個自訂的 keystore 來對 apk 進行重簽名。預設值 `false`|`true` or `false`||`keystorePath`| 自訂 keystore 的路徑。預設： ~/.android/debug.keystore|如 `/path/to.keystore`||`keystorePassword`| 自訂 keystore 的密碼。|如 `foo`||`keyAlias`| key 的別名 |如 `androiddebugkey`||`keyPassword`| key 的密碼 |如 `foo`||`chromedriverExecutable`| webdriver 可執行檔的絕對路徑 (如果 Chromium 核心提供了對應的 webdriver， 應該用它代替 Appium 內建的 webdriver) |`/abs/path/to/webdriver`||`autoWebviewTimeout`| 以毫秒為單位，等待 Webview 上下文啟用的時間。預設值 `2000`| 如 `4`||`intentAction`| 用於啟動 activity 的 intent action。 (預設值 `android.intent.action.MAIN`)| 如 `android.intent.action.MAIN`, `android.intent.action.VIEW`||`intentCategory`| 用於啟動 activity 的 intent category。 (預設值 `android.intent.category.LAUNCHER`)  | 如 `android.intent.category.LAUNCHER`, `android.intent.category.APP_CONTACTS`|`intentFlags`| 用於啟動 activity 的標識 ( flags )  (預設值 `0x10200000`)  | 如 `0x10200000`|`optionalIntentArguments`| 用於啟動 activity 的額外 intent 參數。請查看 [Intent 參數](http://developer.android.com/tools/help/adb.html#IntentSpec) | 如 `--esn <EXTRA_KEY>`, `--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE>`|`dontStopAppOnReset`| 在使用 adb 啟動應用時不要停止被測應用的進程。如果被測應用是由另一個錨應用（anchor app）建立的，請把這個參數設定為 `false` 以允許錨應用在使用 adb 啟動被測應用時保持運行。換句話說，當 `dontStopAppOnReset` 設為 `true` 時，我們在 `adb shell am start` 命令中不會包含 `-S` 標誌。如果這個參數沒有被設定或設為 `false`，我們會加入 `-S` 標誌。預設值： `false`| `true` 或 `false`||`unicodeKeyboard`| 使用 Unicode IME。預設值 `false`| `true` 或 `false`||`resetKeyboard`| 在設定了 `unicodeKeyboard` 關鍵字的 Unicode 測試結束後，重設IME到原有狀態。如果單獨使用，將會被忽略。預設值 `false`| `true` 或 `false`||`noSign`| 跳過檢查和對應用進行 debug 簽名的步驟。只能在使用 UiAutomator 時使用，使用 selendroid 是不行。預設值 `false` | `true` 或 `false`||`ignoreUnimportantViews`| 調用 uiautomator 的函數 `setCompressedLayoutHierarchy()`。由於 Accessibility 命令在忽略部分元素的情況下執行速度會加快，這個關鍵字能加快測試執行的速度。被忽略的元素將不能夠被找到，因此這個關鍵字同時也被實現成可以隨時改變的 *設定 ( settings ) * 。預設值 `false` | `true` 或 `false`||`disableAndroidWatchers`| 關閉 android 監測應用無響應（ANR）和崩潰（crash）的監視器，這能夠在 android 裝置/模擬器上減少 cpu 使用量。這個參數只能在使用 UiAutomator 時工作，在使用 selendroid 時無效。預設值： `false`。| `true` 或者 `false`||`chromeOptions`| 允許傳入 chrome driver 使用的 chromeOptions 參數。請查閱 [chromeOptions](https://sites.google.com/a/chromium.org/chromedriver/capabilities) 瞭解更多資訊。| `chromeOptions: {args: [‘--disable-popup-blocking‘]}` |### iOS特有<expand_table>|關鍵字|描述|執行個體||----|-----------|-------||`calendarFormat`| (Sim-only) 為iOS的模擬器設定日曆格式|如 `gregorian` (西曆) ||`bundleId`| 被測應用的 bundle ID 。用於在真實裝置中啟動測試，也用於使用其他需要 bundle ID 的關鍵字啟動測試。在使用 bundle ID 在真實裝置上執行測試時，你可以不提供 `app` 關鍵字，但你必須提供 `udid` 。|如 `io.appium.TestApp`||`udid`| 串連的真實裝置的唯一裝置編號 ( Unique device identifier ) |如 `1ae203187fc012g`||`launchTimeout`| 以毫秒為單位，在 Appium 運行失敗之前設定一個等待 instruments 的時間 |比如： `20000`||`locationServicesEnabled`| (Sim-only) 強制開啟或關閉定位服務。預設值是保持當前模擬器的設定|`true` 或 `false`||`locationServicesAuthorized`| (Sim-only) 通過修改 plist 檔案設定是否允許應用使用定位服務，從而避免定位服務的警告出現。預設值是保持當前模擬器的設定。請注意在使用這個關鍵字時，你同時需要使用 `bundleId` 關鍵字來發送你的應用的 bundle ID。|`true` 或者 `false`||`autoAcceptAlerts`| 當 iOS 的個人資訊訪問警告 (如 位置、連絡人、圖片) 出現時，自動選擇接受( Accept )。預設值 `false`。|`true` 或者 `false`||`autoDismissAlerts`| 當 iOS 的個人資訊訪問警告 (如 位置、連絡人、圖片) 出現時，自動選擇不接受( Dismiss )。預設值 `false`。|`true` 或者 `false`||`nativeInstrumentsLib`| 使用原生 intruments 庫 (即關閉 instruments-without-delay ) |`true` 或者 `false`||`nativeWebTap`| (Sim-only) 在Safari中允許"真實的"，非基於 javascript 的 web 點擊 (tap) 。 預設值： `false`。注意：取決於 viewport 大小/比例， 點擊操作不一定能精確地點中對應的元素。|`true` 或者 `false`||`safariInitialUrl`| (Sim-only) (>= 8.1) Safari 的初始地址。預設值是一個本地的歡迎頁面 | 例如： `https://www.github.com` ||`safariAllowPopups`| (Sim-only) 允許 javascript 在 Safari 中建立新視窗。預設保持模擬器當前設定。|`true` 或者 `false`||`safariIgnoreFraudWarning`| (Sim-only) 阻止 Safari 顯示此網站可能存在風險的警告。預設保持瀏覽器當前設定。|`true` 或者 `false`||`safariOpenLinksInBackground`| (Sim-only) Safari 是否允許連結在新視窗開啟。預設保持瀏覽器當前設定。|`true` 或者 `false`||`keepKeyChains`| (Sim-only) 當 Appium 會話開始/結束時是否保留存放密碼存放記錄 (keychains)  (庫(Library)/鑰匙串(Keychains)) |`true` 或者 `false`||`localizableStringsDir`| 從哪裡尋找本地化字串。預設值 `en.lproj`|`en.lproj`||`processArguments`| 通過 instruments 傳遞到 AUT 的參數 |如 `-myflag`||`interKeyDelay`| 以毫秒為單位，按下每一個按鍵之間的延遲時間。|如 `100`||`showIOSLog`| 是否在 Appium 的日誌中顯示裝置的日誌。預設值 `false`|`true` 或者 `false`||`sendKeyStrategy`| 輸入文字到文字框的策略。模擬器預設值：`oneByOne` (一個接著一個) 。真實裝置預設值：`grouped` (分組輸入)  |`oneByOne`, `grouped` 或 `setValue`||`screenshotWaitTimeout`| 以秒為單位，產生螢幕的最長等待時間。預設值： 10。 |如 `5`||`waitForAppScript`| 用於判斷 "應用是否被啟動” 的 iOS 自動化指令碼代碼。預設情況下系統等待直到頁面內容非空。結果必須是布爾類型。 |例如 `true;`, `target.elements().length > 0;`, `$.delay(5000); true;` |

轉：DesiredCapabilities內容詳解--Appium服務關鍵字