ref: migrate unit tests to junit 5

Author: android10

app/build.gradle.kts

@@ -94,9 +94,11 @@ dependencies {
     implementation(libs.converter.gson)
 
     // Unit/Integration tests dependencies
+    testImplementation(libs.kotest.runner.junit5)
+    testImplementation(libs.kotest.assertions.core)
+    testImplementation(libs.kotest.property)
     testImplementation(libs.junit)
     testImplementation(libs.mockk)
-    testImplementation(libs.kluent.android)
     testImplementation(libs.robolectric)
 
     // UI tests dependencies

app/src/main/AndroidManifest.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest package="com.fernandocejas.sample"
-    xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
 <!--Permissions-->
 <uses-permission android:name="android.permission.INTERNET" />

app/src/test/kotlin/com/fernandocejas/sample/AndroidAssertions.kt

@@ -18,15 +18,23 @@ package com.fernandocejas.sample
 import android.app.Application
 import android.content.Context
 import android.os.Build
+import androidx.appcompat.app.AppCompatActivity
+import io.kotest.matchers.string.shouldBeEqualIgnoringCase
+import io.mockk.MockKAnnotations
 import org.junit.Rule
+import org.junit.rules.TestRule
 import org.junit.runner.RunWith
+import org.robolectric.Robolectric
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.RuntimeEnvironment
+import org.robolectric.Shadows
 import org.robolectric.annotation.Config
+import kotlin.reflect.KClass
 
 /**
- * Base class for Android tests. Inherit from it to create test cases which contain android
- * framework dependencies or components.
+ * Base class for Android tests. Inherit from it to
+ * create test cases which contain android framework
+ * dependencies or components.
  *
  * @see UnitTest
  */
@@ -36,10 +44,36 @@ import org.robolectric.annotation.Config
         sdk = [Build.VERSION_CODES.O_MR1])
 abstract class AndroidTest {
 
+    @Rule
+    @JvmField
     @Suppress("LeakingThis")
-    @Rule @JvmField val injectMocks = InjectMocksRule.create(this@AndroidTest)
+    val injectMocks = InjectMocksRule.create(this@AndroidTest)
 
-    fun context(): Context = RuntimeEnvironment.getApplication().applicationContext
+    fun context(): Context = RuntimeEnvironment.systemContext
 
     internal class ApplicationStub : Application()
+
+    object InjectMocksRule {
+        fun create(testClass: Any) = TestRule { statement, _ ->
+            MockKAnnotations.init(testClass, relaxUnitFun = true)
+            statement
+        }
+    }
+
+    /**
+     * Container for customized Android
+     * specific Test Assertions.
+     */
+    object AndroidAssertions {
+        infix fun KClass<out AppCompatActivity>.shouldNavigateTo(
+            nextActivity: KClass<out AppCompatActivity>
+        ): () -> Unit = {
+
+            val originActivity = Robolectric.buildActivity(this.java).get()
+            val shadowActivity = Shadows.shadowOf(originActivity)
+            val nextIntent = shadowActivity.peekNextStartedActivity()
+
+            nextIntent.component?.className shouldBeEqualIgnoringCase nextActivity.java.canonicalName!!
+        }
+    }
 }

app/src/test/kotlin/com/fernandocejas/sample/AndroidTest.kt

@@ -25,8 +25,5 @@ import org.junit.Rule
  */
 abstract class UnitTest {
 
-    @Suppress("LeakingThis")
-    @Rule @JvmField val injectMocks = InjectMocksRule.create(this@UnitTest)
-
     fun fail(message: String): Nothing = throw AssertionError(message)
 }

app/src/test/kotlin/com/fernandocejas/sample/InjectMocksRule.kt

@@ -19,52 +19,47 @@ import com.fernandocejas.sample.UnitTest
 import com.fernandocejas.sample.core.failure.Failure.ServerError
 import com.fernandocejas.sample.core.functional.Either.Left
 import com.fernandocejas.sample.core.functional.Either.Right
-import org.amshove.kluent.shouldBe
-import org.amshove.kluent.shouldBeInstanceOf
-import org.amshove.kluent.shouldEqual
-import org.amshove.kluent.shouldEqualTo
-import org.junit.Test
+import io.kotest.matchers.equals.shouldBeEqual
+import io.kotest.matchers.shouldBe
+import org.junit.jupiter.api.Test
 
 class EitherTest : UnitTest() {
 
-    @Test fun `Either Right should return correct type`() {
+    @Test
+    fun `Either Right should return correct type`() {
         val result = Right("ironman")
 
-        result shouldBeInstanceOf Either::class.java
         result.isRight shouldBe true
         result.isLeft shouldBe false
         result.fold({},
                 { right ->
-                    right shouldBeInstanceOf String::class.java
-                    right shouldEqualTo "ironman"
+                    right shouldBeEqual "ironman"
                 })
     }
 
     @Test fun `Either Left should return correct type`() {
         val result = Left("ironman")
 
-        result shouldBeInstanceOf Either::class.java
         result.isLeft shouldBe true
         result.isRight shouldBe false
         result.fold(
                 { left ->
-                    left shouldBeInstanceOf String::class.java
-                    left shouldEqualTo "ironman"
+                    left shouldBeEqual "ironman"
                 }, {})
     }
 
     @Test fun `Either fold should ignore passed argument if it is Right type`() {
         val success = "Success"
         val result = Right(success).getOrElse("Other")
 
-        result shouldEqualTo success
+        result shouldBeEqual success
     }
 
     @Test fun `Either fold should return argument if it is Left type`() {
         val other = "Other"
         val result = Left("Failure").getOrElse(other)
 
-        result shouldEqual other
+        result shouldBeEqual other
     }
 
     @Test
@@ -96,7 +91,7 @@ class EitherTest : UnitTest() {
             Left(ServerError)
         }
 
-        result shouldEqual Left(ServerError)
+        result shouldBeEqual Left(ServerError)
         result.isLeft shouldBe true
     }
 
@@ -107,7 +102,7 @@ class EitherTest : UnitTest() {
         val result = either.flatMap { Right(20) }
 
         result.isLeft shouldBe true
-        result shouldEqual either
+        result shouldBeEqual either
     }
 
     @Test
@@ -142,7 +137,7 @@ class EitherTest : UnitTest() {
 
         var methodCalled = false
         val result = either.onSuccess {
-            it shouldEqual success
+            it shouldBeEqual success
             methodCalled = true
         }
 
@@ -170,7 +165,7 @@ class EitherTest : UnitTest() {
             resultValue
         }
 
-        result shouldEqual Right(resultValue)
+        result shouldBeEqual Right(resultValue)
     }
 
     @Test
@@ -180,6 +175,6 @@ class EitherTest : UnitTest() {
         val result = either.map { Right(20) }
 
         result.isLeft shouldBe true
-        result shouldEqual either
+        result shouldBeEqual either
     }
 }

app/src/test/kotlin/com/fernandocejas/sample/UnitTest.kt

@@ -15,34 +15,24 @@
  */
 package com.fernandocejas.sample.core.interactor
 
-import com.fernandocejas.sample.AndroidTest
+import com.fernandocejas.sample.UnitTest
 import com.fernandocejas.sample.core.functional.Either.Right
+import io.kotest.matchers.equals.shouldBeEqual
 import kotlinx.coroutines.runBlocking
-import org.amshove.kluent.shouldEqual
-import org.junit.Test
+import org.junit.jupiter.api.Test
 
-class UseCaseTest : AndroidTest() {
+class UseCaseTest : UnitTest() {
 
     private val useCase = MyUseCase()
 
-    @Test fun `running use case should return 'Either' of use case type`() {
+    @Test
+    fun `running use case should return 'Either' of use case type`() {
         val params = MyParams(TYPE_PARAM)
         val result = runBlocking { useCase.run(params) }
 
-        result shouldEqual Right(MyType(TYPE_TEST))
+        result shouldBeEqual Right(MyType(TYPE_TEST))
     }
 
-//    @Test fun `should return correct data when executing use case`() {
-//        var result: Either<Failure, MyType>? = null
-//
-//        val params = MyParams("TestParam")
-//        val onResult = { myResult: Either<Failure, MyType> -> result = myResult }
-//
-//        runBlocking { useCase(params, onResult) }
-//
-//        result shouldEqual Right(MyType(TYPE_TEST))
-//    }
-
     data class MyType(val name: String)
     data class MyParams(val name: String)
 

app/src/test/kotlin/com/fernandocejas/sample/core/functional/EitherTest.kt

@@ -16,10 +16,10 @@
 package com.fernandocejas.sample.core.navigation
 
 import com.fernandocejas.sample.AndroidTest
+import com.fernandocejas.sample.AndroidTest.AndroidAssertions.shouldNavigateTo
 import com.fernandocejas.sample.features.auth.credentials.Authenticator
 import com.fernandocejas.sample.features.login.ui.LoginActivity
 import com.fernandocejas.sample.features.movies.ui.MoviesActivity
-import com.fernandocejas.sample.shouldNavigateTo
 import io.mockk.every
 import io.mockk.impl.annotations.MockK
 import io.mockk.verify
@@ -30,13 +30,16 @@ class NavigatorTest : AndroidTest() {
 
     private lateinit var navigator: Navigator
 
-    @MockK private lateinit var authenticator: Authenticator
+    @MockK
+    private lateinit var authenticator: Authenticator
 
-    @Before fun setup() {
+    @Before
+    fun setup() {
         navigator = Navigator(authenticator)
     }
 
-    @Test fun `should forward user to login screen`() {
+    @Test
+    fun `should forward user to login screen`() {
         every { authenticator.userLoggedIn() } returns false
 
         navigator.showMain(context())
@@ -45,7 +48,8 @@ class NavigatorTest : AndroidTest() {
         RouteActivity::class shouldNavigateTo LoginActivity::class
     }
 
-    @Test fun `should forward user to movies screen`() {
+    @Test
+    fun `should forward user to movies screen`() {
         every { authenticator.userLoggedIn() } returns true
 
         navigator.showMain(context())

app/src/test/kotlin/com/fernandocejas/sample/core/interactor/UseCaseTest.kt

@@ -19,21 +19,23 @@ import androidx.lifecycle.MutableLiveData
 import com.fernandocejas.sample.AndroidTest
 import com.fernandocejas.sample.core.failure.Failure
 import com.fernandocejas.sample.core.failure.Failure.NetworkConnection
-import org.amshove.kluent.shouldBeInstanceOf
+import io.kotest.matchers.should
+import io.kotest.matchers.types.beInstanceOf
 import org.junit.Test
 
 class BaseViewModelTest : AndroidTest() {
 
-    @Test fun `should handle failure by updating live data`() {
+    @Test
+    fun `should handle failure by updating live data`() {
         val viewModel = MyViewModel()
 
         viewModel.handleError(NetworkConnection)
 
         val failure = viewModel.failure
         val error = viewModel.failure.value
 
-        failure shouldBeInstanceOf MutableLiveData::class.java
-        error shouldBeInstanceOf NetworkConnection::class.java
+        failure should beInstanceOf<MutableLiveData<Failure>>()
+        error should beInstanceOf<NetworkConnection>()
     }
 
     private class MyViewModel : BaseViewModel() {