TestRuleでテスト対象の初期化処理などをまとめる
テストケースのセットアップ処理を使いまわしたい時、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)
}
こんなかんじ。
