refactor: Replace ComposeContentTestRule with ComposeUiTest in UI tests

This commit refactors the UI test classes to use `ComposeUiTest` and `SemanticsNodeInteractionsProvider` instead of the more specific `ComposeContentTestRule`. This change improves abstraction and makes the test helpers more platform-agnostic.

- Replace `ComposeContentTestRule` with `ComposeUiTest` in all test case classes (`CrudTestCase`, `LocaleTestCase`, `SignInTestCase`, etc.).
- Page object classes (e.g., `MainTestScreen`, `NoteScreen`, `SignInScreen`) now accept a `SemanticsNodeInteractionsProvider` instead of `ComposeContentTestRule`. The property name is changed from `composeTestRule` to `nodeProvider`.
- Introduce a `reflect` utility function to obtain a `ComposeUiTest` instance from a `ComposeContentTestRule`, ensuring compatibility with existing test rule implementations like `AndroidComposeTestRule`.
- Update `AbstractJvmUiTests` to use the new `ComposeUiTest` for running test cases.
- Add the `ui-test` dependency to the `commonMain` source set.

Author: softartdev

app/android/src/androidTest/java/com/softartdev/notedelight/ui/SignInTest.kt

@@ -1,10 +1,15 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui
 
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.test.espresso.Espresso
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.filters.FlakyTest
 import com.softartdev.notedelight.DbTestEncryptor
 import com.softartdev.notedelight.MainActivity
+import com.softartdev.notedelight.reflect
 import com.softartdev.notedelight.ui.cases.SignInTestCase
 import leakcanary.DetectLeaksAfterTestSuccess
 import leakcanary.TestDescriptionHolder
@@ -26,6 +31,8 @@ class SignInTest {
         .around(DetectLeaksAfterTestSuccess())
         .around(composeTestRule)
 
+    private val composeUiTest: ComposeUiTest = reflect(composeTestRule)
+
     @Test
-    fun signInTest() = SignInTestCase(composeTestRule, Espresso::closeSoftKeyboard).invoke()
+    fun signInTest() = SignInTestCase(composeUiTest, Espresso::closeSoftKeyboard).invoke()
 }

app/android/src/androidTest/java/com/softartdev/notedelight/ui/SignInToSettingsTest.kt

@@ -1,10 +1,15 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui
 
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.test.espresso.Espresso
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.filters.FlakyTest
 import com.softartdev.notedelight.DbTestEncryptor
 import com.softartdev.notedelight.MainActivity
+import com.softartdev.notedelight.reflect
 import com.softartdev.notedelight.ui.cases.SignInToSettingsTestCase
 import leakcanary.DetectLeaksAfterTestSuccess
 import leakcanary.TestDescriptionHolder
@@ -26,7 +31,9 @@ class SignInToSettingsTest {
         .around(DetectLeaksAfterTestSuccess())
         .around(composeTestRule)
 
+    private val composeUiTest: ComposeUiTest = reflect(composeTestRule)
+
     @Test
-    fun signInToSettingsTest() = SignInToSettingsTestCase(composeTestRule, Espresso::closeSoftKeyboard).invoke()
+    fun signInToSettingsTest() = SignInToSettingsTestCase(composeUiTest, Espresso::closeSoftKeyboard).invoke()
 }
 

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ComposeTestNodeProvider.kt

@@ -0,0 +1,70 @@
+@file:OptIn(ExperimentalTestApi::class)
+
+package com.softartdev.notedelight
+
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
+import androidx.compose.ui.test.junit4.ComposeContentTestRule
+import java.lang.reflect.Field
+import java.lang.reflect.Method
+
+fun reflect(composeTestRule: ComposeContentTestRule): ComposeUiTest {
+    // Just in case some wrapper directly implements ComposeUiTest.
+    (composeTestRule as? ComposeUiTest)?.let { return it }
+
+    // 1) Fast path: both AndroidComposeTestRule and DesktopComposeTestRule store it in "composeTest".
+    findField(composeTestRule, "composeTest")?.let { field ->
+        field.getOrNull(composeTestRule)?.let { value ->
+            if (value is ComposeUiTest) return value
+        }
+    }
+
+    // 2) Robust path: scan all fields in the hierarchy and return the first ComposeUiTest found.
+    for (field in allFields(composeTestRule.javaClass)) {
+        field.getOrNull(composeTestRule)?.let { value ->
+            if (value is ComposeUiTest) return value
+        }
+    }
+
+    // 3) Last resort: scan no-arg methods returning ComposeUiTest.
+    for (method in allNoArgMethods(composeTestRule.javaClass)) {
+        if (ComposeUiTest::class.java.isAssignableFrom(method.returnType)) {
+            method.isAccessible = true
+            val value = runCatching { method.invoke(composeTestRule) }.getOrNull()
+            if (value is ComposeUiTest) return value
+        }
+    }
+
+    throw IllegalStateException(
+        "Failed to reflect ComposeUiTest from ${composeTestRule.javaClass.name}. " +
+                "Expected AndroidComposeTestRule/DesktopComposeTestRule internals to contain it."
+    )
+}
+
+@Suppress("SameParameterValue")
+private fun findField(target: Any, name: String): Field? {
+    var c: Class<*>? = target.javaClass
+    while (c != null && c != Any::class.java) {
+        runCatching { c.getDeclaredField(name) }
+            .onSuccess { return it }
+        c = c.superclass
+    }
+    return null
+}
+
+private fun allFields(clazz: Class<*>): Sequence<Field> =
+    generateSequence(clazz) { it.superclass }
+        .takeWhile { it != Any::class.java }
+        .flatMap { it.declaredFields.asSequence() }
+
+private fun allNoArgMethods(clazz: Class<*>): Sequence<Method> =
+    generateSequence(clazz) { it.superclass }
+        .takeWhile { it != Any::class.java }
+        .flatMap { it.declaredMethods.asSequence() }
+        .filter { it.parameterTypes.isEmpty() }
+
+private fun Field.getOrNull(instance: Any): Any? =
+    runCatching {
+        isAccessible = true
+        get(instance)
+    }.getOrNull()

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ext.kt

@@ -1,12 +1,15 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight
 
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.compose.ui.test.SemanticsNodeInteraction
 import androidx.compose.ui.test.assertIsDisplayed
 import androidx.compose.ui.test.assertIsNotDisplayed
 import androidx.compose.ui.test.assertIsSelectable
 import androidx.compose.ui.test.assertIsSelected
 import androidx.compose.ui.test.isNotDisplayed
-import androidx.compose.ui.test.junit4.ComposeTestRule
 import co.touchlab.kermit.Logger
 
 const val ASSERT_WAIT_TIMEOUT_MILLIS: Long = 5_000
@@ -60,7 +63,7 @@ inline fun retryUntilNotDisplayed(
     return sni.assertIsNotDisplayed()
 }
 
-inline fun ComposeTestRule.waitUntilDisplayed(
+inline fun ComposeUiTest.waitUntilDisplayed(
     description: String,
     crossinline blockSNI: () -> SemanticsNodeInteraction,
 ) = waitUntil(conditionDescription = description, timeoutMillis = ASSERT_WAIT_TIMEOUT_MILLIS) {
@@ -73,7 +76,7 @@ inline fun ComposeTestRule.waitUntilDisplayed(
     return@waitUntil true
 }
 
-inline fun ComposeTestRule.waitAssert(
+inline fun ComposeUiTest.waitAssert(
     description: String,
     crossinline assert: () -> Unit
 ) = waitUntil(conditionDescription = description, timeoutMillis = ASSERT_WAIT_TIMEOUT_MILLIS) {
@@ -85,7 +88,7 @@ inline fun ComposeTestRule.waitAssert(
     return@waitUntil true
 }
 
-inline fun ComposeTestRule.waitUntilSelected(
+inline fun ComposeUiTest.waitUntilSelected(
     description: String,
     crossinline blockSNI: () -> SemanticsNodeInteraction
 ) = waitUntil(conditionDescription = description, timeoutMillis = ASSERT_WAIT_TIMEOUT_MILLIS) {

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ui/AbstractJvmUiTests.kt

@@ -1,7 +1,12 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui
 
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.compose.ui.test.junit4.ComposeContentTestRule
 import com.softartdev.notedelight.AbstractUITests
+import com.softartdev.notedelight.reflect
 import com.softartdev.notedelight.ui.cases.CrudTestCase
 import com.softartdev.notedelight.ui.cases.EditTitleAfterCreateTestCase
 import com.softartdev.notedelight.ui.cases.EditTitleAfterSaveTestCase
@@ -12,32 +17,33 @@ import com.softartdev.notedelight.ui.cases.SettingPasswordTestCase
 
 abstract class AbstractJvmUiTests : AbstractUITests() {
     abstract val composeTestRule: ComposeContentTestRule
+    override val composeUiTest: ComposeUiTest by lazy { reflect(composeTestRule) }
 
     open fun setUp() = Unit
 
     open fun tearDown() = Unit
 
-    open fun crudNoteTest() = CrudTestCase(composeTestRule).invoke()
+    open fun crudNoteTest() = CrudTestCase(composeUiTest).invoke()
 
-    open fun editTitleAfterCreateTest() = EditTitleAfterCreateTestCase(composeTestRule).invoke()
+    open fun editTitleAfterCreateTest() = EditTitleAfterCreateTestCase(composeUiTest).invoke()
 
-    open fun editTitleAfterSaveTest() = EditTitleAfterSaveTestCase(composeTestRule).invoke()
+    open fun editTitleAfterSaveTest() = EditTitleAfterSaveTestCase(composeUiTest).invoke()
 
-    open fun prepopulateDatabase() = PrepopulateDbTestCase(composeTestRule).invoke()
+    open fun prepopulateDatabase() = PrepopulateDbTestCase(composeUiTest).invoke()
 
     open fun flowAfterCryptTest() = FlowAfterCryptTestCase(
-        composeTestRule = composeTestRule,
+        composeUiTest = composeUiTest,
         pressBack = ::pressBack,
         closeSoftKeyboard = ::closeSoftKeyboard
     ).invoke()
 
     open fun settingPasswordTest() = SettingPasswordTestCase(
-        composeTestRule = composeTestRule,
+        composeUiTest = composeUiTest,
         closeSoftKeyboard = ::closeSoftKeyboard
     ).invoke()
 
     open fun localeTest() = LocaleTestCase(
-        composeTestRule = composeTestRule,
+        composeUiTest = composeUiTest,
         pressBack = ::pressBack
     ).invoke()
 

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ui/BaseTestCase.kt

@@ -1,6 +1,9 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui
 
-import androidx.compose.ui.test.junit4.ComposeContentTestRule
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import com.softartdev.notedelight.ui.screen.MainTestScreen
 import com.softartdev.notedelight.ui.screen.NoteScreen
 import com.softartdev.notedelight.ui.screen.SettingsTestScreen
@@ -13,18 +16,18 @@ import com.softartdev.notedelight.ui.screen.dialog.EditTitleDialog
 import com.softartdev.notedelight.ui.screen.dialog.EnterPasswordDialog
 import com.softartdev.notedelight.ui.screen.dialog.LanguageDialog
 
-abstract class BaseTestCase(val composeTestRule: ComposeContentTestRule) {
+abstract class BaseTestCase(val composeUiTest: ComposeUiTest) {
 
-    private val commonDialog: CommonDialog = CommonDialogImpl(composeTestRule)
+    private val commonDialog: CommonDialog = CommonDialogImpl(composeUiTest)
 
-    fun signInScreen(block: SignInScreen.() -> Unit) = SignInScreen(composeTestRule).block()
+    fun signInScreen(block: SignInScreen.() -> Unit) = SignInScreen(composeUiTest).block()
 
-    fun mainTestScreen(block: MainTestScreen.() -> Unit) = MainTestScreen(composeTestRule).block()
+    fun mainTestScreen(block: MainTestScreen.() -> Unit) = MainTestScreen(composeUiTest).block()
 
-    fun noteScreen(block: NoteScreen.() -> Unit) = NoteScreen(composeTestRule).block()
+    fun noteScreen(block: NoteScreen.() -> Unit) = NoteScreen(composeUiTest).block()
 
     fun settingsTestScreen(block: SettingsTestScreen.() -> Unit) =
-        SettingsTestScreen(composeTestRule).block()
+        SettingsTestScreen(composeUiTest).block()
 
     fun commonDialog(block: CommonDialog.() -> Unit) = commonDialog.block()
 

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ui/cases/CrudTestCase.kt

@@ -1,6 +1,9 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui.cases
 
-import androidx.compose.ui.test.junit4.ComposeContentTestRule
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.compose.ui.test.performClick
 import androidx.compose.ui.test.performTextInput
 import com.softartdev.notedelight.ui.BaseTestCase
@@ -10,30 +13,30 @@ import kotlinx.coroutines.test.runTest
 import java.util.UUID
 
 class CrudTestCase(
-    composeTestRule: ComposeContentTestRule
-) : () -> Unit, BaseTestCase(composeTestRule) {
+    composeUiTest: ComposeUiTest
+) : () -> Unit, BaseTestCase(composeUiTest) {
 
     private val actualNoteText = UUID.randomUUID().toString().substring(0, 30)
 
     override fun invoke() = runTest {
         mainTestScreen {
-            composeTestRule.waitUntilDisplayed("fab", blockSNI = ::fabSNI)
+            composeUiTest.waitUntilDisplayed("fab", blockSNI = ::fabSNI)
             fabSNI.performClick()
             noteScreen {
                 textFieldSNI.performTextInput(actualNoteText)
                 saveNoteMenuButtonSNI.performClick()
                 backButtonSNI.performClick()
             }
             noteItemTitleText = actualNoteText
-            composeTestRule.waitUntilDisplayed("noteListItem", blockSNI = ::noteListItemSNI)
+            composeUiTest.waitUntilDisplayed("noteListItem", blockSNI = ::noteListItemSNI)
             noteListItemSNI.performClick()
             noteScreen {
                 deleteNoteMenuButtonSNI.performClick()
                 commonDialog {
                     yesDialogButtonSNI.performClick()
                 }
             }
-            composeTestRule.waitUntilDisplayed("emptyResultLabel", blockSNI = ::emptyResultLabelSNI)
+            composeUiTest.waitUntilDisplayed("emptyResultLabel", blockSNI = ::emptyResultLabelSNI)
         }
     }
 }

ui/test-jvm/src/main/kotlin/com/softartdev/notedelight/ui/cases/EditTitleAfterCreateTestCase.kt

@@ -1,6 +1,9 @@
+@file:OptIn(ExperimentalTestApi::class)
+
 package com.softartdev.notedelight.ui.cases
 
-import androidx.compose.ui.test.junit4.ComposeContentTestRule
+import androidx.compose.ui.test.ComposeUiTest
+import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.compose.ui.test.onNodeWithContentDescription
 import androidx.compose.ui.test.performClick
 import androidx.compose.ui.test.performTextInput
@@ -16,32 +19,32 @@ import org.jetbrains.compose.resources.getString
 import java.util.UUID
 
 class EditTitleAfterCreateTestCase(
-    composeTestRule: ComposeContentTestRule
-) : () -> Unit, BaseTestCase(composeTestRule) {
+    composeUiTest: ComposeUiTest
+) : () -> Unit, BaseTestCase(composeUiTest) {
 
     private val actualNoteTitle = "title"
 
     override fun invoke() = runTest {
         mainTestScreen {
-            composeTestRule.waitUntilDisplayed("fab", blockSNI = ::fabSNI)
+            composeUiTest.waitUntilDisplayed("fab", blockSNI = ::fabSNI)
             fabSNI.performClick()
             noteScreen {
                 val actualNoteText = UUID.randomUUID().toString().substring(0, 30)
                 textFieldSNI.performTextInput(actualNoteText)
                 editTitleMenuButtonSNI.performClick()
                 editTitleDialog {
-                    composeTestRule.waitUntilDisplayed("editTitle", blockSNI = ::editTitleSNI)
+                    composeUiTest.waitUntilDisplayed("editTitle", blockSNI = ::editTitleSNI)
                     editTitleSNI.performTextReplacement(actualNoteTitle)
                     yesDialogButtonSNI.performClick()
                 }
-                composeTestRule
+                composeUiTest
                     .onNodeWithContentDescription(label = runBlocking { getString(Res.string.enter_title) })
                     .assertDoesNotExist()
                 saveNoteMenuButtonSNI.performClick()
                 backButtonSNI.performClick()
             }
             noteItemTitleText = actualNoteTitle
-            composeTestRule.waitUntilDisplayed("noteListItem", blockSNI = ::noteListItemSNI)
+            composeUiTest.waitUntilDisplayed("noteListItem", blockSNI = ::noteListItemSNI)
         }
     }
 }