Compose UIテストを使った統合テスト

DeNAさん主催の「Android Test Night #10」で発表したセッションスライドです。

Transcript

1. MA ZDA MO TO R CO RPORA TI ON Confident ial 納庄 宏明 マツダ株式会社 Compose UIテストを使った統合テスト Data LayerからUIまで繋げてテストする 2024/12/12
2. 自己紹介 •納庄 宏明 Nosho Hiroaki •マツダ株式会社, Android Engineer 2022〜 •自動車関係のiOS/Androidアプリを公開中 •広島、東京、リモート •人材募集中
3. 統合テストとは •定義は難しいので、今回はざっくり単体テストと E2Eテストの間にあるテストを扱う、とします （厳密な統合テストの定義ではない） •多くのクラスやレイヤーをまたぐ •RobolectricやInstrumented Test •通信は発生しない •CIで自動化 •ユーザー操作を伴ったUIをテスト •メリット •忠実度の高いテストができる •忠実度：テスト環境と本番環境の類似度 E2E 統合テスト 単体テスト コスト 忠実性 速度 決定性
4. 忠実度の高いテスト テスト境界は モックなどの テストダブル テスト システムの 入出力を テスト UI ViewModel UseCase/Data Database Androidアプリ 自社API、外部サービス テスト テスト テスト 忠実度の高いテスト 忠実度の低いテスト UI ViewModel UseCase/Data Database テストダブルは 最小限 リファクタリングしやすくなり、バグ発生を未然に防げる 自社API、外部サービス 有利（内部実装に結びつかない） リファクタリングへの耐性 退行に対する保護 有利（通るコードが多い） 忠実度の高いテスト は
5. 統合テストはますます重要 •作って終わりでなく、変更・改善し続ける必要がある •リファクタリングや退行に対する保護 •使いやすいUIが求められる •開発者にとって複雑になりやすくUIを含んだテストが必要 •タスク指向UI→オブジェクト指向UI
6. •時間がかかる •保守のコストがかかる •通るコードが長くテストの問題が見つけづらい •時間がかかる →これはRobolectricで改善できる •保守のコストがかかる →UIの検証はスクリーンショットテストの充実で楽になった •通るコードが長くテストの問題が見つけづらい →通るコードが長いこと自体は変えられないが、 →技術への理解を深めることで補える 統合テストの難しさ
7. 発表の目的 •技術を理解して問題の起きづらい統合テストを目指す
8. 統合テストの手段
9. 統合テストの手段の一例 1. Compose UI Test 2. Hilt 3. テストダブル 4. Robolectric/Roborazzi •サンプル・検証コード：https://github.com/hiroaki404/ComposeUITestSample •参考になるリポジトリ：https://github.com/DroidKaigi/conference-app-2024 https://github.com/android/nowinandroid
10. Compose UI Test •Composeのレイアウトをテストする •ComposeTestRuleを使ってComposeを 呼び出す •ユーザー操作を伴うテストができる •Finder、Matcher、Actions、Assertions Compose Test APIのチートシート https://developer.android.com/develop/ui/compose/testin g/testing-cheatsheet
11. Hilt •依存関係の解決をHilt等のDIライブラリに任せれば記述量が減る •@TestInstallInを使ってテスト用に依存を解決 •テストではRoblectricやInstrumented testでしか使えない •必要な設定もあり、必須ではなく、手動でのDIも可能
12. ruleを連鎖させる •ComposeTestRule、 HiltAndroidRuleなどが増え ていく •ComposeTestRule、HiltAndroidRule などがRule増えていく •Ruleを連鎖させて共通化する
13. 統合テストでテストダブルを使う目安 •忠実度を高めるためなるべくテストダブルを使わず、実際のク ラスをそのまま使う •自社サービス外のサービスはテストダブルを使ってもよい •Firebaseなど •自社サービスのAPIはフェイクを使ってもよい •フェイク: テスト用の実際の挙動を模した実装で、インメモリデータ ベースを使ったりする
14. Robolectric/Roborazzi •Roblectric •シミュレータ不要でJVM上でUIテストが実施 でき、Instrumented Testに比べて速い •忠実度は下がる •Roborazzi •UIテストの任意のタイミングで captureRoboImage() でスクリーンショット •Robolectricで動作 •CIのGithub Actionsに統合し、差分を検出し、 手軽にUIの退行を検知できる • UIテストを定義しなくても簡易に退行検知がで きるのは強み
15. 知っておきたいこと
16. 統合テストのデバッグの難しさ •通るコードが長い •関係するクラスやライブラリが多い •テスト特有の知識が必要 •特にハマりそうなポイントを紹介します 1. Compose TestのAPI 2. テストを同期する
17. Compose TestのAPI
18. Semantics tree •UIを構成するComposition treeと並列にSemantics treeが構成され る •Semantics treeはトークバックにも使われる •Compose TestはSemantics treeに対してマッチングが行われる Text Text Icon Text Text Icon
19. デバッグ •printToLog()、printToString() •ノードの情報のログを得る •前者はInstrumented Test、 後者はRoblectric •layout inspectorでも確認できる
20. Semantics TreeのMerged Tree •特定のコンポーネントには子のノードが親のノードにマージさ れるものがある •ボタンの子のテキストは、親のセマンティクスプロパティに統 合される マージ Button Text Text Icon Button
21. マージポリシー •どのようにマージされるかは、セマンティクスプロパティごと に異なる •text：子のプロパティが親のものに追加 •testTag：子のプロパティを受け継がない →ボタンの配下のコンポーネントにtestTagを配置しても削除され てしまう！ •テストではマージ前後のどちらを使うかを選択可能 →テストではマージされていないツリーを使うか、親にテストタ グをつける
22. ダイアログではルートが２つになる •ダイアログが出ている画面でonRootの Finderを使うとエラー •ダイアログがあるとルートが２つに •複数ルートの中から一つを指定
23. テストを同期する
24. 統合テストに関わる同期 •ComposeTestRule.mainClock •Composeの再構成やフレーム、コルーチンの同期 •デフォルトで、アニメーションやLaunchedEffect等のコルーチンは同期 •ただしコルーチンのdelayを進めるにはmainClock.advanceTimedBy等が必要 •アニメーション等を制御したい場合にはautoAdvanceで調整する •autoAdvance、advanceTimedBy、advanceTimeUntil… •ShadowLooper.runUiThreadTasksIncludingDelayedTasks() •Robolectricでメインスレッドのdelayを含めてタスクを同期 • viewModelScopeのdelayも進む •ShadowLooper.shadowMainLooper().idleFor()でもOK
25. 統合テストに関わる同期 •TestDispatcher •StandardTestDispatcher、UnconfinedTestDispatcher •テストのコルーチンや遅延を制御する •適切にTestDispatcherを挿入することで制御可能 •delayを進めるにはscheduler.advancedTimeBy()等が必要 •コルーチンのテスト https://developer.android.com/kotlin/coroutines/test •advanceUntilIdle、advancedTimeBy、runCurrent、setMain •InstantTaskExectorRule •RoomのDatabaseの処理などを同期的に行われるようにする •同期されていないタスクがないか確認する
26. 実例 composeTestで期待する要素が存在しない 1. printToStringでNodeを見ると、 progressIndicator（ローディングの状態） 2. データを読み込む前の状態だった 3. 読み込む前に遅延処理があった 4. scheduler.advancedTimeBy()でdelayを進める と、期待通りに要素が表示された
27. まとめ •忠実度の高いテストによってリファクタリングへの耐性と退行 に対する保護が備わる •統合テストをするにはそれなりに設定や習熟が必要だがメリッ トは大きい •部分的に取り入れながら徐々に広げていくと良い • 参考文献 • 『単体テストの考え方/使い方』 Vladimir Khorikov著 マイナビ • Testing strategies https://developer.android.com/training/testing/fundamentals/strategies • Test your Compose layout https://developer.android.com/develop/ui/compose/testing • Robolectricの限界を理解してUIテストを高速に実行しよう https://www.youtube.com/watch?v=sd8QWgSGxMc&ab_channel=DroidKaigi • How to Test Your Compose UI https://speakerdeck.com/stewemetal/how-to-test-your-compose-ui-droidkaigi-2022-tokyo