Merge pull request Kaaveh#184 from Kaaveh/feature/migrate_data_layer_…

…to_kotest

Migrate Junit tests to kotest

README.md

@@ -45,7 +45,7 @@ For the detail of handling preview of composable functions in this code-base, pl
 - [x] GSON → Kotlinx Serialization
 - [x] ROOM → SQLDelight
 - [ ] Retrofit → Ktor
-- [ ] JUnit → Kotest
+- [x] JUnit → Kotest
 - [ ] Dagger-Hilt → Koin
 - [ ] Jetpack Compose → Compose Multiplatform
 

app/build.gradle.kts

@@ -41,8 +41,6 @@ dependencies {
         implementation(androidx.ktx)
         implementation(hilt.work)
         implementation(lifecycle.runtime.ktx)
-        testImplementation(junit)
-        androidTestImplementation(junit.ext)
         implementation(work.runtime.ktx)
         implementation(libs.hilt.navigation.compose)
     }

build-logic/convention/src/main/kotlin/ir/composenews/KotlinAndroid.kt

@@ -56,6 +56,11 @@ internal fun Project.configureKotlinAndroid(
             resources {
                 resources.excludes.add("META-INF/*")
                 resources.merges.add("META-INF/*.version")
+
+                // https://github.com/Kotlin/kotlinx.coroutines/issues/2023#issuecomment-858644393
+                resources.pickFirsts.add("win32-x86-64/attach_hotspot_windows.dll")
+                resources.pickFirsts.add("win32-x86/attach_hotspot_windows.dll")
+                resources.excludes.add("META-INF/licenses/ASM")
             }
         }
     }

core/extensions/build.gradle.kts

@@ -11,7 +11,7 @@ android {
 }
 
 dependencies {
-    libs.apply {
-        implementation(junit)
+    projects.apply {
+        testImplementation(core.test)
     }
 }

core/extensions/src/test/java/ir/composenews/extensions/RoundToTwoDecimalPlacesTest.kt

@@ -1,13 +1,11 @@
 package ir.composenews.extensions
 
-import org.junit.Assert
-import org.junit.Test
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.equals.shouldBeEqual
 import java.math.BigDecimal
 
-class RoundToTwoDecimalPlacesTest {
-    @Test
-    fun testRoundToTwoDecimalPlaces() {
-        // Define a map of test cases with input numbers and their expected rounded results
+class RoundToTwoDecimalPlacesTest : StringSpec({
+    "Round to two decimal places" {
         val testCases = mapOf(
             0.12345 to "0.12",
             1.0 to "1.00",
@@ -16,10 +14,9 @@ class RoundToTwoDecimalPlacesTest {
             BigDecimal("1234.56789") to "1234.57",
         )
 
-        // Iterate through the test cases and assert the expected results
         testCases.forEach { (input, expected) ->
             val result = input.roundToTwoDecimalPlaces()
-            Assert.assertEquals(expected, result)
+            result shouldBeEqual expected
         }
     }
-}
+})

core/sync/src/main/java/ir/composenews/sync/Sync.kt

@@ -55,9 +55,10 @@ private fun Context.syncWorkNotification(): Notification {
         notificationManager?.createNotificationChannel(channel)
     }
 
+    // TODO
     return NotificationCompat
         .Builder(this, SyncNotificationChannelID)
-        .setSmallIcon(androidx.hilt.work.R.drawable.notification_action_background)
+//        .setSmallIcon(androidx.hilt.work.R.drawable.notification_action_background)
         .setContentTitle("Background tasks for Compose News")
         .setPriority(NotificationCompat.PRIORITY_DEFAULT)
         .build()

core/test/build.gradle.kts

@@ -12,8 +12,7 @@ android {
 
 dependencies {
     libs.apply {
-        api(junit)
-        api(junit.ext)
+        api(bundles.kotest)
         api(coroutines.test)
         api(mockk)
     }

core/test/src/main/java/ir/composenews/core_test/MainCoroutineListener.kt

@@ -0,0 +1,22 @@
+@file:Suppress("PackageNaming", "PackageName")
+
+package ir.composenews.core_test
+
+import io.kotest.core.listeners.TestListener
+import io.kotest.core.spec.Spec
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.test.TestDispatcher
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.setMain
+
+class MainCoroutineListener(
+    private val testDispatcher: TestDispatcher = UnconfinedTestDispatcher(),
+) : TestListener {
+    override suspend fun beforeSpec(spec: Spec) {
+        Dispatchers.setMain(testDispatcher)
+    }
+
+    override suspend fun afterSpec(spec: Spec) {
+        Dispatchers.setMain(testDispatcher)
+    }
+}

core/test/src/main/java/ir/composenews/core_test/SuspendSpec.kt

@@ -0,0 +1,31 @@
+@file:Suppress("PackageNaming", "PackageName")
+
+package ir.composenews.core_test
+
+import io.kotest.core.spec.style.FreeSpec
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.cancelAndJoin
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
+import kotlin.coroutines.CoroutineContext
+
+/**
+ * A Kotest Spec that allows suspension in its initializer. This works great for the
+ * `ProjectResource`, for initialising dependencies.
+ */
+@Suppress("UnnecessaryAbstractClass")
+abstract class SuspendSpec(body: suspend FreeSpec.() -> Unit) : FreeSpec() {
+    init {
+        val scope = autoClose(CloseableCoroutineScope(Dispatchers.Unconfined))
+        scope.launch(Dispatchers.Unconfined) { body() }
+    }
+}
+
+private class CloseableCoroutineScope(context: CoroutineContext) : CoroutineScope, AutoCloseable {
+    private val job = Job()
+    override val coroutineContext: CoroutineContext = context + job
+
+    override fun close() = runBlocking { job.cancelAndJoin() }
+}

core/test/src/main/java/ir/composenews/core_test/dispatcher/TestDispatcherProvider.kt

@@ -3,11 +3,11 @@
 package ir.composenews.core_test.dispatcher
 
 import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.TestCoroutineScheduler
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
 
 class TestDispatcherProvider(testScheduler: TestCoroutineScheduler) : DispatcherProvider {
-    override val ui: CoroutineDispatcher = StandardTestDispatcher(testScheduler)
-    override val io: CoroutineDispatcher = StandardTestDispatcher(testScheduler)
-    override val bg: CoroutineDispatcher = StandardTestDispatcher(testScheduler)
+    override val ui: CoroutineDispatcher = UnconfinedTestDispatcher(testScheduler)
+    override val io: CoroutineDispatcher = UnconfinedTestDispatcher(testScheduler)
+    override val bg: CoroutineDispatcher = UnconfinedTestDispatcher(testScheduler)
 }

data/market-local/build.gradle.kts

@@ -26,9 +26,9 @@ dependencies {
         implementation(sqldelight.android)
         implementation(sqldelight.coroutines)
         testImplementation(sqldelight.test)
-        testImplementation(junit)
-        testImplementation(junit.ext)
-        testImplementation(coroutines.test)
         testImplementation(runner)
     }
+    projects.apply {
+        testImplementation(core.test)
+    }
 }

data/market-local/src/test/java/ir/composenews/localdatasource/database/MarketDaoTest.kt

@@ -1,38 +1,31 @@
 package ir.composenews.localdatasource.database
 
 import app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteDriver
+import io.kotest.matchers.collections.shouldContain
+import io.kotest.matchers.equals.shouldBeEqual
+import ir.composenews.core_test.SuspendSpec
 import ir.composenews.db.MarketDatabase
 import ir.composenews.localdatasource.test.favoriteMarketEntity
-import junit.framework.TestCase.assertTrue
 import kotlinx.coroutines.flow.first
-import kotlinx.coroutines.test.runTest
-import org.junit.Before
-import org.junit.Test
 
-class MarketDaoTest {
+class MarketDaoTest : SuspendSpec({
+    lateinit var marketDao: MarketDao
 
-    private lateinit var marketDao: MarketDao
-
-    @Before
-    fun createDb() {
+    beforeSpec {
         val driver = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
         MarketDatabase.Schema.create(driver)
         val db = MarketDatabase(driver)
         marketDao = MarketDaoImpl(db)
     }
 
-    @Test
-    @Throws(Exception::class)
-    fun emptyTableAtDbInitialization() = runTest {
+    "Empty table at db initialization" {
         val marketList = marketDao.getMarketList().first()
-        assertTrue(marketList.isEmpty())
+        marketList.size shouldBeEqual 0
     }
 
-    @Test
-    @Throws(Exception::class)
-    fun insertNewsToDb() = runTest {
+    "Insert market to db" {
         marketDao.insertMarket(favoriteMarketEntity)
         val marketList = marketDao.getMarketList().first()
-        assertTrue(marketList.contains(favoriteMarketEntity))
+        marketList shouldContain favoriteMarketEntity
     }
-}
+})

data/market-repository/build.gradle.kts

@@ -17,10 +17,7 @@ dependencies {
         implementation(data.marketLocal)
     }
     libs.apply {
-        testImplementation(junit)
         testImplementation(bundles.kotest)
-        androidTestImplementation(junit.ext)
-        androidTestImplementation(coroutines.test)
-        androidTestImplementation(runner)
+        testImplementation(sqldelight.test)
     }
 }