Android: 通常実行とJUnitテスト実行で共通のロギングコードを用いる

テスト対象コードにAndroidフレームワークのコードが入っていると、JUnitテスト実行時に例外が発生します。

java.lang.RuntimeException: Method e in android.util.Log not mocked. See https://sites.google.com/a/android.com/tools/tech-docs/unit-testing-support for details.
 at android.util.Log.e(Log.java)
 at yukihane.dq10don.login.LoginJsonParse.processHTML(LoginJsonParse.java:32)
 at yukihane.dq10don.login.LoginJsonParseTest.testProcessHTML(LoginJsonParseTest.java:42)
 at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
 at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
 at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
 at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)

モック化して対処する(例外メッセージに記載されているURL先の記述通り、自動でモック化するオプションもあります)のが適切な場合もありますが、まずはじめに考えるべきことは、Androidフレームワークに依存しない処理に切り出し、それをテスト対象とする、ということでしょう。

ただ、今回はデバッグログ出力を行いたい処理(android.util.Logを使っている)であり、この対処は適切ではありません。

かといってモック化も不適切です(ログ出力が処理に影響を与えるわけではないので)。

そんなわけでloggerを使用して、Androidフレームワークを用いた実行(androidTestやエミュレータ/実機上での実行)と、JUnitテスト実行でlogging実装を差し替えることにしました。

検索した限りでは、Androidのデファクトスタンダート的なものはなさそうです。

今回はslf4j-androidを用いることにしました。

/app/build.gradle のdependencies内に以下を追記するだけです。

dependencies {
(略)
    compile 'org.slf4j:slf4j-android:1.7.12'
    testCompile 'org.slf4j:slf4j-simple:1.7.12'
}

この設定により、通常実行時にはslf4j-androidに含まれているandroid.util.Logを用いた実装が、JUnitテスト実行時にはslf4j-simpleを用いた標準エラー出力に吐く実装が使用されます。

(注: JUnit実行時には、classpath上に複数のlogging実装があると警告されます。どちらを選ぶかを明示的に選択することはできるのだろうか…)

• 設定例
• 使用例

なお、テスト実行で用いているsimpleloggerの設定は、 /app/src/test/resources/simplelogger.properties ファイルやシステムプロパティで行えます。

詳しくはjavadocを参照してみてください。