Merge branch 'main' into dev-compose

Author: JoseAlcerreca

.github/workflows/blueprints.yaml

@@ -3,10 +3,12 @@ name: blueprints
 on:
   push:
     branches:
-      - dev-compose
+      - main
+      - views
   pull_request:
     branches:
-      - dev-compose
+      - main
+      - views
 
 jobs:
   build:
@@ -49,7 +51,7 @@ jobs:
     timeout-minutes: 30
     strategy:
       matrix:
-        api-level: [23, 29]
+        api-level: [24, 29]
 
     steps:
       - name: Checkout

app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/MainCoroutineRule.kt

@@ -16,45 +16,35 @@
 
 package com.example.android.architecture.blueprints.todoapp
 
-import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.TestCoroutineScope
+import kotlinx.coroutines.test.TestDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import kotlinx.coroutines.test.resetMain
 import kotlinx.coroutines.test.setMain
 import org.junit.rules.TestWatcher
 import org.junit.runner.Description
-import kotlin.coroutines.ContinuationInterceptor
 
 /**
- * Sets the main coroutines dispatcher to a [TestCoroutineScope] for unit testing. A
- * [TestCoroutineScope] provides control over the execution of coroutines.
+ * Sets the main coroutines dispatcher to a [TestDispatcher] for unit testing.
  *
  * Declare it as a JUnit Rule:
  *
  * ```
  * @get:Rule
- * var mainCoroutineRule = MainCoroutineRule()
+ * val mainCoroutineRule = MainCoroutineRule()
  * ```
  *
- * Use it directly as a [TestCoroutineScope]:
- *
- * ```
- * mainCoroutineRule.pauseDispatcher()
- * ...
- * mainCoroutineRule.resumeDispatcher()
- * ...
- * mainCoroutineRule.runBlockingTest { }
- * ...
- *
- * ```
+ * Then, use `runTest` to execute your tests.
  */
 @ExperimentalCoroutinesApi
-class MainCoroutineRule : TestWatcher(), TestCoroutineScope by TestCoroutineScope() {
+class MainCoroutineRule(
+    val testDispatcher: TestDispatcher = UnconfinedTestDispatcher()
+) : TestWatcher() {
 
     override fun starting(description: Description?) {
         super.starting(description)
-        Dispatchers.setMain(this.coroutineContext[ContinuationInterceptor] as CoroutineDispatcher)
+        Dispatchers.setMain(testDispatcher)
     }
 
     override fun finished(description: Description?) {

app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksDaoTest.kt

@@ -24,7 +24,7 @@ import androidx.test.filters.SmallTest
 import com.example.android.architecture.blueprints.todoapp.MainCoroutineRule
 import com.example.android.architecture.blueprints.todoapp.data.Task
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.test.runTest
 import org.hamcrest.CoreMatchers.`is`
 import org.hamcrest.CoreMatchers.notNullValue
 import org.hamcrest.MatcherAssert.assertThat
@@ -44,11 +44,11 @@ class TasksDaoTest {
     // Set the main coroutines dispatcher for unit testing.
     @ExperimentalCoroutinesApi
     @get:Rule
-    var mainCoroutineRule = MainCoroutineRule()
+    val mainCoroutineRule = MainCoroutineRule()
 
     // Executes each task synchronously using Architecture Components.
     @get:Rule
-    var instantExecutorRule = InstantTaskExecutorRule()
+    val instantExecutorRule = InstantTaskExecutorRule()
 
     @Before
     fun initDb() {
@@ -64,7 +64,7 @@ class TasksDaoTest {
     fun closeDb() = database.close()
 
     @Test
-    fun insertTaskAndGetById() = runBlockingTest {
+    fun insertTaskAndGetById() = runTest {
         // GIVEN - insert a task
         val task = Task("title", "description")
         database.taskDao().insertTask(task)
@@ -81,7 +81,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun insertTaskReplacesOnConflict() = runBlockingTest {
+    fun insertTaskReplacesOnConflict() = runTest {
         // Given that a task is inserted
         val task = Task("title", "description")
         database.taskDao().insertTask(task)
@@ -99,7 +99,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun insertTaskAndGetTasks() = runBlockingTest {
+    fun insertTaskAndGetTasks() = runTest {
         // GIVEN - insert a task
         val task = Task("title", "description")
         database.taskDao().insertTask(task)
@@ -116,7 +116,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun updateTaskAndGetById() = runBlockingTest {
+    fun updateTaskAndGetById() = runTest {
         // When inserting a task
         val originalTask = Task("title", "description")
         database.taskDao().insertTask(originalTask)
@@ -134,7 +134,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun updateCompletedAndGetById() = runBlockingTest {
+    fun updateCompletedAndGetById() = runTest {
         // When inserting a task
         val task = Task("title", "description", true)
         database.taskDao().insertTask(task)
@@ -151,7 +151,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun deleteTaskByIdAndGettingTasks() = runBlockingTest {
+    fun deleteTaskByIdAndGettingTasks() = runTest {
         // Given a task inserted
         val task = Task("title", "description")
         database.taskDao().insertTask(task)
@@ -165,7 +165,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun deleteTasksAndGettingTasks() = runBlockingTest {
+    fun deleteTasksAndGettingTasks() = runTest {
         // Given a task inserted
         database.taskDao().insertTask(Task("title", "description"))
 
@@ -178,7 +178,7 @@ class TasksDaoTest {
     }
 
     @Test
-    fun deleteCompletedTasksAndGettingTasks() = runBlockingTest {
+    fun deleteCompletedTasksAndGettingTasks() = runTest {
         // Given a completed task inserted
         database.taskDao().insertTask(Task("completed", "task", true))
 

app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSourceTest.kt

@@ -27,7 +27,7 @@ import com.example.android.architecture.blueprints.todoapp.data.source.TasksData
 import com.example.android.architecture.blueprints.todoapp.data.succeeded
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.test.runTest
 import org.hamcrest.CoreMatchers.`is`
 import org.hamcrest.MatcherAssert.assertThat
 import org.junit.After
@@ -50,11 +50,11 @@ class TasksLocalDataSourceTest {
     // Set the main coroutines dispatcher for unit testing.
     @ExperimentalCoroutinesApi
     @get:Rule
-    var mainCoroutineRule = MainCoroutineRule()
+    val mainCoroutineRule = MainCoroutineRule()
 
     // Executes each task synchronously using Architecture Components.
     @get:Rule
-    var instantExecutorRule = InstantTaskExecutorRule()
+    val instantExecutorRule = InstantTaskExecutorRule()
 
     @Before
     fun setup() {
@@ -75,7 +75,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun saveTask_retrievesTask() = runBlockingTest {
+    fun saveTask_retrievesTask() = runTest {
         // GIVEN - a new task saved in the database
         val newTask = Task("title", "description", true)
         localDataSource.saveTask(newTask)
@@ -92,7 +92,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun completeTask_retrievedTaskIsComplete() = runBlockingTest {
+    fun completeTask_retrievedTaskIsComplete() = runTest {
         // Given a new task in the persistent repository
         val newTask = Task("title")
         localDataSource.saveTask(newTask)
@@ -109,7 +109,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun activateTask_retrievedTaskIsActive() = runBlockingTest {
+    fun activateTask_retrievedTaskIsActive() = runTest {
         // Given a new completed task in the persistent repository
         val newTask = Task("Some title", "Some description", true)
         localDataSource.saveTask(newTask)
@@ -127,7 +127,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun clearCompletedTask_taskNotRetrievable() = runBlockingTest {
+    fun clearCompletedTask_taskNotRetrievable() = runTest {
         // Given 2 new completed tasks and 1 active task in the persistent repository
         val newTask1 = Task("title")
         val newTask2 = Task("title2")
@@ -153,7 +153,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun deleteAllTasks_emptyListOfRetrievedTask() = runBlockingTest {
+    fun deleteAllTasks_emptyListOfRetrievedTask() = runTest {
         // Given a new task in the persistent repository and a mocked callback
         val newTask = Task("title")
 
@@ -168,7 +168,7 @@ class TasksLocalDataSourceTest {
     }
 
     @Test
-    fun getTasks_retrieveSavedTasks() = runBlockingTest {
+    fun getTasks_retrieveSavedTasks() = runTest {
         // Given 2 new tasks in the persistent repository
         val newTask1 = Task("title")
         val newTask2 = Task("title")

app/src/test/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskViewModelTest.kt

@@ -23,7 +23,12 @@ import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.data.source.FakeRepository
 import com.example.android.architecture.blueprints.todoapp.getOrAwaitValue
 import com.google.common.truth.Truth.assertThat
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.StandardTestDispatcher
+import kotlinx.coroutines.test.advanceUntilIdle
+import kotlinx.coroutines.test.runTest
+import kotlinx.coroutines.test.setMain
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -43,11 +48,11 @@ class AddEditTaskViewModelTest {
     // Set the main coroutines dispatcher for unit testing.
     @ExperimentalCoroutinesApi
     @get:Rule
-    var mainCoroutineRule = MainCoroutineRule()
+    val mainCoroutineRule = MainCoroutineRule()
 
     // Executes each task synchronously using Architecture Components.
     @get:Rule
-    var instantExecutorRule = InstantTaskExecutorRule()
+    val instantExecutorRule = InstantTaskExecutorRule()
 
     private val task = Task("Title1", "Description1")
 
@@ -78,9 +83,9 @@ class AddEditTaskViewModelTest {
     }
 
     @Test
-    fun loadTasks_loading() {
-        // Pause dispatcher so we can verify initial values
-        mainCoroutineRule.pauseDispatcher()
+    fun loadTasks_loading() = runTest {
+        // Set Main dispatcher to not run coroutines eagerly, for just this one test
+        Dispatchers.setMain(StandardTestDispatcher())
 
         // Load the task in the viewmodel
         addEditTaskViewModel.start(task.id)
@@ -89,7 +94,7 @@ class AddEditTaskViewModelTest {
         assertThat(addEditTaskViewModel.dataLoading.getOrAwaitValue()).isTrue()
 
         // Execute pending coroutines actions
-        mainCoroutineRule.resumeDispatcher()
+        advanceUntilIdle()
 
         // Then progress indicator is hidden
         assertThat(addEditTaskViewModel.dataLoading.getOrAwaitValue()).isFalse()