Android CI for Beginners

Transcript

1. Android CI for Beginners どくぴー（@e10dokup） 2018/06/08 @ サポーターズCoLab勉強会
2. • 開発中のAndroidプロジェクトにCIを導⼊するお話です • 個⼈アプリだったり • OSSライブラリだったり • 今回はBitriseを使います • お⾦がかからない範囲でがんばります • お⾦をかけると50USD/monthになります まずはじめに
3. • 話すこと • CIについて • ローカルでの⾃動テストについて • CI上での⾃動テストについて • CIでやるちょいとした⾃動化 • 話さないこと • テストの詳細な書き⽅について 今回お話すること・しないこと
4. • Android テスト全書を今すぐ予約だ！ ⾃動テストをガッツリ書きたい⼈へ
5. CIについて
6. • Continuous Integration：継続的インテグレーション • コミット単位で以下のような作業を実⾏すること • コンパイル • テスト • コード・ドキュメントの解析 • ベータ版配信 そもそもCIってなんじゃ
7. • Continuous Integration：継続的インテグレーション • コミット単位で以下のような作業を実⾏すること • コンパイル • テスト • コード・ドキュメントの解析 • ベータ版配信 そもそもCIってなんじゃ ΞϓϦέʔγϣϯ࡞੒࣌ͷ඼࣭վળ΍࡞ۀίετͷ࡟ݮ
8. • ⾃動テスト • ユニットテストもしたいしUIテストも… • その結果何かあったらSlackに通知とかしてほしい • QAやテスターに⾃動で配信できるようにしたい • Deploygateとかにアップロードしたり • リリースノートの⾃動⽣成とかやりたい • このバージョンでは何を直したの？とかの記述は⾯倒 Android開発でCIでやりたいことというと
9. • Jenkins • ⾔わずとしれたおじさん • オンプレミス環境で運⽤できる • 運⽤しなければならないとも • 圧倒的⾃由度 • 複数プロジェクトを動かしていると ランタイムやSDKを共有してしまう Android開発で使われているCI
10. • Circle CI • クラウドCIサービス • circle.yml でビルド制御を完結 • Circle CI 2.0からDockerコンテナ
 上でビルドが実⾏されるように • 1.0ではUbuntu環境上 • 無料枠1500分/⽉ • 50USD * 追加コンテナ数/⽉ Android開発で使われているCI
11. • Wercker • クラウドCIサービス • wercker.yml にビルド制御を記述 • Dockerコンテナ上でビルド • 無料枠がでかい • ビルド時間無制限 • 2並列までOK • Oracleに買われた Android開発で使われているCI
12. • Travis CI • クラウドCIサービス • .travis.yml にビルド制御を記述 • OSSに関しては無料利⽤可能 • Private Repositoryに関しては
 有料 Android開発で使われているCI
13. • Bitrise • クラウドCIサービス • GUIで処理ステップを定義 • bitrise.yml にも記述できる • Android/iOS特化のCIサービス • 無料枠では1ビルド10分/⽉200回 • それ以降は1並列毎に50USD/⽉ Android開発で使われているCI
14. Bitriseで個⼈プロジェクトにCIを 導⼊する⽅法について解説します 今回は
15. Bitriseをリポジトリ に導⼊する
16. • BitriseのDashboardから「Add new app」を選ぶ • ⼤体⾔われる通りにリポジトリを選ぶ • SSH keyを選ぶシーンがあるが必要に応じて⾃前のSSH keyを 渡してください • ここまで指定するとBitriseがリポジトリをクローンしてどのプ ラットフォームのプロジェクトか判定しだす Bitriseを導⼊する（その1）
17. • うまくいくと勝⼿にAndroidプロジェクトと判定してくれるの でDocker Imageを選ぶ • 決定するとFirst buildとして指定したbranchでデバッグビルド をするので、それが成功すれば導⼊完了 Bitriseを導⼊する（その2）
18. テストを書こう
19. •https://github.com/e10dokup/example-bitrise • だいぶ簡素なMVPアーキテクチャです 今回のサンプルプロジェクト 7JFX 1SFTFOUFS .PEFM "DUJWJUZ
    'SBHNFOU %BUB4PVSDF
20. • Unit Test • JVM上で動かせる単体テスト • app/src/test 以下に書こう • 通信周りはMockWebServerを使ってモックしながら • PresenterはMockitoでMockしたり、ArgumentCaptorを 使ってコールバックをverifyするテストを書いています • ⾮同期処理のテストではCountDownLatch等を使って待たな いとテストが不⾃然に通過したりするので注意！ ユニットテストを書こう
21. • ファイル単位、メソッド単位で実⾏できます • ちゃんと⾏けばグリーンで終わりますが、
 失敗すれば激しく⾚⾊で怒られます。 • exceptedに対してこう違うって怒られる
 ので参考にしましょう • 本来はDagger等のDIライブラリを使うところ
 ですが今回はコンストラクタDIをしています • うっかり忘れるとテストが完全に通らないとかあるので気を つけよう ユニットテストを⼿元で実⾏しよう
22. • Instrumentation Test • Android実機上で動かすテスト • app/src/androidTest 以下に書こう • 最近はデフォルトでUIテストライブラリのEspressoが付いて くるのでこれを使いましょう • ActivityTestRuleとかを使う場合はruleの追加が必要 UIテストを書こう
23. • Viewを呼び出したい • Viewが存在していることを確認したい • Viewをクリックしたい UIテストの簡単な書き⽅ onView(ViewMatchers.withId(R.id.hoge) onView(―).check(matches(isDisplayed)) onView(―).perform(click())
24. • 通信等の⾮同期処理を⾏う際に待機したい • AsyncTaskの実⾏はEspresso側で勝⼿に待機してくれる • RxやOkHttpなどを使っている場合はIdlingResourceを実装 してEspressoに待機してもらえるようにする必要あり • RecyclerViewの要素をクリックしたいときは？ • RecyclerViewActionsを使いましょう UIテストでちょっと困ったとき RecyclerViewActions.actionOnItemAtPosition(index, click())
25. • 実⾏の⼿順はユニットテストと⼀緒 • JVM上では動かないのでエミュレータか実機がないと動きま せん • 以下の2つのAPKをデバイスに送ることでInstrumental Testを ⾏う • 普通のデバッグ⽤APK • テスト⽤の情報が⼊ったテスト⽤APK UIテストを⼿元で実⾏する
26. CI上でテストを
 実⾏しよう
27. • Gradle Runnerステップで実⾏されるGradleタスクを追加 • 今回は test/assembleAndroidTest を追加 Bitrise上でテストを実⾏する
28. • Bitriseには仮想デバイスを実⾏するオプションがベータ版なが ら搭載されている • こちらを使わずに⾃分でデバイスファームにAPKをアップロー ドしてテストさせることも可能 • 以下の2つのファイルをデバイスに与えてテスト実⾏したい • app-debug.apk（assembleDebug） • app-debug-androidTest.apk（assembleAndroidTest） UIテストは…？
29. デバイスファーム
30. • クラウドから複数の実機デバイスをテストできる環境 • Open STF • AWS Device Farm • 無料枠あり（今1000分？） • iOSデバイスもあるよ • Firebase Test Lab • Sparkで⼀⽇実機5回、VM10回無料 • RoboTestが優秀 デバイスファームとは
31. • Firebase Test Labを使ってみる • まずはFirebaseプロジェクトを作成 • 設定 > サービスアカウントから秘密鍵をDL デバイスファームとは
32. Bitriseに秘密鍵を配置
33. • ビルドグリーンになればとりあえずOK • Firebase Test Labにアクセスするとinstrumentation testの
 実⾏結果が⾒れる • 実⾏時の動画とか • robo testを実⾏した場合は画⾯遷移図も出してくれる 実際にビルドしてみる
34. 細かい設定を⾏う
35. • BitriseのリポジトリのCodeからINCOMING WEBHOOKのURL を取得する GitHubのwebhookを追加する
36. • GithubのリポジトリのSettings > Webhooksから追加する • Push/Pull Requestsのみ有効にしよう GitHubのwebhookを追加する
37. • feature/~ なブランチからのPRのみビルドを⾛らせたい場合は 以下のようにWorkflow > Triggersで設定する commitに応じてworkflowを設定する
38. • Send a Slack messageステップから通知することができる ビルドが成功したらslackに通知したい
39. • DeployGateにアップロードしたい • scriptステップでcurlを⾶ばすようにするだけ • 各種APIと連携する時は環境変数にAPI Keyとかを書いていく • ⾒られたらまずいものは基本的にSecret Envに書こう • Expose for pull requestを有効にしないとPRで動かない その他の⼩技 curl -F "file=@/path/to/apk" \ -F "token=$DEPLOYGATE_KEY" \ -F "message=$GIT_CLONE_COMMIT_MESSAGE_SUBJECT" \ https://deploygate.com/api/users/{myName}/apps
40. • CIの導⼊⾃体はそんなに⼤変ではない（と思う） • ⾃分がCIを導⼊して何をしたいのか？を考えよう • ⾃動テストを実現したいのか？ • デプロイ周りを楽にしたいのか？ • 個⼈プロジェクトで慣れてから仕事でも使ってみる、みたいな サイクルでCIとか試せるとだいぶ安⼼感がある • お⾦がかかるケースが多いので負担にならない程度に… 最後に
41. おわり