SPMマルチモジュールで テストカバレッジを取得する技法

SPMマルチモジュール構成のiOSアプリでテストカバレッジを取得しようと思うと、思わぬ壁が立ちはだかって思うように収集を行うことができません。この資料では理想的なテストカバレッジを収集できる方法と、なぜそうなっているかの原因をお伝えします。

Transcript

1. © DMM © DMM SPMマルチモジュールで テストカバレッジを取得する技法 iOSグループ 山田良治 2026/05/18
2. © DMM アジェンダ - 自己紹介 - マルチモジュールのおさらい - 問題の共有 - 原因と振る舞い - 解決方法の提案 - まとめ 2
3. © DMM マルチモジュールのおさらい 3 マルチモジュールとはなんぞや
4. © DMM マルチモジュールの動機 - コンウェイの法則 - メガベンチャーアプリで数十万行を超える膨大なコードベース - アプリの1ボトムタブごとに専門のチームがあって、独立してメンテしたい - 機能ごとにフィーチャーチームがあり... - アーキテクチャのレイヤーでモジュールを分割し、クリーンなコードを維持 したい 組織の形に従うように、コードベースを分割したい要求がある 4
5. © DMM マルチモジュールの動機 - ビルド時間 昔XcodeでのSwiftのビルドには非常に時間がかかった (10~20分はザラ → なるべくビルド対象を減らして、差分ビルドを効かせたい。 引用: https://qiita.com/manshiro/items/be6f6c5406982ecb7d03 5
6. © DMM マルチモジュールのおさらい 6 などの要求に従って、コードを複数のモジュールに分割するのが マルチモジュールです
7. © DMM マルチモジュールのおさらい - 昔 (SPM以前) Embedded Frameworkを活用したマルチモジュール 引用:「Kyash iOSアプリの大規模リファクタリングの話」 https://blog.kyash.co/entry/2018/03/20/150238 7
8. © DMM SPMマルチモジュールの誕生 引用: 「Swift Package centered project - Build and Practice」 https://speakerdeck.com/d_date/swift-package-centered-project-build-and-practice?slide=61 8
9. © DMM SPMマルチモジュールのおさらい - 今 - WWDC19でXcodeとSwift Package Managerが統合 - Swift Packageの仕組みを使ってマルチモジュールを実現 - パッケージマネージャ & マルチモジュールを同時に解決 - ついでにpbxprojのコンフリクト問題も解決し(SPM内のソースファイルは pbxprojに乗らないため)、XcodeGenも不要化 - 使い勝手が大変良く、一気に開発のメインストリームに - (※ あくまでコミュニティベースの方法論として) 9
10. © DMM 問題の共有 10 SPMマルチモジュール利用時 期待通りにテストカバレッジを拾ってくれない
11. © DMM 問題の共有 - 問題ないモノリスなサンプル 11
12. © DMM 問題の共有 - 問題ないモノリスなサンプル - pbxproj1個で管理 - Xcodeのホストターゲット/テストターゲットを利用 - Domain/Entity/Repository/UI/UseCaseのレイヤーが分かれている - Caluculator/AdvancedCalculationUseCase/DMMSwiftSlideという型 でロジックが実装されており、それぞれユニットテストバンドル内にテスト がある - Firebaseを外部パッケージとして導入 - コードカバレッジの収集をOn、All Targetsを指定 12
13. © DMM 問題の共有 - 問題ないモノリスなサンプル 13
14. © DMM 問題の共有 - 問題ないモノリスなサンプル 14 モノリスな場合は全く何の問題ない ✨
15. © DMM 問題の共有 - SPMマルチモジュールのサンプル 15
16. © DMM 16
17. © DMM 問題の共有 - SPMマルチモジュールのサンプル - Domain/UI/UseCase/Repositoryのモジュール分割 - Domainは、さらに子として Entityターゲットを持つ - AppMainという.libraryを公開してpbxproj側から参照 - Xcodeのユニットテストバンドルを持たない - テストコードはSwift Packageの.testTargetで DomainTests/UseCaseTests/EntityTestsを記述 - Firebaseを外部パッケージとして導入 - コードカバレッジの収集をOn、All Targetsを指定 17
18. © DMM 問題の共有 - SPMマルチモジュールのサンプル 18
19. © DMM 問題の共有 - SPMマルチモジュールのサンプル 19 外部パッケージのターゲットまで カバレッジ対象として 計上されてしまっている 🤔
20. © DMM 問題の共有 - SPMマルチモジュールのサンプル 20 テストファイルのカバレッジまで計上され ている🤔
21. © DMM 問題の共有 - 失敗案1 - 既存のテストターゲットをカバレッジの集計対象として定義してみたらどう か？ 21
22. © DMM 問題の共有 - 失敗案1 - 既存のテストターゲットをカバレッジの集計対象として定義してみたらどう か？ - ダメでした。テストファイルまで集計対象になってしまうのは治らない。 22
23. © DMM 問題の共有 - 失敗案2 - AppMainライブラリだけをテスト対象にしたらどうか？ 23
24. © DMM 問題の共有 - 失敗案2 - AppMainライブラリだけをテスト対象にしたらどうか？ - ダメでした。Domainで依存しているEntityがカバレッジ収集されない。 24
25. © DMM 問題の共有 - SPMマルチモジュール - All Targetsでカバレッジ収集すると外部パッケージも含めて全ての ターゲットのカバレッジを拾いに行ってしまう - テストファイルのカバレッジまで計上されてしまう - 集計対象をsome targetsにしてライブラリを渡しても、モノリスようにパー フェクトなカバレッジ集計にならず困る - テストファイルのカバレッジも計上される - .libraryから見て推移的なモジュールのカバレッジが収集されない - モジュールは集計対象として指定できない 25
26. © DMM 原因と振る舞い - 「カバレッジ集計対象のターゲットの dependenciesとして直接指定さ れているモジュール」のファイルのコードカバレッジを拾う仕様 - “library: AppMain→ module: Domain → module: Entity”のようなケースで は、Entityのカバレッジは拾わない。 - テストコードが詰まったテストターゲットを指定すると、テストファイル自体のカバ レッジまでピックアップしちゃう。 26
27. © DMM 原因と振る舞い 27 この モジュール内のファ イルまでしか 拾わない
28. © DMM 原因と振る舞い - 細かい話をちょっとだけ - Xcodeでビルドすると必ずカバレッジデータを生成する profile-coverage-mapというオプション付きでコンパイルされる - (たぶん、Xcodeのminimapでのカバレッジ表示用) - 内部的にはLLVMコードカバレッジを使っており、DerivedDataには protorawというカバレッジファイルが生成されている 28
29. © DMM 29
30. © DMM 30 ID/ハッシュ/通った回数のカウンタ
31. © DMM 原因と振る舞い - 細かい話をちょっとだけ - Xcodeでビルドすると必ずカバレッジデータを生成する profile-coverage-mappingというオプション付きでコンパイルされる - (たぶん、Xcodeのminimapでのカバレッジ表示用) - 内部的にはLLVMコードカバレッジを使っており、DerivedDataには protorawというカバレッジファイルが生成されている - xcrun llvm-cov show -instr-profile=Coverage.profdata {PathToObjectFile}/Foo.o でオブジェクトファイルとカバレッジデータを突 合する - どのファイルのどのシンボルのカバレッジはどうかのデータが作れる - データはあるのに、突合だけできてない 31
32. © DMM 解決方法の提案 32 外部モジュールとテストファイルは計測対象に含まず 推移的なモジュールも計測される方法にしたい！
33. © DMM 解決方法の提案 提案方法: カバレッジ収集用の .testTargetを作り、全てのモジュールを配 下にフラットに持つようにして、狙って Xcodeにカバレッジ突合をさせる - 要は「テスト実行時には必ず手元に生のカバレッジデータはあるのに拾っ ていないだけの状態。それを拾ってくる専用のターゲットでカバレッジを見 る」 - テストターゲットはカバレッジ収集の対象にできる - .libraryは外部に本番用のビルド成果物を晒してしまうから避けたい - テストレポートの生成は必ずテスト実行より順番が後 33
34. © DMM 解決方法の提案 - 手順 1. 全てのモジュールをフラットに持つテストターゲットを定義する 34
35. © DMM 35
36. © DMM 36
37. © DMM 解決方法の提案 - 手順 1. 全てのモジュールをフラットに持つテストターゲットを定義する 2. xctestplanのChoose Targets…で定義したターゲットを選択する a. Xcodeは、ここで選択したターゲットのprotorawファイルをマージしてprofdataと いうマージ後カバレッジデータを生成し突合する仕組みのため、選択は必須 (動 作検証済み) 37
38. © DMM 38
39. © DMM 解決方法の提案 - 手順 1. 全てのモジュールをフラットに持つテストターゲットを定義する 2. xctestplanのChoose Targets…で定義したターゲットを選択する a. Xcodeは、ここで選択したターゲットのprotorawファイルをマージしてprofdataと いうマージ後カバレッジデータを生成し突合する仕組みのため、選択は必須 (動 作検証済み) 3. xctestplanのカバレッジ収集オプションでsome targetsを選択し、定義し たカバレッジ収集用テストターゲットを渡す (ここではZ_COVERAGE) 39
40. © DMM 40
41. © DMM 1. 全てのモジュールをフラットに持つテストターゲットを定義する a. テストコードを自身が持たない集計用の特殊テストターゲットのため「テストファイ ルのカバレッジまで計上されてしまう」問題を踏まない 2. xctestplanのChoose Targets…で定義したターゲットを選択する a. Xcodeは、ここで選択したターゲットのprotorawファイルをマージしてprofdataと いうマージ後カバレッジデータを生成し突合する仕組みのため、選択は必須 (動 作検証済み) 3. xctestplanのカバレッジ収集オプションでsome targetsを選択し、定義し たカバレッジ収集用テストターゲットを渡す (ここではZ_COVERAGE) 41 解決方法の提案 - 手順
42. © DMM 解決方法の提案 - 手順 成功！🙌 🥳 42
43. © DMM 解決方法の提案 - モノリスサンプルの再掲 43 ※ Appだけパッケージの外なので計測対象外の差分
44. © DMM 問題の共有 - 解決方法の応用 - この方法は任意のモジュールを組み合わせて、任意のカバレッジ計測 グループを作れる - 例えばクリーンアーキテクチャのDomain + UseCaseなど内側のレイヤのモ ジュールだけ集めてテストカバレッジを計測する - DBとRepositoryのテストコードだけを計測する - などなど 44
45. © DMM 45
46. © DMM 解決方法の提案 - 手順 理想的な計測に成功！🙌 🥳 46
47. © DMM 必要ないケース - .libraryの直系の子dependenciesから推移的なモジュールが一切ないシ ンプル構成の場合 - マルチライブラリ構成で、ライブラリの依存性がフラットにまとめられている場合 など - いくつかのライブラリをsome targetsでカバレッジ収集対象にするだけでOK (た ぶん) - マルチモジュール構成がそもそも必要ないプロジェクト - M系チップ強くてビルド時間がそんな気にならない昨今 - フィーチャーチームの分割要求などコンウェイの法則が働いていない - → 全然モノリスプロジェクトで進めて良いと思う ※ pbxprojのコンフリクトも、Xcode 15~16あたりでほぼ発生しないような改善アップデートが入ってる 47
48. © DMM まとめ - SPMマルチモジュール構成の複雑なiOSアプリでは、テストカバレッジが 上手く取得できない。 - 解決のための手法として「.testTargetで、dependenciesにカバレッジ収 集したいモジュールを全てフラットに持つ、計測用の特殊テストターゲッ トを定義する 」という方法を提案した。 - この方法を応用すると、「モデルコードのみ計測」などの任意のカバレッ ジ計測グループ を簡単に作ることができる。 48
49. © DMM ご清聴ありがとうございました