Restore behavior of tests passing despite exceptions thrown

This is a hacky workaround for the change in kotlinx.coroutines 1.7.0 that causes tests that throw exceptions to fail. Previously test methods that threw exceptions would not prevent tests from passing, which was a bug in kotlinx.coroutines that has now been fixed. However, significant number of our tests are currently failing because of this change, because we have bugs in the implementation of our test classes, usually related to the way we instantiate the view models in tests.

See the following issue for more details: Kotlin/kotlinx.coroutines#1205. The workaround coming with this commit is taken from the related PR: Kotlin/kotlinx.coroutines#3736 and is a solution suggested by JetBrains to disable the new behavior using non-public API until we fix our tests. This should not be considered a long-term solution, rather a temporary hack.

Author: samiuelson

WooCommerce/src/test/kotlin/com/woocommerce/android/viewmodel/BaseUnitTest.kt

@@ -15,6 +15,22 @@ import org.mockito.junit.MockitoJUnitRunner
 @Suppress("UnnecessaryAbstractClass")
 @RunWith(MockitoJUnitRunner::class)
 abstract class BaseUnitTest(testDispatcher: TestDispatcher = UnconfinedTestDispatcher()) {
+
+    init {
+        // This is a workaround for the change in kotlinx.coroutines 1.7.0 that causes tests that
+        // throw exceptions to fail. Previously test methods that threw exceptions would not prevent
+        // tests from passing, which was a bug in kotlinx.coroutines that has now been fixed. However,
+        // significant number of our tests are currently failing because of this change.
+        //
+        // See the following issue for more details: https://github.com/Kotlin/kotlinx.coroutines/issues/1205.
+        // The workaround below is taken from the related PR: https://github.com/Kotlin/kotlinx.coroutines/pull/3736
+        // and is a solution suggested by JetBrains to disable the new behavior using non-public API
+        // until we fix our tests. This should not be considered a long-term solution, rather a temporary hack.
+        Class.forName("kotlinx.coroutines.test.TestScopeKt")
+            .getDeclaredMethod("setCatchNonTestRelatedExceptions", Boolean::class.java)
+            .invoke(null, false)
+    }
+
     @Rule @JvmField
     val rule = InstantTaskExecutorRule()
 

libs/cardreader/src/test/java/com/woocommerce/android/cardreader/internal/connection/ConnectionManagerTest.kt

@@ -34,6 +34,21 @@ import org.mockito.kotlin.whenever
 
 @ExperimentalCoroutinesApi
 class ConnectionManagerTest : CardReaderBaseUnitTest() {
+    init {
+        // This is a workaround for the change in kotlinx.coroutines 1.7.0 that causes tests that
+        // throw exceptions to fail. Previously test methods that threw exceptions would not prevent
+        // tests from passing, which was a bug in kotlinx.coroutines that has now been fixed. However,
+        // significant number of our tests are currently failing because of this change.
+        //
+        // See the following issue for more details: https://github.com/Kotlin/kotlinx.coroutines/issues/1205.
+        // The workaround below is taken from the related PR: https://github.com/Kotlin/kotlinx.coroutines/pull/3736
+        // and is a solution suggested by JetBrains to disable the new behavior using non-public API
+        // until we fix our tests. This should not be considered a long-term solution, rather a temporary hack.
+        Class.forName("kotlinx.coroutines.test.TestScopeKt")
+            .getDeclaredMethod("setCatchNonTestRelatedExceptions", Boolean::class.java)
+            .invoke(null, false)
+    }
+
     private val terminalWrapper: TerminalWrapper = mock()
     private val bluetoothReaderListener: BluetoothReaderListenerImpl = mock()
     private val discoverReadersAction: DiscoverReadersAction = mock()