Glance を使用した単体テスト

Glance 単体テスト API を使用すると、ビューを拡張したり UI Automator を必要としたりすることなく、Glance コードをテストできます。たとえば、単体テスト API を使用すると、hasContentDescriptionEqualTo や isChecked などのマッチャーを使用して、要素がリストに含まれているかどうかや、ボックスがチェックされているかどうかなどの条件を検証できます。

この API は軽量で、設定が少なくて済むため、ウィジェットの個々の部分を開発し、コードの再利用性を高めるために整理しながら、テスト駆動開発を行うことができます。

設定

単体テスト ライブラリを使用するために必要な依存関係を次の例に示します。

// Other Glance and Compose runtime dependencies.
...
testImplementation 'androidx.glance:glance-testing:1.1.1'
testImplementation 'androidx.glance:glance-appwidget-testing:1.1.1'
...
// You may include additional dependencies, such as Robolectric, if your test
// needs to set a LocalContext.

テストの構造

コードの再利用と単体テストを可能にするため、コンポーザブル関数を GlanceAppWidget クラスの外部で整理します。テスト対象のユニットの複雑さを可能な限り軽減します。

provideComposable でテスト可能なコンポーザブルをターゲットに設定し、onNode または onAllNodes を使用して、1 つまたは複数の Glance ノードで単体テストを実行できます。

private const val FAKE_HEADLINE = "EXTRA! EXTRA! READ ALL ABOUT IT!"

class MyGlanceComposableTest {
    @Test
    fun myNewsItemComposable_largeSize_hasHeadline() = runGlanceAppWidgetUnitTest {
        // Set the composable to test
        provideComposable {
            MyNewsItemComposable(FAKE_HEADLINE)
        }

        // Perform assertions
        onNode(hasTestTag("headline"))
            .assertHasText(FAKE_HEADLINE)
    }


    @Composable
    fun MyNewsItemComposable(headline: String) {
        Row {
            Text(
                text = headline,
                modifier = GlanceModifier.semantics { testTag = "headline" },
            )
        }
    }
}
GlanceUnitTest.kt

テストのコンテキストとサイズを設定する

コンポーザブル関数が LocalContext.current() メソッドを使用してコンテキストを読み取る場合は、setContext() を使用してコンテキストを設定する必要があります。それ以外の場合、この手順は省略可能です。

Robolectric などの JVM ベースの Android 単体テスト フレームワークを使用して、コンテキストを指定できます。

コンポーザブル関数が LocalSize にアクセスする場合は、テストでコンポーザブルを提供する前に、テストの目的のサイズを設定します。デフォルトのサイズは 349 dp x 455 dp で、これは Google Pixel 4 デバイスの縦向きモードで表示される 5x4 ウィジェットに相当します。

• AppWidget が sizeMode == Single を使用している場合は、ウィジェットの info.xml ファイルで minWidth と minHeight に設定できます。
• AppWidget で sizeMode == Exact を使用している場合は、ウィジェットのサイズを決定する方法と同様の方法でテストするサイズを特定し、ウィジェットが表示される可能性のある横向きと縦向きのサイズを特定して、それらのサイズでテストできます。
• AppWidget が sizeMode == Responsive を使用している場合、sizeMode を指定するときに指定したリストのサイズのうちの 1 つに設定できます。

テスト タイムアウトのデフォルトの期間は 1 秒ですが、テスト インフラストラクチャで別のタイムアウトが適用されている場合は、runGlanceAppWidgetUnitTest メソッドの引数としてカスタム期間を渡すことができます。

詳細とコードサンプルについては、runGlanceAppWidgetUnitTest のリファレンス ドキュメントをご覧ください。