パラメーター
testrunファイルやtestConfigファイルで以下のパラメーターを設定することができます。
[type] R: tesrunファイル, C: testConfigファイル
| カテゴリ | プロパティ | 説明 | デフォルト | type | 備考 |
|---|---|---|---|---|---|
| OS | os | “android” または “ios” | android | R | |
| Config | android.configFile | testConfigファイル(android用) | R | ||
| Config | android.profile | プロファイル(android用) | R | ||
| Config | ios.configFile | testConfigファイル(iOS用) | R | ||
| Config | ios.profile | プロファイル(iOS用) | R | ||
| Stub | stubServerUrl | スタブサーバーのURL | R/C | ||
| Test mode | noLoadRun | 無負荷実行モード(NLR)を有効にする | false | R/C | |
| Priority | must | false: @mustを付与したテスト関数の実行をスキップする |
true | R | |
| Priority | should | false: @shouldを付与したテスト関数の実行をスキップする |
true | R | |
| Priority | want | false: @wantを付与したテスト関数の実行をスキップする |
true | R | |
| Priority | none | false: priorityを付与していないテスト関数の実行をスキップ | true | R | |
| Log | logLanguage | ログ出力の言語 | ""(empty) | R | Default(empty) is English. “ja” is supported |
| Log | enableSyncLog | 同期ログを出力する | true | R | |
| Log | enableTestList | TestList.xlsを出力する | true | R | |
| Log | enableTestClassList | TestClassList.txtを出力する | true | R | |
| Log | enableSpecReport | Spec-Reportを出力する | true | R | |
| Log | enableRelativeCommandTranslation | 相対コマンドを翻訳する | true | R | |
| Log | enableInnerMacroLog | マクロ内部でログを出力する | false | R | For debugging |
| Log | enableInnerCommandLog | コマンド内部でログを出力する | false | R | For debugging |
| Log | enableSilentLog | silent関数内でログを出力する | false | R | For debugging |
| Log | enableTapElementImageLog | タップされた要素の画像を保存する | false | R | For debugging |
| Log | enableXmlSourceDump | XmlSourceDumpの出力を有効にする | true | R | For debugging |
| Log | enableRetryLog | リトライ実行時にinfoログを出力する | true | R | For debugging |
| Log | enableWarnOnRetryError | リトライでエラーになった場合にwarnログを出力する。falseに設定した場合はinfoログを出力する | false | R | For debugging |
| Log | enableWarnOnSelectTimeout | selectでタイムアウトになった場合にwarnログを出力する。falseに設定した場合はinfoログを出力する | false | R | For debugging |
| Log | enableGetSourceLog | getSource実行時にログを出力する | false | R | For debugging |
| Log | enableTrace | traceログを出力する | false | R | For debugging |
| Log | enableTimeMeasureLog | 時間計測ログを出力する | false | R | For debugging |
| Log | enableShellExecLog | Shellコマンド実行時にログを出力する | false | R | For debugging |
| Log | enableImageMatchDebugLog | 画像マッチングのデバッグログを出力する | false | R | For debugging |
| Log | enableIsInViewLog | isInViewログを出力する | false | R | For debugging |
| Log | enableIsSafeLog | isSafeログを出力する | true | R | For debugging |
| Log | enableIsScreenLog | isScreenログを出力する | false | R | For debugging |
| Log | testResults | テスト結果出力ディレクトリのパス | (userhome)/Downloads/TestResults | R | |
| Log | testListDir | TestList.xlsxを出力するディレクトリのパス | ""(empty) | R | |
| Log | reportIndexDir | report index(html)を出力するディレクトリのパス | ""(empty) | R | |
| String Comparing | strictCompareMode | 文字列比較を厳密モード（最適化なし）で行う | false | R | |
| String Comparing | keepZenkakuSpace | 文字列比較において全角スペースを保持する（除去しない） | true | R | |
| String Comparing | keepLF | 文字列比較においてLFを保持する（除去しない） | false | R | |
| String Comparing | keepTAB | 文字列比較においてTABを保持する（除去しない） | false | R | |
| String Comparing | waveDashToFullWidthTilde | 文字列比較においてWAVE_DASHをFULL_WIDTH_TILDEに置換する | true | R | |
| String Comparing | compressWhitespaceCharacters | 文字列比較において複数の空白文字を1つの空白に圧縮する | true | R | |
| String Comparing | trimString | 文字列比較においてトリムを行う | true | R | |
| Screenshot | screenshotScale | スクリーンショットのサイズを縮小する (0.1 to 1.0) | 0.5 | R | |
| Screenshot | screenshotIntervalSeconds | スクリーンショットのインターバル(秒) | 0.5 | R | |
| Screenshot | autoScreenshot | 自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | onChangedOnly | 変更があった場合のみスクリーンショットを取得する | true | R/C | |
| Screenshot | onCondition | condition関数において自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | onAction | action関数において自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | onExpectation | expectation関数において自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | onExecOperateCommand | 操作コマンド(tap, swipe, etc.)の実行前後でスクリーンショットを自動で取得する | true | R/C | |
| Screenshot | onCheckCommand | checkコマンド(screenIs, exist, etc.)実行時に自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | onScrolling | scrollingコマンド(tapWithScrollDown, scanElements, etc.)実行時に自動でスクリーンショットを取得する | true | R/C | |
| Screenshot | manualScreenshot | 手動スクリーンショットを有効にする | true | R/C | |
| Image Matching | enableImageAssertion | 画像検証を有効にする | true | R | |
| Image Matching | imageMatchingScale | マッチング用画像のサイズを縮小する(0 < x <= 1.0) | 0.25 | R | |
| Image Matching | imageMatchingThreshold | 画像マッチングの閾値 | 1.0 | R | |
| Image Matching | imageMatchingCandidateCount | 画像マッチングにおける画像の候補数 | 20 | R | |
| Emulator/Simulator | emulatorOptions | emulatorコマンドのオプション | -no-boot-anim -no-snapshot | R | |
| Emulator/Simulator | emulatorPort | emulatorのポート番号 | 5554 | R | |
| Emulator/Simulator | deviceStartupTimeoutSeconds | 仮想デバイス開始時のタイムアウト時間（秒） | 60.0 | R/C | |
| Emulator/Simulator | deviceWaitSecondsAfterStartup | 仮想デバイスを開始した後の待ち時間（秒） | 0.0 | R/C | |
| Emulator/Simulator | enableWdaInstallOptimization | WDAインストールを最適化する（秒） | true | R | iOSシミュレーター用 |
| Appium | appiumServerUrl | Appium serverのURL | (mandatory) | R/C | ex. http://127.0.0.1:4720/ |
| Appium | appiumPath | appiumコマンド（またはそのパス） | R/C | ||
| Appium | appiumArgs | appiumコマンドの引数。セパレーター使用可能 | R/C | ||
| Appium | appiumArgsSeparator | appiumArgsで使用するセパレーター | " " (space) | R/C | |
| Appium | appiumServerStartupTimeoutSeconds | Appium Serverを開始する際のタイムアウト時間（秒） | 30.0 | R/C | |
| Appium | appiumSessionStartupTimeoutSeconds | Appiumのセッションが開始際のタイムアウト時間（秒） | 30.0 | R/C | |
| Appium | implicitlyWaitSeconds | デフォルトのタイムアウト時間(秒) | 5.0 | R/C | |
| Appium | capabilities | AppiumDriverのDesired capabilities | (mandatory) | C | |
| Appium | appPackageFile | インストールするパッケージファイル | R/C | ||
| Appium | appPackageDir | パッケージファイルが配置されるディレクトリ | (userhome)/Downloads | R/C | |
| Appium | packageOrBundleId | テスト対象アプリのpackage(Android) または bundleId(iOS) | (mandatory) | R/C | |
| Appium | startupPackageOrBundleId | 開始時のアプリのpackage(Android) または bundleId(iOS) | R/C | ||
| Appium | startupActivity | 開始時のアプリのアクティビティ(Android) | (mandatory) | R/C | |
| Appium | enforceXPath1 | XPath 1.0を使用する(Android) | true | R/C | |
| Appium Proxy | appiumProxyReadTimeoutSeconds | AppiumProxyのRead timeout（秒） | 20.0 | R/C | |
| Appium Proxy | appiumProxyGetSourceTimeoutSeconds | AppiumProxyのgetSource timeout（秒） | 60.0 | R/C | |
| TestDriver | reuseDriver | TestDriverインスタンスの再利用 | true | R/C | |
| TestDriver | retryMaxCount | リトライ最大回数 | 2 | R/C | |
| TestDriver | retryTimeoutSeconds | リトライ時のタイムアウト時間（秒） | 15.0 | R/C | |
| TestDriver | retryIntervalSeconds | リトライ間隔（秒） | 2.0 | R/C | |
| TestDriver | enableHealthCheck | TestDriverを初期化する際にヘルスチェックを実行する(Androidのみ) | true | R | |
| TestDriver | tapTestSelector | ヘルスチェックでTapのテストを実行する際のselector | .label | R | |
| TestDriver | enableAutoSyncAndroid | 自動同期(Android) trueにすると要素取得の精度が向上。パフォーマンス上の問題から falseを推奨 |
false | R | |
| TestDriver | enableAutoSyncIos | 自動同期(iOS) trueにすると要素取得の精度が向上。パフォーマンス上の問題から falseを推奨 |
false | R | |
| TestDriver | enableLaunchOnScenario | シナリオ開始時にアプリを起動する | true | R | |
| TestDriver | launchAppMethod | launchApp関数の実行方法。shell: adb または xcrun tapAppIcon: 組み込みのタップ動作 [macro name]: 例) [My Launch Macro] |
auto | R | shellはデバイスに依存しないが不安定 tapAppIconはデバイスに依存するが安定 [macro name]はカスタマイズ可能 |
| TestDriver | enableRerunScenario | 回復可能なエラーの場合にシナリオを再実行する | true | R | |
| TestDriver | enableAlwaysRerunOnErrorAndroid | エラー時は常に再実行する(Android) | false | R | |
| TestDriver | enableAlwaysRerunOnErrorIos | エラー時は常に再実行する(iOS) | false | R | |
| TestDriver | scenarioTimeoutSeconds | シナリオのタイムアウト（秒）(0以上) | 90 | R | |
| TestDriver | scenarioMaxCount | シナリオの最大試行回数 (1以上) | 3 | R | |
| TestDriver | enableRerunOnScreenshotBlackout | 画面がブラックアウトした場合に再実行する | true | R | |
| TestDriver | screenshotBlackoutThreshold | 画面がブラックアウトしたと判断する閾値 (0.9 to 1.0) | 0.995 | R | |
| TestDriver | enableRestartDeviceOnResettingAppiumSession | Appiumのセッションをリセットするときにデバイスを再起動する。（emulator/simulatorのみサポート） | false | R | |
| TestDriver | safeCpuLoad | CPU負荷の安全値（%） | 70 | R | |
| TestDriver | enableWaitCpuLoad | CPU負荷がsafeCpuLoadより小さくなるのを待つ | true | R | |
| TestDriver | enableWaitCpuLoadPrintDebug | enableWaitCpuLoadにおいてデバッグ出力を有効にする | false | R | |
| App operation | appIconName | アプリのアイコン名 | R/C | ||
| App operation | tapAppIconMethod | tapApp関数のモード “auto”, “googlePixel”, “swipeLeftInHome” | auto | R/C | |
| App operation | tapAppIconMacro | tapApp関数で実行するマクロ名 | R/C | ||
| App operation | shortWaitSeconds | 関数実行時のデフォルトの待ち時間（秒） | 1.5 | R/C | |
| App operation | waitSecondsForLaunchAppComplete | launchApp関数が完了するまでのデフォルトの待ち時間（秒） | 15.0 | R/C | |
| App operation | waitSecondsForAnimationComplete | アニメーションが完了するまでのデフォルトの待ち時間（秒） | 0.5 | R/C | |
| App operation | waitSecondsOnIsScreen | 画面表示におけるデフォルトの待ち時間（秒） | 15.0 | R/C | |
| App operation | waitSecondsForConnectionEnabled | ネットワーク再接続時のデフォルトの待ち時間（秒） | 8.0 | R/C | |
| App operation | swipeDurationSeconds | Swipeの継続時間（秒） | 3.0 | R/C | |
| App operation | flickDurationSeconds | Flickの継続時間（秒） | 0.3 | R/C | |
| App operation | swipeMarginRatio | swipeにおけるマージンの比率 | 0.0 | R/C | Consider momentum scrolling |
| App operation | scrollVerticalStartMarginRatio | 縦スクロールにおける開始マージンの比率 | 0.15 | R/C | |
| App operation | scrollVerticalEndMarginRatio | 縦スクロールにおける終了マージンの比率 | 0.1 | R/C | |
| App operation | scrollHorizontalStartMarginRatio | 横スクロールにおける開始マージンの比率 | 0.2 | R/C | |
| App operation | scrollHorizontalEndMarginRatio | 横スクロールにおける終了マージンの比率 | 0.1 | R/C | |
| App operation | scrollToEdgeBoost | エッジへのスクロール時の1アクションにおけるスワイプの回数 | 1 | R/C | |
| App operation | scrollIntervalSeconds | 次のスクロールを実行する前のインターバル（秒） | 0.5 | R/C | |
| App operation | scrollMaxCount | スクロールの最大回数 | 20 | R/C | |
| App operation | tapHoldSeconds | Tapにおけるホールド継続時間（秒） | 0.0 | R/C | |
| App operation | enableCache | キャッシュを有効にする | true | R/C | |
| App operation | findWebElementTimeoutSeconds | findWebElementのデフォルトの待ち時間（秒） | 0.2 | R/C | |
| App operation | syncWaitSeconds | 同期における待ち時間（秒） | 1.8 | R/C | |
| App operation | syncMaxLoopCount | 同期における最大ループ数 | 5 | R/C | |
| App operation | syncIntervalSeconds | 同期におけるインターバル（秒） | 0.5 | R/C | |
| Custom | CustomObject.scan.dir | カスタムオブジェクトの探索先ディレクトリ | src/test/kotlin | R | |
| Macro | MacroObject.scan.dir | マクロオブジェクトの探索先ディレクトリ | src/test/kotlin | R | |
| Special Tags | specialTags | テスト用デバイス向けの分岐で使用する任意のタグ | C | ||
| Spec-Report | specReport.exclude.detail | Spec-Reportの詳細チェック項目を除外する | false | R | |
| Spec-Report | specReport.SKIP.reason | SKIPの理由を「実施結果の補足」欄に設定する | R | ||
| Spec-Report | specReport.EXCLUDED.reason | EXCLUDEDの理由を「実施結果の補足」欄に設定する | R | ||
| misc | android.swipeOffsetY | Adjust y coordinate on swipe(for Android) | -20 | R | For framework developer |
| misc | ios.swipeOffsetY | Adjust y coordinate on swipe(for iOS) | -5 | R | For framework developer |
| misc | xmlSourceRemovePattern | Regex pattern for characters to remove | R | For framework developer | |
| misc | boundsToRectRatio | Conversion ratio of bounds information to bitmap coordinate | “1”(Android), “3”(iOS) | R/C | Depends on retina display |
| misc | selectIgnoreTypes | Ignores on selecting by default. This is optimization for iOS | XCUIElementTypeCell, XCUIElementTypeApplication | R | For framework developer |
| misc | titleSelector | Selector template for screen title | R | For framework developer | |
| misc | webTitleSelector | Selector template for web title | R | For framework developer | |
| misc | jquerySource | URL for jQuery javascript file | R | For framework developer |
Path macro
ログディレクトリには Path macro を使用することができます。
| Path macro | description | Usage |
|---|---|---|
{USER_HOME} |
ユーザーのホームディレクトリ | testResults={USER_HOME}/dir1 |
{DOWNLOADS} |
Downloadsディレクトリ | testListDir={DOWNLOADS}/dir1 |
{TEST_RESULTS} |
TestResultsディレクトリ | reportIndexDir={TEST_RESULTS}/dir1 |
{DIRECTORY_FOR_TEST_CONFIG} |
TestResults配下のTestConfigディレクトリ | testListDir={DIRECTORY_FOR_TEST_CONFIG}/dir1 |
{DIRECTORY_FOR_LOG} |
TestResults配下のログディレクトリ | reportIndexDir={DIRECTORY_FOR_LOG} |