Androidアプリのテスト駆動開発入門

Transcript

1. Androidアプリの テスト駆動開発入門 トニオ
2. 自己紹介 • トニオ（@tonionagauzzi） • Android Engineer @cybozu 2
3. 発表内容 • 以下のブログの内容です！ https://blog.cybozu.io/entry/2024/05/24/170000 3
4. Androidでテスト駆動開発(TDD) 始めました！ 4
5. TDDとは • 動作するきれいなコードを作るために、テストによって開発を推し進 める 5
6. TDD導入の背景 • レガシーコードいっぱい… テスト作りたい！ 書き換えたい！ テストがなくて不安… テスト作れる構造じゃない… 6
7. 新しいモジュールぐらいは テスト書こう！ 7
8. TDD導入の背景 • TDDで作ると oテストしやすくなるらしい！ o コードも綺麗になるらしい！ o 依存モジュール(レガシーコード)も少しずつテストできそう！ 8 Testable Module Legacy Module テスト対象
9. 今回は、TDDのテストは自動テスト という前提で話します！ 9
10. TDDの流れ 10
11. TDDの実装例！ 11
12. ログイン画面にヘルプリンクを追加 • ユーザーストーリー o ログイン操作を行うユーザーとして、ログイン操作につまずいたとき、 その画面上から直接関連するヘルプページを開きたい。 o なぜなら、疑問の答えを一から探す手間をかけずに 関連するヘルプページを参照し、ログインを完了させ、 本来やりたい業務を進められるからだ。 o • 受け入れ条件 o ログイン画面からヘルプページを開けること o 端末の言語設定に応じてヘルプの言語を変えること o 接続先ごとに提供サービスが異なるため、接続先に応じてヘルプの内容を変えること 12
13. (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ 簡体字 / 日本サーバー の組合せ 繁体字 / 日本サーバー の組合せ その他 / 日本サーバー の組合せ 日本語 / 米国サーバー の組合せ 英語 / 米国サーバー の組合せ 簡体字 / 米国サーバー の組合せ 繁体字 / 米国サーバー の組合せ その他 / 米国サーバー の組合せ 接続先を判定できなかった場合、日本語 / 日本サーバー の組合せとなる (2) ログイン画面でヘルプリンクが押されると、1.で生成したURLを Chromeに渡し、ヘルプページを開く CHECK LIST 13
14. // テスト @Test fun `日本語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given(前提条件) val language = "ja" val country = "JP" // When(操作) val url = get(language = language, country = country) // Then(結果) Truth.assertThat(url).isEqualTo("https://localhost/help/ja/JP/") } // 実装 fun get(language: String, country: String): String { return "" } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ RED 14
15. // テスト @Test fun `日本語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given(前提条件) val language = "ja" val country = "JP" // When(操作) val url = get(language = language, country = country) // Then(結果) Truth.assertThat(url).isEqualTo("https://localhost/help/ja/JP/") } // 実装 fun get(language: String, country: String): String { return "https://localhost/help/ja/JP/" } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ GREEN 15
16. // テスト @Test fun `日本語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given(前提条件) val language = "ja" val country = "JP" // When(操作) val url = get(language = language, country = country) // Then(結果) Truth.assertThat(url).isEqualTo("https://localhost/help/ja/JP/") } @Test fun `英語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given val language = "en" val country = "JP" // When val url = get(language = language, country = country) // Then Truth.assertThat(url).isEqualTo("https://localhost/help/en/JP/") } // 実装 fun get(language: String, country: String): String { return "https://localhost/help/ja/JP/" } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ RED 16
17. // テスト @Test fun `日本語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given(前提条件) val language = "ja" val country = "JP" // When(操作) val url = get(language = language, country = country) // Then(結果) Truth.assertThat(url).isEqualTo("https://localhost/help/ja/JP/") } @Test fun `英語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given val language = "en" val country = "JP" // When val url = get(language = language, country = country) // Then Truth.assertThat(url).isEqualTo("https://localhost/help/en/JP/") } // 実装 fun get(language: String, country: String): String { if (language == "en") { return "https://localhost/help/en/JP/" } else { return "https://localhost/help/ja/JP/" } } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ GREEN 17
18. // テスト @Test fun `日本語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given(前提条件) val language = "ja" val country = "JP" // When(操作) val url = generateHelpLink(language = language, country = country) // Then(結果) Truth.assertThat(url).isEqualTo("https://localhost/help/ja/JP/") } @Test fun `英語 / 日本サーバー の組合せで、ヘルプページのURLを生成する` { // Given val language = "en" val country = "JP" // When val url = generateHelpLink(language = language, country = country) // Then Truth.assertThat(url).isEqualTo("https://localhost/help/en/JP/") } // 実装 fun generateHelpLink(language: String, country: String): String { val helpPath = when (language) { "en" -> "en/JP" else -> "ja/JP" } return "https://localhost/help/$helpPath/" } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ REFACTOR 18
19. 1つずつテスト、実装、リファクタリング！ RED GREEN REFACTOR 19
20. (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ 簡体字 / 日本サーバー の組合せ 繁体字 / 日本サーバー の組合せ その他 / 日本サーバー の組合せ 日本語 / 米国サーバー の組合せ 英語 / 米国サーバー の組合せ 簡体字 / 米国サーバー の組合せ 繁体字 / 米国サーバー の組合せ その他 / 米国サーバー の組合せ (2) ログイン画面でヘルプリンクが押されると、1.で生成したURLを Chromeに渡し、ヘルプページを開く 20
21. (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ 簡体字 / 日本サーバー の組合せ 繁体字 / 日本サーバー の組合せ その他 / 日本サーバー の組合せ 日本語 / 米国サーバー の組合せ 英語 / 米国サーバー の組合せ 簡体字 / 米国サーバー の組合せ 繁体字 / 米国サーバー の組合せ その他 / 米国サーバー の組合せ (2) ログイン画面でヘルプリンクが押されると、1.で生成したURLを Chromeに渡し、ヘルプページを開く 21
22. Androidの振る舞いをTDDしよう！ 22
23. private val activity = Robolectric.buildActivity(FragmentActivity::class.java).create().start().resume().get() // テスト @Test fun `ログイン画面でヘルプリンクが押されると、生成したURLをChromeに渡し、ヘルプページを開く`() { // Given (前提条件: ログイン画面を開いている) val fragment = Fragment() activity.add(fragment) val helpLinkUrl = generateHelpLink(language = "ja", country = "JP") // When (操作：ヘルプリンクを押す) fragment.openBrowser(url = helpLinkUrl) // Then (結果：ChromeがURLを開く) val openedActivity = Shadows.shadowOf(activity).nextStartedActivity val openedPackage = openedActivity.getPackage() Truth.assertThat(openedPackage).isEqualTo("com.android.chrome") val openedUrlString = openedActivity.data.toString() Truth.assertThat(openedUrlString).isEqualTo(helpLinkUrl) } // 実装 fun Fragment.openBrowser(url: String) { } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ 簡 簡 簡 / 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 繁体字 / 日本サーバー の組合せ その他 / 日本サーバー の組合せ 日本語 / 米国サーバー の組合せ 英語 / 米国サーバー の組合せ 簡体字 / 米国サーバー の組合せ 繁体字 / 米国サーバー の組合せ その他 / 米国サーバー の組合せ 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 / 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 (2) ログイン画面でヘルプリンクが押されると、1.で生成したURLを Chromeに渡し、ヘルプページを開く 23
24. private val activity = Robolectric.buildActivity(FragmentActivity::class.java).create().start().resume().get() // テスト @Test fun `ログイン画面でヘルプリンクが押されると、生成したURLをChromeに渡し、ヘルプページを開く`() { // Given (前提条件: ログイン画面を開いている) val fragment = Fragment() activity.add(fragment) val helpLinkUrl = generateHelpLink(language = "ja", country = "JP") // When (操作：ヘルプリンクを押す) fragment.openBrowser(url = helpLinkUrl, errorCallback = { e -> fail(e) }) // Then (結果：ChromeがURLを開く) val openedActivity = Shadows.shadowOf(activity).nextStartedActivity val openedPackage = openedActivity.getPackage() Truth.assertThat(openedPackage).isEqualTo("com.android.chrome") val openedUrlString = openedActivity.data.toString() Truth.assertThat(openedUrlString).isEqualTo(helpLinkUrl) } // 実装 fun Fragment.openBrowser( url: String, errorCallback: (e: Exception) -> Unit = { e -> // エラー処理 }, ) { try { val chromeIntent = Intent(Intent.ACTION_VIEW, url.toUri()) chromeIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK chromeIntent.setPackage("com.android.chrome") startActivity(chromeIntent) } catch (e: Exception) { errorCallback(e) } } (1) 接続先情報と端末の言語設定に応じたヘルプページのURLを生成する 日本語 / 日本サーバー の組合せ 英語 / 日本サーバー の組合せ 簡 簡 簡 / 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 繁体字 / 日本サーバー の組合せ その他 / 日本サーバー の組合せ 日本語 / 米国サーバー の組合せ 英語 / 米国サーバー の組合せ 簡体字 / 米国サーバー の組合せ 繁体字 / 米国サーバー の組合せ その他 / 米国サーバー の組合せ 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 / 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 簡 (2) ログイン画面でヘルプリンクが押されると、1.で生成したURLを Chromeに渡し、ヘルプページを開く 24
25. • Androidはテスト支援ツールが充実！ oユニットテストならRobolectric oandroidTestならEspresso、UI Automator https://github.com/robolectric/robolectric https://developer.android.com/training/testing/espresso https://developer.android.com/training/testing/other-components/ui-automator 25
26. • 可能な限りユニットテストで書く！ oテストピラミッドの考え方 o忠実性は下がる 図：https://zenn.dev/jyoppomu/articles/52844385940140 26
27. TDDで感じたメリット • 実装に取り掛かりやすい！ ➢大きな機能を小さく分けて作れるし、 が気持ちいい！ • 実装に自信を持ちやすい！ ➢チェックリストとテストがいつでも正しさを証明してくれる！ 27
28. TDDで感じたメリット • TDDで作った実装は壊れにくい！ ➢テストがあるから安心して修正できる！ • テストの整備が進む！ ➢開発プロセスがどんどん良くなる！ 28
29. TDDが難しいとき • テストがなくても自信を持てる実装 ➢ログを1行だけ足すとか • 画面の見た目が変わるような実装 ➢画面回帰テスト（VRT）が向いてる 29
30. TDDが難しいとき • テストコードを過信してしまう ➢テストの不足や誤りがないかは常に疑うべし • チームの認識が揃っていない ➢議論が長引くとTDDのスピードが上がらない ➢テスト、実装、リファクタリングの1サイクルは数分ほどで行われる ➢メンバーの知識や方向性を揃えるほうが先かも 30
31. テスト自動化の優先度 31
32. こんなテストも自動化しました！ • PUSHを受信したら、通知バーに通知が表示されること o テストコードでgoogle-auth-library-oauth2-httpを使ってFCMにPUSH o 通知の検証はNotificationManagerを使う 32
33. こんなテストも自動化しました！ • WebViewからJavascriptが呼ばれたら、ホーム画面にアプリの ショートカットが追加されること o テストコードでlaunchFragmentInContainerでWebViewをシミュレート o WebView.evaluateJavascriptでJSを発火 oショートカットの検証はShortcutManagerを使う 33
34. まとめ • チェックリストを作り、テスト、実装、リファクタリング • TDDで実装に自信を持つのが一番大事！ ▪ テストから書くルールやテストが増えることは副次的効果に過ぎない 34
35. Thank you for watching! 35