Test Uiautomator

  
アプリ間の UI 機能テストのフレームワーク
最新の更新 安定版リリース リリース候補版 ベータ版リリース アルファ版リリース
2025 年 5 月 7 日 2.3.0 - - 2.4.0-alpha02

依存関係の宣言

test への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。

アプリまたはモジュールの build.gradle ファイルに、必要なアーティファクトの依存関係を追加します。

Groovy

dependencies {
    // Use to implement UIAutomator tests
    androidTestImplementation "androidx.test.uiautomator:uiautomator:2.4.0-alpha02"
}

Kotlin

dependencies {
    // Use to implement UIAutomator tests
    androidTestImplementation("androidx.test.uiautomator:uiautomator:2.4.0-alpha02")
}

依存関係について詳しくは、ビルド依存関係の追加をご覧ください。

フィードバック

お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。

新しい問題を報告する

詳細については、Issue Tracker のドキュメントをご覧ください。

バージョン 2.4

バージョン 2.4.0-alpha02

2025 年 5 月 7 日

androidx.test.uiautomator:uiautomator:2.4.0-alpha02 がリリースされました。バージョン 2.4.0-alpha02 には、これらの commit が含まれています。

新機能

  • 新しい Uiautomator Api の初期形状。UiAutomatorTestScope は、新しい onView API にアクセスできるファクトリ uiAutomator を使用して作成できます。
  • AccessibilityNodeInfo#getText の使用について警告し、textAsString の使用を提案する最初の lint ルール。

API の変更

  • Configurator#setDefaultDisplayId を追加して、すべての検索を（Icdf17）に制限するディスプレイ ID を設定できるようにしました。
  • 便利にするため、Searchable（UiDevice と UiObject2 で共有されるインターフェース）を公開にしました。（I67f18）

バグの修正

  • UiDevice#pressKeyCodes でのメタキーの処理を修正しました。（I73f80）。
  • 常にルートを Z 順序で返すように UiDevice#getWindowRoots を更新しました。（I87426）
  • 特定のジェスチャーが完了しない問題を修正しました（I60dd3、If4edd）。
  • UiDevice#scrollUntil の呼び出し時にまれに発生する無限ループを修正しました。（I39989）

バージョン 2.4.0-alpha01

2024 年 6 月 26 日

androidx.test.uiautomator:uiautomator:2.4.0-alpha01 がリリースされました。バージョン 2.4.0-alpha01 には、これらの commit が含まれています。

API の変更

  • Configurator#getKeyInjectionDelay と setKeyInjectionDelay のサポートを終了しました。テキストはキー入力ではなく常に直接挿入されるため、このパラメータは使用されなくなりました。（I3bcc5）。

バグの修正

  • 動的リフレッシュ レート（スムーズ ディスプレイなど）を考慮して、UiObject2 モーション イベント間の遅延を更新しました（I43f12）。
  • ユーザー補助キャッシュを定期的に無効にすることで、特定の UI でユーザー補助ノードの古さによる不安定さを軽減しました（I3be25）。
  • 古い UiObject2 で toString または hashCode を呼び出すときに発生する StaleObjectException を修正しました。（I38ea1）。
  • 不要な waitForIdle 呼び出しをスキップすることで、UiWatcher のパフォーマンスを改善しました。（I8c65e）。
  • 特に、各 Configurator パラメータが使用されるタイミングを明確にするために、javadoc の不正確さを修正しました。（Ie10b1、I71631）。

バージョン 2.3.0

バージョン 2.3.0

2024 年 2 月 21 日

androidx.test.uiautomator:uiautomator:2.3.0 がリリースされました。バージョン 2.3.0 に含まれる commit については、こちらをご覧ください。

2.2.0 以降の重要な変更

  • マルチディスプレイのサポート: 複数のディスプレイにわたるオブジェクトの検索と操作のサポート、およびセカンダリ ディスプレイを管理する UiDevice メソッドを追加しました（Ie6544、I912cd）。
  • 新しいセレクタ:
    • ディスプレイ ID でオブジェクトを選択する By.displayId を追加しました（I1825b）。
    • 親に応じてオブジェクトを選択するための By.hasParent と By.hasAncestor を追加しました（I93c36）。
    • ヒントテキストでオブジェクトを選択する By.hint メソッドを追加しました（Idd345）。
  • カスタム条件: カスタム待機条件をサポートする Condition インターフェースを公開し、対応する UiDevice#wait、UiObject2#wait、UiObject2#scrollUntil メソッドを追加しました（27c0ea、099d6e）。
  • バグの修正と信頼性
    • ディスプレイ サイズの計算が不正確になることがあり、画面の一部が無視される問題を修正しました。（Ifc016）テストで使用する座標とオフセットを調整する必要がある場合があります。
    • MotionEvent 挿入を更新し、精度を向上させ（678ca3）、ユーザー操作を適切にエミュレートしました。（454450）
    • スクロール（I7b059）、回転（c6cea0）、長押し（49572b）、ピンチ（3c619a）などの信頼性を改善しました。

バージョン 2.3.0-rc01

2024 年 2 月 7 日

androidx.test.uiautomator:uiautomator:2.3.0-rc01 がリリースされました。変更はありません。バージョン 2.3.0-rc01 に含まれる commit については、こちらをご覧ください。

バージョン 2.3.0-beta01

2023 年 12 月 13 日

androidx.test.uiautomator:uiautomator:2.3.0-beta01 がリリースされました。バージョン 2.3.0-beta01 に含まれる commit については、こちらをご覧ください。

API の変更

  • 整合性を確保するため、UiObject2 のパーセンテージベースの余白メソッドの名前を setGestureMarginPercentage と setGestureMarginsPercentage に変更しました。（I24435）

バグの修正

  • セカンダリ ディスプレイが見つからない場合やアクセスできない場合にスローされるエラーを改善しました。（116b23）

バージョン 2.3.0-alpha05

2023 年 11 月 1 日

androidx.test.uiautomator:uiautomator:2.3.0-alpha05 がリリースされました。バージョン 2.3.0-alpha05 に含まれる commit については、こちらをご覧ください。

API の変更

  • 描画順序（z インデックス）情報を公開する UiObject2#getDrawingOrder を追加しました。（I5dfa4）。
  • セカンダリ ディスプレイの回転を取得、設定、フリーズ、フリーズ解除する UiDevice メソッドを追加しました。（I912cd）。

バグの修正

  • スクロールの終了を検出できなかった場合に UiObject2#scrollUntil に再試行を追加しました（Ibac6f）。
  • UiDevice が再作成された場合に古い Instrumentation インスタンスを使用する問題を修正しました（I18cae）。
  • ノードのダンプ時にディスプレイ ID を特定できない場合に NPE が発生する可能性がある問題を修正しました（Icafcb）。
  • クリック不可/スクロール不可のオブジェクトでクリック/スクロールを実行する際の警告を追加しました（I4a5d9）。
  • 信頼性を向上させるため、デフォルトの UiObject2 スクロール速度を低下させました（I5e071）。

バージョン 2.3.0-alpha04

2023 年 7 月 26 日

androidx.test.uiautomator:uiautomator:2.3.0-alpha04 がリリースされました。バージョン 2.3.0-alpha04 に含まれる commit については、こちらをご覧ください。

API の変更

  • By.hasParent と By.hasAncestor を追加し、親に応じたオブジェクトの検索をサポートしました（I93c36）。
  • オブジェクトのヒント テキストを取得する UiObject2#getHint と、ヒント テキストに従ってオブジェクトを選択する By.hint メソッドを追加しました（Idd345）。
  • By.displayId を追加し、表示されているディスプレイに応じてオブジェクトを選択できるようにしました（I1825b）。
  • ディスプレイの ID（Ie6544）でディスプレイのサイズを検索する UiDevice#getDisplayHeight(int) メソッドと UiDevice#getDisplayWidth(int) メソッドを追加しました。
  • 下位互換性を確保するため、wait(SearchCondition, long) メソッドと wait(UiObject2Condition, long) メソッドを再度追加しました。（Iebfda）
  • UiDevice#executeShellCommand を非表示ではなく公開（推奨されない）に変更しました（Ic48a1）。

バグの修正

  • MotionEvent 挿入を更新し、速度よりもジェスチャーの精度を優先することで、不安定性を軽減しました。（678ca3）
  • リソース使用量の多いメソッドにトレースを追加し、パフォーマンスのボトルネックを特定できるようにしました（d17de3）。
  • UiAutomation 接続の開始時に再試行メカニズムを追加しました（048caf）。
  • UiDevice#dumpWindowHierarchy の null ノードによる NPE の可能性を修正しました（b725eb）。
  • 限定公開ディスプレイのクエリまたは操作で発生する予期しないエラーを修正しました。（985db6、7053d4）

バージョン 2.3.0-alpha03

2023 年 4 月 19 日

androidx.test.uiautomator:uiautomator:2.3.0-alpha03 がリリースされました。バージョン 2.3.0-alpha03 に含まれる commit については、こちらをご覧ください。

API の変更

  • Until の組み込みにのみ依存するのではなく、カスタムの待機条件を許可するように Condition インターフェースを公開し、このインターフェースを受け取れるように UiDevice#wait メソッドと UiObject2#wait メソッドを更新しました（27c0ea）。
  • 条件が満たされるまでスクロールをサポートし、UiScrollable との互換性を維持するために UiObject2#scrollUntil を追加しました。（099d6e）
  • デバイスタイプ間での回転を容易にするため、UiDevice#setOrientationPortrait と setOrientationLandscape を追加しました（e13cb7）。
  • オブジェクトのサイズを基準としたマージンの設定をサポートするために UiObject2#setGestureMarginPercent を追加しました。（Ib8c77）

バグの修正

  • SDK 18 ～ 22 で無効な座標が使用されることがある UiScrollable メソッドを修正しました。（b53ece）
  • SDK 18 と 19 で UiObject2#setText と clearText がテキストを変更できない問題を修正しました（77e41d）。
  • UiWatcher が正しい順序で実行されない問題を修正しました（c85f92）。
  • UiDevice の向きの変更後にデバイスの回転が完了しないことがある問題を修正しました。（c6cea0）
  • 長押し、ドラッグ、ピンチの信頼性を改善しました。（49572b、3c619a）

バージョン 2.3.0-alpha02

2023 年 1 月 11 日

androidx.test.uiautomator:uiautomator:2.3.0-alpha02 がリリースされました。バージョン 2.3.0-alpha02 に含まれる commit については、こちらをご覧ください。

API の変更

  • より多くの情報を提供し、発生する可能性のある問題を警告し、整合性を改善するよう、ライブラリ全体でロギングを再構築しました。
  • 複数のキーを同時に押す操作（POWER と VOLUME_DOWN を押してスクリーンショットを撮るなど）をサポートするため UiDevice#pressKeyCodes を追加しました。（22e525）
  • メソッド名のスペルミスを修正するため、UiDevice#setCompressedLayoutHierarchy を追加して UiDevice#setCompressedLayoutHeirarchy を非推奨にしました。（4e2f65）
  • 非推奨になった UiAutomatorTestCase を処理していて不要であるため、UiAutomatorInstrumentationTestRunner を非推奨としてマークしました。（be6c85）
  • ディスプレイのリフレッシュ レートを 2 倍にしてユーザー操作を適切にエミュレートするよう UiObject2 MotionEvent 間の遅延を更新しました。（454450）
  • 複数行のテキストと説明の一致のサポートを追加しました。（1625e6、b/255787130）

バグの修正

  • オブジェクトのクエリ中または待機中に StaleObjectException がスローされることがある問題を修正しました。（4cbcc0）
  • UiScrollable#scrollToBeginning、scrollToEnd、flingToBeginning、flingToEnd の戻り値が、開始 / 終了に達したかどうかを示さない問題を修正しました。（d33e06）
  • UiScrollable#scrollForward と scrollBackward のメソッドが設定済みのタイムアウトを無視する問題を修正しました。（29e4f3）
  • BySelector コピー コンストラクタがデプスセレクタを処理しない問題を修正しました。（6c7b91）
  • UiObject#pinchIn と pinchOut での無効なパーセント値の処理を修正しました。（01b973）
  • 基盤となる UiAutomation 接続がリセットされるとマルチウィンドウ サポートが失われるというまれな問題を修正しました。（1bb956）

バージョン 2.3.0-alpha01

2022 年 9 月 7 日

androidx.test.uiautomator:uiautomator:2.3.0-alpha01 がリリースされました。バージョン 2.3.0-alpha01 に含まれる commit については、こちらをご覧ください。

API の変更

  • すべてのパブリック メソッドの null 可能性にアノテーションを付けました。
  • UiObject2 ジェスチャーを滑らかにするために MotionEvent の挿入を非同期に切り替え、短い遅延を加えました。
  • 待機中のポーリング間隔を 1,000 ミリ秒から 100 ミリ秒に短縮しました。
  • 電源ボタンをオーバーライドするデバイスを KEYCODE_WAKEUP と KEYCODE_SLEEP を使用してサポートするように UiDevice#wakeUp と UiDevice#sleep を更新しました。
  • UiObject2#getDisplayId を追加し、複数のディスプレイにわたるオブジェクトの検索と管理をサポートしました。
  • 座標を使用してポイントをクリックできるように、UiObject#click メソッドと UiObject2#clickAndWait メソッドを追加しました。

バグの修正

  • 特にマルチウィンドウ モードで、ディスプレイ サイズの計算が不正確になることがあり、画面の一部が無視される問題を修正しました。（Ifc016c）
  • UiDevice#takeScreenshot でのスクリーンショットのスケーリングを修正しました。（Id80ad6）
  • Until.scrollFinished と UiObject2#scroll の信頼性を改善しました。（I7b0595）
  • 厳格モードの IncorrectContextUseViolation 警告を修正しました。（Iffa6a0）