memorandum
タグ
言語

AndroidのテストタスクだけGradleでログ出力する

2015/12/01
2021/02/25
Gradle Travis CI Android

久々のAndroid関連ネタ。
Android-ObservableScrollViewでは、なるべくカバレッジ100%になるようテストを書こうとしている。
しかしテストが増えてきたせいか、Travis CIでのテスト実行中に出力がない時間が10分以上続いてしまい、ビルドが失敗することが多くなってきた。
テスト系のタスクだけもう少しログ出力させられないか？
を解決する方法について紹介する。

まず、テスト系限定でなく、すべてのタスクに対してINFOレベルでログ出力するのならGradle的には以下のように--infoなどをつければいい。

./gradlew connectedCheck --info

しかしすべてのタスクがINFOレベルで出力されるのは
見づらくなるだけなので避けたい。

Javaプラグインが適用できればtestクロージャにtestLoggingなどの設定を書くことで実現できるようなのだが、AndroidライブラリにJavaプラグインを適用するのは避けたい。

結論としては次のように書けばテストの状況がログ出力されるようになる。

afterEvaluate { project ->
    tasks.withType(VerificationTask) {
        logging.level = LogLevel.INFO
    }
}

以下はMacでNexus5を接続してテストした時の様子。

➜  Android-ObservableScrollView git:(master) ✗ ./gradlew library:connectedCheck -s
:library:preBuild UP-TO-DATE
:library:preDebugBuild UP-TO-DATE
:library:compileDebugNdk UP-TO-DATE
:library:compileLint
:library:copyDebugLint UP-TO-DATE
:library:checkDebugManifest
...
:library:connectedDebugAndroidTest
Starting 61 tests on Nexus 5 - 6.0

com.github.ksoichiro.android.observablescrollview.SavedStateTest > testGridViewSavedState[Nexus 5 - 6.0] SUCCESS 

com.github.ksoichiro.android.observablescrollview.SavedStateTest > testListViewSavedState[Nexus 5 - 6.0] SUCCESS 

com.github.ksoichiro.android.observablescrollview.SavedStateTest > testRecyclerViewSavedState[Nexus 5 - 6.0] SUCCESS 

com.github.ksoichiro.android.observablescrollview.SavedStateTest > testScrollViewSavedState[Nexus 5 - 6.0] SUCCESS 
...

テストの進捗状況がわかるので、Travis CIに限らずローカルでの実行時にも有用かも。

先ほどの設定をもう少し詳しく説明する。
まず次のようにすると、connectedDebugAndroidTestタスクに対してINFOレベルでログ出力させるような指示になる。

tasks.connectedDebugAndroidTest {
    logging.level = LogLevel.INFO
}

connectedDebugAndroidTestはconnectedAndroidTestのうちDebugのBuildTypeに対応するタスク。

しかしこれはうまくいかない。
connectedDebugAndroidTestタスクが定義されるのはGradleの評価(evaluation)が終わってからなので、上記を記述して実行するとビルド失敗する。

そこで次のようにすれば、評価が終わってBuildTypeごとのタスクが定義された状態でアクセスできるので、正常に設定することができる。

afterEvaluate { project ->
    tasks.connectedDebugAndroidTest {
        logging.level = LogLevel.INFO
    }
}

connectedDebugAndroidTestという特定のタスクを書きたくない(複数のBuildTypeやFlavorをテストしたい)という場合は、

afterEvaluate { project ->
    tasks.withType(VerificationTask) {
        logging.level = LogLevel.INFO
    }
}

とすればorg.gradle.api.tasks.VerificationTaskを実装したタスクに対してはすべて設定を適用できる。
ただし、Android Gradle Pluginの今後の仕様によっては使えなくなる可能性もあるかもしれない(VerificationTaskをimplementしなくなるかも)。
上記の動作を確認したのはPluginのv1.5.0。

なお、VerificationTaskの部分をAndroidTestTaskとしなかったのは、このタスクはcom.android.build.gradle.internal.tasksパッケージに属しており、外部から使うべきではないだろうと考えたため。

© 2010 ksoichiro