テストケースのセットアップ処理を使いまわしたい時、TestRule
に実装するといろんな使いまわしが効いて便利なので最近はそうしている。個人的には、TestRule
の中には本当に基本的な準備や後始末の処理を書いて隠し、テストクラスの方に本質的なテストの前提条件だけ書くような感じで使い分けている。モックオブジェクトのセッティングやよく使うような一連のまとまった処理もTestRule
に書いたりする。UIテストのPageObjectみたいなものだろうか。Baseクラスを継承する方法でもいいと思うが、私はうまくできないので敬遠している。
実際はテストの前や後に呼ばれるメソッドが生えていて使いやすくなっているTestWatcher
クラスを継承して作る。TestWatcher
クラスの中身を見れば一目瞭然なのだが、ざっくり言うと@Before
の代わりになるのがstarting()
、@After
の代わりになるのがfinished()
で、普通はこのメソッドを実装すればよい。そのほかにテストに成功した時と失敗した時に呼ばれる、succeeded()
とfailed()
などがある。starting()
は@Before
の処理よりも必ず先に呼ばれるし、finished()
は@After
の必ず後に呼ばれる。
一つのテストクラスにはテストに必要なだけ複数のTestRule
を置くことができる。Androidのテストを書いていると、InstantTaskExecutorRule
やActivityTestRule
あたりは基本的にどのEnclosedなテストケースでも使うことになり、毎回これを書くのは面倒である。こういったTestRule
も、テスト対象のセットアップをするTestRule
の中に入れ込んでしまうとよい。具体的にはRuleChain
を使って必要なTestRule
をまとめるなどして、テストケースの為に作ったTestRule.apply()
の中でRuleChain
のapplyを呼んでやる。
override fun apply(base: Statement?, description: Description?): Statement { return RuleChain.outerRule(...) .around(...) .around(...) .apply(super.apply(base, description), description) }
こんなかんじ。