Bug 2011889 - Update UndoMiddlewareTest to use standard coroutine testing APIs. r=android-reviewers,giorga

Differential Revision: https://phabricator.services.mozilla.com/D280052

Author: mcarare

mobile/android/android-components/components/feature/session/src/test/java/mozilla/components/feature/session/middleware/undo/UndoMiddlewareTest.kt

@@ -4,32 +4,29 @@
 
 package mozilla.components.feature.session.middleware.undo
 
+import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.TestDispatcher
+import kotlinx.coroutines.test.runTest
 import kotlinx.coroutines.withContext
 import mozilla.components.browser.state.action.TabListAction
 import mozilla.components.browser.state.action.UndoAction
 import mozilla.components.browser.state.selector.selectedTab
 import mozilla.components.browser.state.state.BrowserState
 import mozilla.components.browser.state.state.createTab
 import mozilla.components.browser.state.store.BrowserStore
-import mozilla.components.support.test.rule.MainCoroutineRule
-import mozilla.components.support.test.rule.runTestOnMain
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
 import org.junit.Assert.assertTrue
-import org.junit.Rule
 import org.junit.Test
 
 class UndoMiddlewareTest {
-    @get:Rule
-    val coroutinesTestRule = MainCoroutineRule()
-    private val dispatcher = coroutinesTestRule.testDispatcher
+    private val testDispatcher = StandardTestDispatcher()
 
     @Test
-    fun `Undo scenario - Removing single tab`() = runTestOnMain {
+    fun `Undo scenario - Removing single tab`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -51,17 +48,17 @@ class UndoMiddlewareTest {
         assertEquals(1, store.state.tabs.size)
         assertEquals("https://getpocket.com", store.state.selectedTab!!.content.url)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(2, store.state.tabs.size)
         assertEquals("https://www.mozilla.org", store.state.selectedTab!!.content.url)
     }
 
     @Test
-    fun `Undo scenario - Removing list of tabs`() = runTestOnMain {
+    fun `Undo scenario - Removing list of tabs`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -83,17 +80,17 @@ class UndoMiddlewareTest {
         assertEquals(1, store.state.tabs.size)
         assertEquals("https://firefox.com", store.state.selectedTab!!.content.url)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(3, store.state.tabs.size)
         assertEquals("https://www.mozilla.org", store.state.selectedTab!!.content.url)
     }
 
     @Test
-    fun `Undo scenario - Removing all normal tabs`() = runTestOnMain {
+    fun `Undo scenario - Removing all normal tabs`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -115,17 +112,17 @@ class UndoMiddlewareTest {
         assertEquals(1, store.state.tabs.size)
         assertNull(store.state.selectedTab)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(3, store.state.tabs.size)
         assertEquals("https://getpocket.com", store.state.selectedTab!!.content.url)
     }
 
     @Test
-    fun `Undo scenario - Removing all tabs`() = runTestOnMain {
+    fun `Undo scenario - Removing all tabs`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -147,17 +144,17 @@ class UndoMiddlewareTest {
         assertEquals(0, store.state.tabs.size)
         assertNull(store.state.selectedTab)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(3, store.state.tabs.size)
         assertEquals("https://getpocket.com", store.state.selectedTab!!.content.url)
     }
 
     @Test
-    fun `Undo scenario - Removing all tabs non-recoverable`() = runTestOnMain {
+    fun `Undo scenario - Removing all tabs non-recoverable`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -179,16 +176,16 @@ class UndoMiddlewareTest {
         assertEquals(0, store.state.tabs.size)
         assertNull(store.state.selectedTab)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(0, store.state.tabs.size)
     }
 
     @Test
-    fun `Undo History in State is written`() = runTestOnMain {
+    fun `Undo History in State is written`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000),
+                UndoMiddleware(clearAfterMillis = 60000, this, this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -223,7 +220,7 @@ class UndoMiddlewareTest {
         assertEquals("https://getpocket.com", store.state.undoHistory.tabs[1].state.url)
         assertEquals(0, store.state.tabs.size)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertNull(store.state.undoHistory.selectedTabId)
         assertTrue(store.state.undoHistory.tabs.isEmpty())
@@ -234,10 +231,10 @@ class UndoMiddlewareTest {
     }
 
     @Test
-    fun `Undo History gets cleared after time`() = runTestOnMain {
+    fun `Undo History gets cleared after time`() = runTest(testDispatcher) {
         val store = BrowserStore(
             middleware = listOf(
-                UndoMiddleware(clearAfterMillis = 60000, waitScope = coroutinesTestRule.scope),
+                UndoMiddleware(clearAfterMillis = 60000, waitScope = this, mainScope = this),
             ),
             initialState = BrowserState(
                 tabs = listOf(
@@ -262,14 +259,14 @@ class UndoMiddlewareTest {
         assertEquals("https://www.mozilla.org", store.state.undoHistory.tabs[0].state.url)
         assertEquals("https://getpocket.com", store.state.undoHistory.tabs[1].state.url)
 
-        dispatcher.scheduler.advanceUntilIdle()
+        testDispatcher.scheduler.advanceUntilIdle()
 
         assertNull(store.state.undoHistory.selectedTabId)
         assertTrue(store.state.undoHistory.tabs.isEmpty())
         assertEquals(1, store.state.tabs.size)
         assertEquals("https://reddit.com/r/firefox", store.state.tabs[0].content.url)
 
-        restoreRecoverableTabs(dispatcher, store)
+        restoreRecoverableTabs(testDispatcher, store)
 
         assertEquals(1, store.state.tabs.size)
         assertEquals("https://reddit.com/r/firefox", store.state.tabs[0].content.url)