Compose レイアウトをテストする

アプリの UI をテストして、Compose コードの動作が正しいことを確認します。これにより、エラーを早期に発見し、アプリの品質を向上させることができます。

Compose には、要素の検索、属性の検証、ユーザー アクションの実行を行うための一連のテスト API が用意されています。この API には、時刻の操作などの高度な機能も含まれています。これらの API を使用して、アプリの動作を検証する堅牢なテストを作成します。

視聴回数

Compose ではなくビューを使用している場合は、一般的な Android でアプリをテストするをご覧ください。

特に、UI テストの自動化ガイドから始めることをおすすめします。ここでは、ビューを使用する場合を含め、デバイス上で実行されるテストを自動化する方法について説明します。

主な概念

Compose コードをテストする主なコンセプトは次のとおりです。

  • セマンティクス: Compose テストは、セマンティクスを使用して UI とやり取りします。セマンティクスは UI の一部に意味を持ち、UI 階層に沿って生成されます。
  • テスト API: Compose には、要素の検出、状態とプロパティに関するアサーションの作成、ユーザー操作をシミュレートするアクションの実行を行うためのテスト API が用意されています。
  • 同期: デフォルトでは、Compose テストは UI と自動的に同期します。UI がアイドル状態になるのを待ってから、アサーションやアクションを実行します。
  • 相互運用性: ハイブリッド アプリでは、テストで Compose ベースとビューベースの要素の両方をシームレスに操作し、他のテスト フレームワークと統合できます。

テスト早見表

Compose でのテストで学習すべき主なトピックの概要については、テストのクイック リファレンスをご覧ください。

セットアップ

Compose コードをテストできるようにアプリを設定します。

まず、UI テストを含むモジュールの build.gradle ファイルに次の依存関係を追加します。

// Test rules and transitive dependencies:
androidTestImplementation("androidx.compose.ui:ui-test-junit4:$compose_version")
// Needed for createComposeRule(), but not for createAndroidComposeRule<YourActivity>():
debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version")

このモジュールには、ComposeTestRule と、AndroidComposeTestRule と呼ばれる Android の実装が含まれています。このルールにより、Compose のコンテンツを設定したり、アクティビティにアクセスしたりできます。ルールは、ファクトリ関数（createComposeRule）または（アクティビティにアクセスする必要がある場合は createAndroidComposeRule）を使用して作成します。Compose の一般的な UI テストは次のようになります。

// file: app/src/androidTest/java/com/package/MyComposeTest.kt

class MyComposeTest {

    @get:Rule val composeTestRule = createComposeRule()
    // use createAndroidComposeRule<YourActivity>() if you need access to
    // an activity

    @Test
    fun myTest() {
        // Start the app
        composeTestRule.setContent {
            MyAppTheme {
                MainScreen(uiState = fakeUiState, /*...*/)
            }
        }

        composeTestRule.onNodeWithText("Continue").performClick()

        composeTestRule.onNodeWithText("Welcome").assertIsDisplayed()
    }
}

参考情報

  • Android でアプリをテストする: Android のテストのメインランディング ページでは、テストの基礎と手法について幅広い情報を確認できます。
  • テストの基礎: Android アプリのテストの基本コンセプトについて学びます。
  • ローカルテスト: 一部のテストは、自分のワークステーションのローカルに実行できます。
  • インストルメンテーション テスト: インストルメンテーション テストも実行することをおすすめします。つまり、デバイス上で直接実行されるテストです。
  • 継続的インテグレーション: 継続的インテグレーションにより、テストをデプロイ パイプラインに統合できます。
  • さまざまな画面サイズをテストする: ユーザーが利用できるデバイスが多いため、さまざまな画面サイズでテストする必要があります。
  • Espresso: Espresso の知識はビューベースの UI を対象としていますが、Compose のテストのいくつかの側面においても役立ちます。

Codelab

詳細については、Jetpack Compose テストの Codelab をご覧ください。

サンプル