UI Automator

UI Automator は、システムアプリとインストール済みアプリにまたがるアプリ間の UI 機能テストに適した UI テストフレームワークです。

UI Automator テストフレームワークには、UI テストを作成するための API のセットが用意されており、ユーザーアプリとシステムアプリでインタラクションを実行するテストを実施できます。UI Automator API により、テストデバイス上で設定メニューやアプリランチャーを開くなどのオペレーションが可能になります。UI Automator テストフレームワークでは、テストコードがターゲットアプリの細かい内部実装に依存しておらず、ブラックボックススタイルの自動化テストの作成に適しています。

UI Automator テストフレームワークの主要な機能は次のとおりです。

レイアウト階層を検査するビューア。詳細については、UI Automator ビューアをご覧ください。
ターゲットデバイスの状態情報を取得してオペレーションを実行する API。詳細については、デバイスの状態にアクセスするをご覧ください。
複数のアプリにまたがる UI テストをサポートする API。詳細については、UI Automator API をご覧ください。

UI Automator ビューア

uiautomatorviewer ツールは、Android デバイスに現在表示されている UI コンポーネントをスキャンして分析するのに便利な GUI を備えています。このツールにより、レイアウト階層を検査して、デバイスのフォアグラウンドに表示される UI コンポーネントのプロパティを確認できます。この情報により、UI Automator できめ細かいテストを作成することが可能になります。たとえば、特定の表示プロパティに対応する UI セレクタを作成できます。

uiautomatorviewer ツールは <android-sdk>/tools/bin ディレクトリにあります。

デバイスの状態にアクセスする

UI Automator テストフレームワークには、ターゲットアプリが実行されているデバイスにアクセスしてオペレーションを実行するための UiDevice クラスが用意されています。このクラスのメソッドを呼び出すことにより、その時点でのデバイスの向きや表示サイズなどのデバイスプロパティにアクセスできます。UiDevice クラスにより、次のようなアクションも実行できます。

デバイスの回転を変更する。
「音量大」などのハードウェアキーを押す。
「戻る」ボタン、ホームボタン、メニューボタンをクリックする。
通知シェードを開く。
現在のウィンドウのスクリーンショットを撮る。

たとえば、ホームボタンの押下をシミュレートするには、UiDevice.pressHome() メソッドを呼び出します。

UI Automator API

UI Automator API を使用すると、ターゲットとするアプリの詳細な実装を把握していなくても、堅牢なテストを作成することが可能になります。以下の API により、複数のアプリにまたがる UI コンポーネントをキャプチャして操作できます。

UiCollection: 可視テキストまたは content-description 属性ごとに子要素を数え上げる（またはターゲットにする）目的で、コンテナの UI 要素を列挙します。
UiObject: デバイス上に表示される UI 要素を表します。
UiScrollable: スクロール可能な UI コンテナ内のアイテムの検索をサポートします。
UiSelector: デバイス上にある 1 つ以上のターゲット UI 要素に対するクエリを表します。
Configurator: UI Automator テストを実行するための主要なパラメータを設定できるようにします。

たとえば、次のコードは、デフォルトのアプリランチャーをデバイスに表示するテストスクリプトの作成方法を示しています。

Kotlin

    device = UiDevice.getInstance(getInstrumentation())
    device.pressHome()

    // Bring up the default launcher by searching for a UI component
    // that matches the content description for the launcher button.
    val allAppsButton: UIObject = device.findObject(
            UiSelector().description("Apps"))

    // Perform a click on the button to load the launcher.
    allAppsButton.clickAndWaitForNewWindow()

Java

    device = UiDevice.getInstance(getInstrumentation());
    device.pressHome();

    // Bring up the default launcher by searching for a UI component
    // that matches the content description for the launcher button.
    UiObject allAppsButton = device
            .findObject(new UiSelector().description("Apps"));

    // Perform a click on the button to load the launcher.
    allAppsButton.clickAndWaitForNewWindow();

UI Automator の使用方法の詳細については、API リファレンスと、複数のアプリの UI をテストするガイドをご覧ください。

参考情報

Android テストで UI Automator を使用する方法の詳細については、次のリソースをご覧ください。

サンプル

BasicSample: UI Automator の基本的なサンプルです。