Test: Replace deprecated test coroutine dispatcher and run blocking test

Author: ParaskP7

Simplenote/src/test/java/com/automattic/simplenote/usecases/GetTagsUseCaseTest.kt

@@ -1,19 +1,18 @@
 package com.automattic.simplenote.usecases
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.models.Note
 import com.automattic.simplenote.models.Tag
 import com.automattic.simplenote.models.TagItem
-import com.automattic.simplenote.repositories.CollaboratorsRepository
 import com.automattic.simplenote.repositories.SimperiumCollaboratorsRepository
 import com.automattic.simplenote.repositories.TagsRepository
 import com.simperium.client.Bucket
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
-import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.Assert.assertEquals
 import org.junit.Before
-import org.junit.Ignore
 import org.junit.Rule
 import org.junit.Test
 import org.mockito.Mockito.mock
@@ -23,11 +22,17 @@ import org.mockito.kotlin.stub
 
 @ExperimentalCoroutinesApi
 class GetTagsUseCaseTest {
-    @get:Rule val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val notesBucket = mock(Bucket::class.java) as Bucket<Note>
     private val tagsRepository: TagsRepository = mock(TagsRepository::class.java)
-    private val collaboratorsRepository = SimperiumCollaboratorsRepository(notesBucket, TestCoroutineDispatcher())
+    private val collaboratorsRepository = SimperiumCollaboratorsRepository(
+        notesBucket,
+        coroutinesTestRule.testDispatcher
+    )
     private val getTagsUseCase: GetTagsUseCase = GetTagsUseCase(tagsRepository, collaboratorsRepository)
     private val tagItems = listOf(
         TagItem(Tag("tag1"), 0),
@@ -46,7 +51,7 @@ class GetTagsUseCaseTest {
     }
 
     @Test
-    fun allTagsShouldFilterCollaborators() = runBlockingTest {
+    fun allTagsShouldFilterCollaborators() = runTest {
         tagsRepository.stub { onBlocking { allTags() }.doReturn(tagItems) }
 
 
@@ -59,7 +64,7 @@ class GetTagsUseCaseTest {
     }
 
     @Test
-    fun searchTagsShouldFilterCollaborators() = runBlockingTest {
+    fun searchTagsShouldFilterCollaborators() = runTest {
         val searchTagItems = listOf(
             TagItem(Tag("tag1"), 0),
             TagItem(Tag("tag2"), 2),

Simplenote/src/test/java/com/automattic/simplenote/usecases/ValidateTagUseCaseTest.kt

@@ -1,23 +1,30 @@
 package com.automattic.simplenote.usecases
 
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.models.Note
 import com.automattic.simplenote.repositories.SimperiumCollaboratorsRepository
 import com.automattic.simplenote.repositories.TagsRepository
 import com.automattic.simplenote.usecases.ValidateTagUseCase.TagValidationResult
 import com.simperium.client.Bucket
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import org.junit.Assert.assertEquals
+import org.junit.Rule
 import org.junit.Test
 import org.mockito.Mockito
 import org.mockito.kotlin.any
 import org.mockito.kotlin.whenever
 
 @ExperimentalCoroutinesApi
 class ValidateTagUseCaseTest {
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
     private val notesBucket = Mockito.mock(Bucket::class.java) as Bucket<Note>
     private val tagsRepository: TagsRepository = Mockito.mock(TagsRepository::class.java)
-    private val collaboratorsRepository = SimperiumCollaboratorsRepository(notesBucket, TestCoroutineDispatcher())
+    private val collaboratorsRepository = SimperiumCollaboratorsRepository(
+        notesBucket,
+        coroutinesTestRule.testDispatcher
+    )
     private val validateTagUseCase = ValidateTagUseCase(tagsRepository, collaboratorsRepository)
 
     @Test

Simplenote/src/test/java/com/automattic/simplenote/viewmodels/AddTagViewModelTest.kt

@@ -1,6 +1,7 @@
 package com.automattic.simplenote.viewmodels
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.R
 import com.automattic.simplenote.models.Note
 import com.automattic.simplenote.repositories.SimperiumCollaboratorsRepository
@@ -9,7 +10,7 @@ import com.automattic.simplenote.usecases.ValidateTagUseCase
 import com.automattic.simplenote.utils.getLocalRandomStringOfLen
 import com.simperium.client.Bucket
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
 import org.junit.Rule
@@ -19,11 +20,17 @@ import org.mockito.Mockito.mock
 
 @ExperimentalCoroutinesApi
 class AddTagViewModelTest {
-    @get:Rule val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val fakeTagsRepository = mock(TagsRepository::class.java)
     private val notesBucket = mock(Bucket::class.java) as Bucket<Note>
-    private val collaboratorsRepository = SimperiumCollaboratorsRepository(notesBucket, TestCoroutineDispatcher())
+    private val collaboratorsRepository = SimperiumCollaboratorsRepository(
+        notesBucket,
+        coroutinesTestRule.testDispatcher
+    )
     private val validateTagUseCase = ValidateTagUseCase(fakeTagsRepository, collaboratorsRepository)
     private val viewModel = AddTagViewModel(fakeTagsRepository, validateTagUseCase)
 

Simplenote/src/test/java/com/automattic/simplenote/viewmodels/CompleteMagicLinkViewModelTest.kt

@@ -1,47 +1,45 @@
 package com.automattic.simplenote.viewmodels
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.repositories.MagicLinkRepository
 import com.automattic.simplenote.repositories.MagicLinkResponseResult
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
-import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.Test
 import org.mockito.Mockito
 
 import org.junit.Assert.assertEquals
-import org.junit.Before
 import org.junit.Rule
 
 const val AUTH_KEY_TEST = "auth_key_test"
 const val AUTH_CODE_TEST = "auth_code_test"
 
 @ExperimentalCoroutinesApi
 class CompleteMagicLinkViewModelTest {
-
     @get:Rule
     val instantExecutorRule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val repository: MagicLinkRepository = Mockito.mock(MagicLinkRepository::class.java)
-
-    @Before
-    fun setup() {
-
-    }
+    private val viewModel = CompleteMagicLinkViewModel(
+        repository,
+        coroutinesTestRule.testDispatcher
+    )
 
     @Test
-    fun instantiateViewModel() = runBlockingTest {
-        val viewModel = CompleteMagicLinkViewModel(repository, TestCoroutineDispatcher())
+    fun instantiateViewModel() = runTest {
         assertEquals(MagicLinkUiState.Waiting, viewModel.magicLinkUiState.value)
     }
 
     @Test
-    fun firingPostRequestShouldLeadToSuccess() = runBlockingTest {
+    fun firingPostRequestShouldLeadToSuccess() = runTest {
         Mockito.`when`(
             repository.completeLogin(AUTH_KEY_TEST, AUTH_CODE_TEST)
         ).thenReturn(MagicLinkResponseResult.MagicLinkCompleteSuccess(AUTH_KEY_TEST, AUTH_CODE_TEST))
 
-        val viewModel = CompleteMagicLinkViewModel(repository, TestCoroutineDispatcher())
         val states = mutableListOf<MagicLinkUiState>()
         viewModel.magicLinkUiState.observeForever {
             states.add(it)
@@ -54,12 +52,11 @@ class CompleteMagicLinkViewModelTest {
     }
 
     @Test
-    fun firingPostRequestShouldLeadToError() = runBlockingTest {
+    fun firingPostRequestShouldLeadToError() = runTest {
         Mockito.`when`(
             repository.completeLogin(AUTH_KEY_TEST, AUTH_CODE_TEST)
         ).thenReturn(MagicLinkResponseResult.MagicLinkError(code = 400))
 
-        val viewModel = CompleteMagicLinkViewModel(repository, TestCoroutineDispatcher())
         val states = mutableListOf<MagicLinkUiState>()
         viewModel.magicLinkUiState.observeForever {
             states.add(it)

Simplenote/src/test/java/com/automattic/simplenote/viewmodels/NoteEditorViewModelTest.kt

@@ -1,6 +1,7 @@
 package com.automattic.simplenote.viewmodels
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.models.Note
 import com.automattic.simplenote.repositories.SimperiumCollaboratorsRepository
 import com.automattic.simplenote.repositories.TagsRepository
@@ -9,10 +10,9 @@ import com.automattic.simplenote.usecases.ValidateTagUseCase
 import com.automattic.simplenote.viewmodels.NoteEditorViewModel.NoteEditorEvent
 import com.simperium.client.Bucket
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import org.junit.Assert.assertEquals
 import org.junit.Before
-import org.junit.Ignore
 import org.junit.Rule
 import org.junit.Test
 import org.mockito.Mockito.mock
@@ -23,10 +23,15 @@ import org.mockito.kotlin.whenever
 class NoteEditorViewModelTest {
     @get:Rule
     val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val tagsRepository: TagsRepository = mock(TagsRepository::class.java)
     private val notesBucket = mock(Bucket::class.java) as Bucket<Note>
-    private val collaboratorsRepository = SimperiumCollaboratorsRepository(notesBucket, TestCoroutineDispatcher())
+    private val collaboratorsRepository = SimperiumCollaboratorsRepository(
+        notesBucket,
+        coroutinesTestRule.testDispatcher
+    )
     private val getTagsUseCase = GetTagsUseCase(tagsRepository, collaboratorsRepository)
     private val validateTagUseCase = ValidateTagUseCase(tagsRepository, collaboratorsRepository)
     private val viewModel = NoteEditorViewModel(getTagsUseCase, validateTagUseCase)

Simplenote/src/test/java/com/automattic/simplenote/viewmodels/RequestMagicLinkViewModelTest.kt

@@ -1,11 +1,12 @@
 package com.automattic.simplenote.viewmodels
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.repositories.MagicLinkRepository
 import com.automattic.simplenote.repositories.MagicLinkResponseResult
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
-import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.Test
 import org.mockito.Mockito
 
@@ -18,22 +19,26 @@ const val email = "[email protected]"
 class RequestMagicLinkViewModelTest {
     @get:Rule
     val instantExecutorRule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val repository: MagicLinkRepository = Mockito.mock(MagicLinkRepository::class.java)
+    private val viewModel = RequestMagicLinkViewModel(
+        repository,
+        coroutinesTestRule.testDispatcher
+    )
 
     @Test
-    fun instantiateViewModel() = runBlockingTest {
-        val viewModel = RequestMagicLinkViewModel(repository, TestCoroutineDispatcher())
+    fun instantiateViewModel() = runTest {
         assertEquals(MagicLinkRequestUiState.Waiting, viewModel.magicLinkRequestUiState.value)
     }
 
     @Test
-    fun firingPostRequestShouldLeadToSuccess() = runBlockingTest {
+    fun firingPostRequestShouldLeadToSuccess() = runTest {
         Mockito.`when`(
             repository.requestLogin(email)
         ).thenReturn(MagicLinkResponseResult.MagicLinkRequestSuccess(code = 200))
 
-        val viewModel = RequestMagicLinkViewModel(repository, TestCoroutineDispatcher())
         val states = mutableListOf<MagicLinkRequestUiState>()
         viewModel.magicLinkRequestUiState.observeForever {
             states.add(it)
@@ -45,12 +50,11 @@ class RequestMagicLinkViewModelTest {
     }
 
     @Test
-    fun firingPostRequestShouldLeadToError() = runBlockingTest {
+    fun firingPostRequestShouldLeadToError() = runTest {
         Mockito.`when`(
             repository.requestLogin(email)
         ).thenReturn(MagicLinkResponseResult.MagicLinkError(code = 400))
 
-        val viewModel = RequestMagicLinkViewModel(repository, TestCoroutineDispatcher())
         val states = mutableListOf<MagicLinkRequestUiState>()
         viewModel.magicLinkRequestUiState.observeForever {
             states.add(it)

Simplenote/src/test/java/com/automattic/simplenote/viewmodels/TagDialogViewModelTest.kt

@@ -1,6 +1,7 @@
 package com.automattic.simplenote.viewmodels
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.automattic.simplenote.CoroutineTestRule
 import com.automattic.simplenote.R
 import com.automattic.simplenote.models.Note
 import com.automattic.simplenote.models.Tag
@@ -10,7 +11,7 @@ import com.automattic.simplenote.usecases.ValidateTagUseCase
 import com.automattic.simplenote.utils.getLocalRandomStringOfLen
 import com.simperium.client.Bucket
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import org.junit.Assert.*
 import org.junit.Before
 import org.junit.Rule
@@ -20,11 +21,17 @@ import org.mockito.Mockito.mock
 
 @ExperimentalCoroutinesApi
 class TagDialogViewModelTest {
-    @get:Rule val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val rule = InstantTaskExecutorRule()
+    @get:Rule
+    val coroutinesTestRule = CoroutineTestRule(UnconfinedTestDispatcher())
 
     private val fakeTagsRepository = mock(TagsRepository::class.java)
     private val notesBucket = mock(Bucket::class.java) as Bucket<Note>
-    private val collaboratorsRepository = SimperiumCollaboratorsRepository(notesBucket, TestCoroutineDispatcher())
+    private val collaboratorsRepository = SimperiumCollaboratorsRepository(
+        notesBucket,
+        coroutinesTestRule.testDispatcher
+    )
     private val validateTagUseCase = ValidateTagUseCase(fakeTagsRepository, collaboratorsRepository)
     private val viewModel = TagDialogViewModel(fakeTagsRepository, validateTagUseCase)
     private val tagName = "tag1"