PowerMock/MockitoでCoolに テストコードを書いた話

JJTC第一回 発表資料

Transcript

1. @Pakkun PowerMock/MockitoでCoolに テストコードを書いた話
2. 自分の経験談をベースに話して行きます。 Javaの単体テストに関する話をします。 初心者向けです。 今日話す内容
3. 自己紹介 何故テスト コードを書くのか？ 02 INTRODUCTION Why we do Testing? 01 パワーモック/モックについ て PowerMock/Mockito 04 Why Should We Use Mockito? なんでモキットなの？ 03
4. ・名前：パク ジョンフン（通称：パックン） ・勤め先：ソフトバンク株式会社（新卒入社） ・会社でやってること：#アジャイル #PCIDSS #MVNO向けエントリーAPI開発 #内製KVS開発 #アーキコンサル見習い(最近) ・趣味：バドミントン（ゴール : -20kg） ・一言：JJTC幹事(メンバー)募集中！ 01. Who Am I
5. “は..はい！” —先輩 “単体テストのカバレッジが低いから、 来週からカバッレッジ向上(80%)のタスク着手してくれない？” —自分
6. 状況 ・保守開発(内製) / 社員１人＋ベンダー複数人(チーム開発) ・カバレッジほぼ0%(...step数:約15万7千) ・潜んでいる闇コード(仕様書ないコードも) ・まるで秘伝のタレ(ifififififififififififififif最高!!)
7. “俺がやらなきゃ誰がやる” https://japaneseclass.jp/trends/about/%E7%A5%9E%E6%A7%98%E3%81%AE%E3%82%AA %E3%83%AB%E3%82%B4%E3%83%BC%E3%83%AB
8. 約３ヶ月後... ・カバレッジ 90%越え達成！ ・単体テストってなんでもかけるじゃん〜 ・なんかJUnit書くの楽しくなってきたかも
9. 02.何故テスト コードを書くのか
10. 上司：もうテスト完璧だよね？ 自分：はい。（嘘） 上司：もう仕様１００％把握したよね？ 自分：はい。（嘘） 上司：もう不具合でないよね？ 自分：はい。（嘘） カバレッジ向上したところで、本当に品質は向上したのか 内部秘
11. https://twitter.com/timeofkenzya
12. 単体テストの カバレッジ向上 品質の向上(万能薬)
13. 単体のカバレッジを向上させる理由 チーム開発！ ・仕様書書く人/設計書書く人/ ソース書く人/テスト書く人/リリー スする人/運用する人 全員違う人かも？ デグレ防止！ ・過去のリリース資材の中身、何を 根拠にデグレしていないと言えま すか？ タイポ防止！ ・バグの出所
14. 単体テストの カバレッジ向上 品質の向上 単体テストの カバレッジ向上 品質の向上のきっかけ
15. 03. Why Should We Use Mockito?
16. public int sum(int a, int b) { return a + b; } <テスト対象> ...？ テストしまーす Hoge.java
17. 実際の業務のコードはこんなんじゃない！ https://career-picks.com/business-yougo/sechigarai/
18. public void deleteLine(String word) { Line line = repository.findWord(word); // 引数で渡された単語を含む行を探す repository.delete(line); // 対象の行を削除する } <テスト対象> Q. 上記テスト対象のメソッドの「単体テスト」を作成する場合、 　stubに置き換えた方が良いものは？ 1. Line 2. word 3. repository 質問 LineManager.java stub:テスト用に用意した、本来の部品の代わりのもの
19. public void deleteLine(String word) { Line line = repository.findWord(word); // 引数で渡された単語を含む行を探す repository.delete(line); // 対象の行を削除する } <テスト対象> Q. 上記テスト対象のメソッドの「単体テスト」を作成する場合、 　stubに置き換えた方が良いものは？ 1. Line 2. word 3. repository 答え 僕には時間がないんだ！「 repository」は他でテストしてくれ！ deleteLineのメソッド単体の挙動をテストすることが大事！ LineManager.java
20. public void deleteLine(String word) { Line line = repository.findWord(word); // 引数で渡された単語を含む行を探す repository.delete(line); // 対象の行を削除する } <テスト対象> じゃあどうやってStubにすんの <テストコード(一部)> Line line = new Line(); // 適当な行をnewして repositoryStub.setLineToFind(line); // 作ったスタブの戻り値をセット lineManager.setRepository(repositoryStub); // repositoryをStubに置き換える lineManager.deleteLine("hoge"); // テスト対象のコードを実行 repositoryStub.verifyLineDeleted(line); // テスト対象のコードが「行削除」のコードを呼び出しているか 確認する 自分で「 RepositoryStub」を作るしかないよね。。。 (作ったとして) LineManager.java LineManagerTest.java
21. ・Stub-Run-Assertの順にテストしている。 ・「verifyLineDeleted」メソッドで、 　対象のコードがきちんと呼び出されているか確認。 ・Stubは検証の対象ではない。 repositoryStub.setLineToFind(line); lineManager.deleteLine("hoge"); repositoryStub.verifyLineDeleted(line); テストの流れ(頭の中整理) LineManagerTest.java
22. ・テスト対象クラス(主人公)の下位クラス(ガヤ)の定義を 　ラップできるオブジェクト。 →テストする人の都合のいいように、 余計に出てくるクラス(ガヤ)の定義を上書きしちゃえるってこと。 さっき手でやってたことを楽にしてくれそうだね モックの登場
23. モックライブラリの種類 ・Mockito ・PowerMock ・EasyMock ・JMockito ・jMock ・etc..
24. モックライブラリの種類 ・Mockito ・PowerMock ・EasyMock ・JMockito ・jMock ・etc.. まずこれつかってみよう
25. Mockito を選んだ理由 https://trends.google.co.jp/trends/? geo=JP 1. 良く使われてるじゃん #ググりやすそう(大事) 2. 他のライブラリと比べ 　コード量が少ないじゃん #時間がない！ 3. Stub-Run-Assert #考え方が自分と良く会う # 「Mocks aren't Stubs」- Martin Fowler 氏 　に沿っており、TDDの思考と逆行しない。 　ThoughtWorks社の開発者もMockito使ってるらしい。 　(TDDについてはまた次回 )
26. “なんか、良さそうだから Mockito使って書きまーす” “private/static/final/innerClass とかは Mockitoじゃ無理だからPowerMock つーかお”
27. 04. PowerMock/Mockito
28. Mockitoで書くとこんな感じ repositoryStub.setLineToFind(line); lineManager.deleteLine("hoge"); repositoryStub.verifyLineDeleted(line); when(mockRepository.findLine("hoge")).thenReturn(line); lineManager.deleteLine("hoge"); verify(mockRepository).delete(line); ・手作りStub ・Stubの振る舞いを一式用意しておく ・前段で生成しておくだけ ・使うときに振る舞いを定義する
29. PowerMockはMockitoができること全般は もちろん、Mockitoでは対応できない ハードケースにも対応できるが、処理が重い とはとは Mockitoではpublicクラス／メソッドを モック化し、メソッド呼出し時に処理を 無効にしたり、特定の戻り値を返したりといった一般 的な使い方はできるが、private/static/finalメソッドに は対応できない
30. Mockito/PowerMockのモックオブジェクトの種類 ① mockメソッドのモックオブジェクト - 基本的にモックの全メソッドが無効となる - テストに都合の良い値を返すようにメソッド定義を上書きする必要がある ② spyメソッドのモックオブジェクト - 元の処理が実行される - 挙動を変更したいメソッドに対して、定義を上書きする必要がある 一部は元通りの処理、一部は挙動を変更したい場合にspyを使う それ以外全て普通のmockメソッドを利用しましょう。
31. 実装方法(Maven利用) 1. dependencyをpomに追加 <dependency> <groupId>org.powermock</groupId> <artifactId>powermock-api-easymock</artifactId> <version>----</version> </dependency> <dependency> <groupId>org.powermock</groupId> <artifactId>powermock-module-junit4</artifactId> <version>----</version> </dependency> <dependency> <groupId>org.powermock</groupId> <artifactId>powermock-core</artifactId> <version>----</version> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> <version>----</version> </dependency>
32. 2. モジュールインポート 3. runner指定（テストクラスに下記のアノテーションを設定） ## Mockitoのみの場合 @RunWith(MockitoJUnitRunner.class) public class XxxTest {…} ## PowerMockを使う場合 @RunWith(PowerMockRunner.class) @PrepareForTest({Hoge.class, Fuga.class}) // PowerMockが扱うクラス public class XxxTest {…} import static org.mockito.ArgumentMatchers.*; import org.junit.runner.RunWith; import org.mockito.junit.MockitoJUnitRunner; import org.powermock.modules.junit4.PowerMockRunner; import org.mockito.Mock; import org.mockito.Spy;
33. 4. モックオブジェクトの生成(Mockito) アノテーションによる生成（クラス変数にのみ使用可能） メソッドによる生成（クラス変数にのみ使用可能） @Mock Hoge hogeMock; @Spy Fuga fugaSpy; Hoge hogeMock = Mockito.mock(Hoge.class); Fuga fugaSpy = Mockito.spy(Fuga.class); Piyo piyoSpy = Mockito.spy(new Piyo(arg0, arg1));
34. 4. モックオブジェクトの生成(PowerMock) アノテーションによる生成（クラス変数にのみ使用可能） メソッドによる生成（クラス変数にのみ使用可能） なし FinalHoge hogeMock = PowerMockito.mock(FinalHoge.class); // final class Piyo piyoSpy = PowerMockito.spy(new Piyo(arg0, arg1)); // private method を扱う PowerMockito.mockStatic(StaticHoge.class); // static method を扱う
35. 5. 挙動の上書き 戻り値を上書き 特定のメソッドを無効化する 特定のメソッドを無効化する (Power)Mockito.when(hogeMock.getSomething(anyString())).thenReturn(“hoge”); (Power)Mockito.doReturn(myObj).when(piyoSpy).getSomething(); PowerMockito.when(StaticHoge.get()).thenReturn(some Object); Mockito.doNothing().when(hogeSpy).doSomething(any(OtherClass.class)); PowerMockito.doNothing().when(StaticHoge.class, “method name”); (Power)Mockito.doThrow(new Exception()).when(mySpy).doSomething();
36. 実際に書いてみよう！ パターン：private メソッドのモック化が必要な場合 public class Hoge { public void doSomething() { ... String key = ...; String value = this.getProperty(key); ... } private String getProperty(String key) { ... return xxx; } } クラス定義
37. @RunWith(PowerMockRunner.class) @PrepareForTest({Hoge.class}) public class HogeTest { public void testDoSomething() { Hoge h = PowerMockito.spy(new Hoge()); PowerMockito.doReturn(“dummy value”).when(h, “getProperty”, anyString()); h.doSomething(); ... assertThat(...); } } テストロジック
38. ・引数指定でnullの扱いは要注意 ・MockitoとPowerMockの使い分け #qiitaにいい感じのまとめがありました。 https://qiita.com/euledge/items/a224777c15ae7145114a その他注意事項
39. まとめ # 初心者向け # どっかでまとめてテストはNG! # Mockが多くなると...地獄 #次回のネタは
40. ご清聴ありがとうございました。
41. APPENDIX
42. ・「Mocks aren't Stubs」- Martin Fowler 氏 https://martinfowler.com/articles/mocksArentStubs.html
43. Expect-Run-Verify 他の模擬Objのテストフレームワークはどうだったか(Mockito以外) // expect Line line = new Line(); expect(mockRepository.findLine("foo")).andReturn(line); mockRepository.delete(line);←検証すべきコード // run replay(mockRepository); lineManager.deleteByWordLists("foo");←テストの実行 // verify verify(mockRepository); EasyMock
44. EOF