コルーチンのエラーをテストするためのTips / Tips for testing Kotlin Coroutine errors

DeNA.apk#4(https://dena.connpass.com/event/274954/)の発表資料です。

Transcript

1. コルーチンのエラーをテストする
   ためのTips
   DeNA.apk#4 Nozomi Takuma
   

   View Slide

2. 自己紹介
   ● Nozomi Takuma
   ● DeNA SWETグループ
   ○ 兼務: Pococha事業部システム部
   ● Androidとテストが好き
   

   View Slide

3. 今日話すこと
   

   View Slide

4. 今日話すこと
   ● suspend関数からthrowされるExceptionをテストする
   ● ViewModelScope内でのExceptionの振る舞い
   

   View Slide

5. suspend関数から
   throwされるExceptionをテストする
   

   View Slide

6. テスト対象のコード
   class NewsRepository(
   private val networkDataSource: NetworkDataSource
   ) {
   suspend fun getNewsResources(): List {
   return networkDataSource.getNewsResources()
   }
   }
   API通信をするsuspend関数
   APIからエラーが返ってきたときは
   そのままthrowされる
   

   View Slide

7. Exceptionをthrowする関数のテストの書き方①
   @Test(expected = HttpException::class)
   fun getNewsResources() = runTest {
   // 省略. APIエラーを返すスタブの設定
   val newsRepository = NewsRepository(testDataSource)
   newsRepository.getNewsResources()
   }
   

   View Slide

8. Exceptionをthrowするsuspend関数のテストの書き方①
   @Test(expected = HttpException::class)
   fun getNewsResources() = runTest {
   // 省略. APIエラーを返すスタブの設定
   val newsRepository = NewsRepository(testDataSource)
   newsRepository.getNewsResources()
   }
   Exceptionがthrowされるsuspend
   関数を実行
   

   View Slide

9. Exceptionをthrowするsuspend関数のテストの書き方①
   @Test(expected = HttpException::class)
   fun getNewsResources() = runTest {
   // 省略. APIエラーを返すスタブの設定
   val newsRepository = NewsRepository(testDataSource)
   newsRepository.getNewsResources()
   }
   Throwされるクラスを指定
   同じ型のThrowableが投げられたら成功
   Throwableが投げられなかったり、違う
   型だった場合はテスト失敗
   

   View Slide

10. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertThrows(HttpException::class.java) {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    

    View Slide

11. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertThrows(HttpException::class.java) {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    Junit4に入っているThrowable用の
    アサーション
    ブロックの中でthrowする関数を呼び出す
    

    View Slide

12. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertThrows(HttpException::class.java) {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    Throwableの型 + インスタンス
    に対してアサートをすることが
    できる
    

    View Slide

13. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertThrows(HttpException::class.java) {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    

    View Slide

14. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertThrows(HttpException::class.java) {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    Junit4のassertThrowsのブロックの中で
    は直接suspend関数を呼び出せない
    (Junit5のassertThrowsは可)
    

    View Slide

15. Exceptionをthrowするsuspend関数のテストの書き方②
    build.gradle
    testImplementation "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
    

    View Slide

16. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertFailWith {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    

    View Slide

17. Exceptionをthrowするsuspend関数のテストの書き方②
    @Test
    fun getNewsResources() = runTest {
    ..
    val exception = assertFailWith {
    newsRepository.getNewsResources()
    }
    assertEquals("error", exception.message())
    }
    インライン関数なのでTestScopeの中で
    実行できる
    

    View Slide

18. ViewModelScope内でのExceptionの振る舞い
    

    View Slide

19. テスト対象のコード
    class NewsViewModel : ViewModel() {
    fun bookmarkNews(newsResourceId: String, bookmarked: Boolean) {
    viewModelScope.launch {
    throw IOException()
    }
    }
    }
    

    View Slide

20. テスト対象のコード
    class NewsViewModel : ViewModel() {
    fun bookmarkNews(newsResourceId: String, bookmarked: Boolean) {
    viewModelScope.launch {
    throw IOException()
    }
    }
    }
    viewModelScope内で例外が発生
    エラーハンドリングをし忘れている
    

    View Slide

21. テストコード
    @Test
    fun bookmarkNews() {
    viewModel.bookmarkNews("id", true)
    }
    

    View Slide

22. テストコード
    @Test
    fun bookmarkNews() {
    viewModel.bookmarkNews("id", true)
    }
    

    View Slide

23. テストコード
    @Test
    fun bookmarkNews() {
    viewModel.bookmarkNews("id", true)
    }
    例外が握りつぶされている
    

    View Slide

24. ViewModelで問題になるのはなぜ？
    @Test(expected = HttpException::class)
    fun getNewsResources() = runTest {
    val newsRepository = NewsRepository(testDataSource)
    newsRepository.getNewsResources()
    }
    

    View Slide

25. ViewModelで問題になるのはなぜ？
    @Test(expected = HttpException::class)
    fun getNewsResources() = runTest {
    val newsRepository = NewsRepository(testDataSource)
    newsRepository.getNewsResources()
    }
    ブロックの中はTestScopeで実行される
    

    View Slide

26. ViewModelで問題になるのはなぜ？
    public val ViewModel.viewModelScope: CoroutineScope
    get() {
    val scope: CoroutineScope? = this.getTag(JOB_KEY)
    if (scope != null) {
    return scope
    }
    return setTagIfAbsent(
    JOB_KEY,
    CloseableCoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
    )
    }
    

    View Slide

27. ViewModelで問題になるのはなぜ？
    public val ViewModel.viewModelScope: CoroutineScope
    get() {
    val scope: CoroutineScope? = this.getTag(JOB_KEY)
    if (scope != null) {
    return scope
    }
    return setTagIfAbsent(
    JOB_KEY,
    CloseableCoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
    )
    }
    

    View Slide

28. 関連するIssue
    TestCoroutineDispatcher swallows exceptions #1205
    https://github.com/Kotlin/kotlinx.coroutines/issues/1205
    

    View Slide

29. ViewModel 2.5.0でのアップデート
    public ViewModel(@NonNull Closeable... closeables) {
    mCloseables.addAll(Arrays.asList(closeables));
    }
    

    View Slide

30. ViewModel 2.5.0でのアップデート
    public ViewModel(@NonNull Closeable... closeables) {
    mCloseables.addAll(Arrays.asList(closeables));
    }
    onClearで閉じられる
    

    View Slide

31. ViewModel 2.5.0でのアップデート
    class CloseableCoroutineScope(
    context: CoroutineContext = SupervisorJob() + Dispatchers.Main.immediate
    ) : Closeable, CoroutineScope {
    override val coroutineContext: CoroutineContext = context
    override fun close() {
    coroutineContext.cancel()
    }
    }
    Closableを実装した
    CoroutineScopeを用意
    

    View Slide

32. ViewModel 2.5.0でのアップデート
    class NewsViewModel(
    val customScope: CloseableCoroutineScope = CloseableCoroutineScope()
    ) : ViewModel(customScope) {
    fun bookmarkNews(newsResourceId: String, bookmarked: Boolean) {
    customScope.launch {
    throw IOException()
    }
    }
    }
    

    View Slide

33. ViewModel 2.5.0でのアップデート
    class NewsViewModel(
    val customScope: CloseableCoroutineScope = CloseableCoroutineScope()
    ) : ViewModel(customScope) {
    fun bookmarkNews(newsResourceId: String, bookmarked: Boolean) {
    customScope.launch {
    throw IOException()
    }
    }
    }
    ViewModelScopeと同じように使える
    

    View Slide

34. テストコードの変更
    @Test
    fun bookmarkNews() = runTest {
    val scope = CloseableCoroutineScope(coroutineContext + UnconfinedTestDispatcher())
    val newsViewModel = NewsViewModel(scope)
    newsViewModel.bookmarkNews("id", true)
    }
    

    View Slide

35. テストコードの変更
    @Test
    fun bookmarkNews() = runTest {
    val scope = CloseableCoroutineScope(coroutineContext + UnconfinedTestDispatcher())
    val newsViewModel = NewsViewModel(scope)
    newsViewModel.bookmarkNews("id", true)
    }
    TestScopeから
    ClosableCoroutineScopeを作る
    

    View Slide

36. テストコードの変更
    @Test
    fun bookmarkNews() = runTest {
    val scope = CloseableCoroutineScope(coroutineContext + UnconfinedTestDispatcher())
    val newsViewModel = NewsViewModel(scope)
    newsViewModel.bookmarkNews("id", true)
    } ViewModelに渡す
    

    View Slide

37. テストコードの変更
    @Test
    fun bookmarkNews() = runTest {
    val scope = CloseableCoroutineScope(this.coroutineContext + UnconfinedTestDispatcher())
    val newsViewModel = NewsViewModel(scope)
    newsViewModel.bookmarkNews("id", true)
    }
    

    View Slide

38. まとめ
    

    View Slide

39. 今日話したこと
    ● suspend関数からthrowされるExceptionをテストする
    ○ @Test(expected = Throwable)
    ○ Kotlin Test LibraryのassertFailWithも便利
    ● ViewModelScope内でのExceptionの振る舞い
    ○ Exception発生時にテストをコケさせるためには工夫がいる
    ○ エラーハンドリング漏れには注意しよう
    

    View Slide

40. ご清聴ありがとうございました！
    

    View Slide