Add tests for compose

.github/workflows/pull_request.yml

@@ -34,3 +34,22 @@ jobs:
       with:
         name: pull-request-build
         path: "app/build/outputs/apk/prerelease/debug/*.apk"
+
+    - name: Upload Test Results
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: test-results
+        path: |
+          **/build/reports/tests/
+          **/build/test-results/
+        include-hidden-files: false
+
+    - name: Upload Lint Results
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: lint-results
+        path: |
+          **/build/reports/lint-results-*.html
+          **/build/reports/lint-results-*.xml

build.gradle.kts

@@ -5,6 +5,7 @@ plugins {
     alias(libs.plugins.buildkonfig) apply false // Universal build config
     alias(libs.plugins.compose.compiler) apply false
     alias(libs.plugins.compose.multiplatform) apply false
+    alias(libs.plugins.detekt) apply false
     alias(libs.plugins.dokka) apply false
     alias(libs.plugins.kotlin.jvm) apply false
     alias(libs.plugins.kotlin.multiplatform) apply false

composeApp/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     alias(libs.plugins.android.multiplatform.library)
     alias(libs.plugins.compose.multiplatform)
     alias(libs.plugins.compose.compiler)
+    alias(libs.plugins.detekt)
 }
 
 kotlin {
@@ -16,6 +17,11 @@ kotlin {
         androidResources {
             enable = true
         }
+
+        lint {
+            checkTestSources = true
+            checkDependencies = true
+        }
     }
 
     jvm()
@@ -47,11 +53,37 @@ kotlin {
             implementation(libs.activity.compose)
             implementation(libs.preference.ktx)
         }
+
+        commonTest.dependencies {
+            implementation(libs.compose.ui.test)
+            implementation(libs.kotlin.test)
+        }
+
+        jvmTest.dependencies {
+            implementation(compose.desktop.currentOs)
+            implementation(libs.kotlin.reflect)
+            implementation(libs.kotlin.test)
+        }
     }
 }
 
+detekt {
+    buildUponDefaultConfig = true
+    config.setFrom(files("$rootDir/config/detekt/detekt.yml"))
+    source.setFrom(
+        "src/commonMain/kotlin",
+        "src/androidMain/kotlin",
+        "src/jvmMain/kotlin",
+        "src/commonTest/kotlin",
+        "src/jvmTest/kotlin",
+    )
+}
+
 dependencies {
     androidRuntimeClasspath(libs.compose.ui.tooling)
+
+    detektPlugins(libs.detekt.formatting)
+    detektPlugins(libs.compose.rules.detekt)
 }
 
 compose.resources {

composeApp/src/commonMain/kotlin/com/lagradost/cloudstream4/ui/components/CloudStreamRipple.kt

@@ -3,19 +3,20 @@ package com.lagradost.cloudstream4.ui.components
 import androidx.compose.foundation.indication
 import androidx.compose.foundation.interaction.MutableInteractionSource
 import androidx.compose.material3.ripple
+import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
-import androidx.compose.ui.composed
 import com.lagradost.cloudstream4.ui.theme.CloudStreamTheme
 
 /**
  * Applies a ripple indication styled to match the app's selected theme.
  */
+@Composable
 fun Modifier.cloudStreamRipple(
     interactionSource: MutableInteractionSource,
     bounded: Boolean = true,
-): Modifier = composed {
+): Modifier {
     val colors = CloudStreamTheme.colors
-    this.indication(
+    return this.indication(
         interactionSource = interactionSource,
         indication = ripple(bounded = bounded, color = colors.onBackground),
     )

composeApp/src/commonMain/kotlin/com/lagradost/cloudstream4/ui/components/ProfilePicture.kt

@@ -29,7 +29,13 @@ import org.jetbrains.compose.resources.painterResource
 import org.jetbrains.compose.resources.stringResource
 
 enum class ProfileImage {
-    DARK_BLUE, BLUE, ORANGE, PINK, PURPLE, RED, TEAL,
+    BLUE,
+    DARK_BLUE,
+    ORANGE,
+    PINK,
+    PURPLE,
+    RED,
+    TEAL,
 }
 
 @Composable
@@ -50,18 +56,20 @@ private fun ProfileImage.toRes(): DrawableResource = when (this) {
  * otherwise falls back to the local [profileImage] background.
  *
  * @param profileImage Local background image fallback
+ * @param modifier Modifier to be applied to the profile picture container
  * @param size Diameter of the circle, default 50.dp
  * @param profilePictureUrl Optional remote URL to load via Coil
  */
 @Composable
 fun ProfilePicture(
     profileImage: ProfileImage,
+    modifier: Modifier = Modifier,
     size: Dp = 50.dp,
     profilePictureUrl: String? = null,
 ) {
     val colors = CloudStreamTheme.colors
     Box(
-        modifier = Modifier
+        modifier = modifier
             .size(size)
             .border(2.dp, colors.onBackground.copy(alpha = 0.2f), CircleShape)
             .clip(CircleShape),

composeApp/src/commonMain/kotlin/com/lagradost/cloudstream4/ui/components/settings/SettingsItem.kt

@@ -36,7 +36,7 @@ fun SettingsItem(
     subtitle: String? = null,
     icon: ImageVector? = null,
     focusRequester: FocusRequester? = null,
-    onClick: () -> Unit,
+    onClick: () -> Unit = {},
 ) {
     val colors = CloudStreamTheme.colors
     val isTV = remember { DeviceLayout.isLayout(DeviceLayout.TV) }
@@ -89,7 +89,6 @@ private fun SettingsItemPreview() {
             title = stringResource(Res.string.category_general),
             subtitle = stringResource(Res.string.category_general_subtitle),
             icon = tune,
-            onClick = {},
         )
     }
 }
@@ -101,7 +100,6 @@ private fun SettingsItemNoIconPreview() {
         SettingsItem(
             title = stringResource(Res.string.category_general),
             subtitle = stringResource(Res.string.category_general_subtitle),
-            onClick = {},
         )
     }
 }
@@ -113,7 +111,6 @@ private fun SettingsItemNoSubtitlePreview() {
         SettingsItem(
             title = stringResource(Res.string.category_general),
             icon = tune,
-            onClick = {},
         )
     }
 }

composeApp/src/commonMain/kotlin/com/lagradost/cloudstream4/ui/screens/settings/SettingsScreen.kt

@@ -128,6 +128,7 @@ fun SettingsScreen(
     version: SettingsVersionState,
     onNavigate: (SettingsCategory) -> Unit,
     onVersionLongClick: () -> Unit = {},
+    modifier: Modifier = Modifier,
 ) {
     val colors = CloudStreamTheme.colors
     val isTV = remember { DeviceLayout.isLayout(DeviceLayout.TV) }
@@ -138,7 +139,7 @@ fun SettingsScreen(
     }
 
     Box(
-        modifier = Modifier
+        modifier = modifier
             .fillMaxSize()
             .background(colors.background)
             .windowInsetsPadding(WindowInsets.statusBars)

composeApp/src/commonTest/kotlin/com/lagradost/cloudstream4/ui/components/CloudStreamRippleTest.kt

@@ -0,0 +1,139 @@
+package com.lagradost.cloudstream4.ui.components
+
+import androidx.compose.foundation.background
+import androidx.compose.foundation.interaction.MutableInteractionSource
+import androidx.compose.foundation.interaction.PressInteraction
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.size
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.geometry.Offset
+import androidx.compose.ui.graphics.toPixelMap
+import androidx.compose.ui.platform.testTag
+import androidx.compose.ui.test.ExperimentalTestApi
+import androidx.compose.ui.test.assertIsDisplayed
+import androidx.compose.ui.test.captureToImage
+import androidx.compose.ui.test.onNodeWithTag
+import androidx.compose.ui.test.v2.runComposeUiTest
+import androidx.compose.ui.unit.dp
+import com.lagradost.cloudstream4.ui.theme.CloudStreamPalette
+import com.lagradost.cloudstream4.ui.theme.CloudStreamTheme
+import com.lagradost.cloudstream4.ui.theme.CloudStreamThemeMode
+import kotlin.test.Test
+import kotlin.test.assertNotEquals
+
+@OptIn(ExperimentalTestApi::class)
+class CloudStreamRippleTest {
+
+    @Test
+    fun appliesSuccessfullyWhenBounded() = runComposeUiTest {
+        val interactionSource = MutableInteractionSource()
+        setContent {
+            CloudStreamTheme {
+                Box(
+                    modifier = Modifier
+                        .testTag("target")
+                        .size(64.dp)
+                        .cloudStreamRipple(interactionSource, bounded = true),
+                )
+            }
+        }
+        waitForIdle()
+
+        onNodeWithTag("target").assertIsDisplayed()
+    }
+
+    @Test
+    fun appliesSuccessfullyWhenUnbounded() = runComposeUiTest {
+        val interactionSource = MutableInteractionSource()
+        setContent {
+            CloudStreamTheme {
+                Box(
+                    modifier = Modifier
+                        .testTag("target")
+                        .size(64.dp)
+                        .cloudStreamRipple(interactionSource, bounded = false),
+                )
+            }
+        }
+        waitForIdle()
+
+        onNodeWithTag("target").assertIsDisplayed()
+    }
+
+    @Test
+    fun appliesSuccessfullyUnderEveryThemeMode() = runComposeUiTest {
+        val modes = CloudStreamThemeMode.entries.filterNot { it == CloudStreamThemeMode.Dynamic }
+
+        setContent {
+            Column {
+                modes.forEach { mode ->
+                    val interactionSource = remember { MutableInteractionSource() }
+                    CloudStreamTheme(mode = mode) {
+                        Box(
+                            modifier = Modifier
+                                .testTag("target-${mode.name}")
+                                .size(32.dp)
+                                .cloudStreamRipple(interactionSource),
+                        )
+                    }
+                }
+            }
+        }
+        waitForIdle()
+
+        modes.forEach { mode ->
+            onNodeWithTag("target-${mode.name}").assertIsDisplayed()
+        }
+    }
+
+    /**
+     * Check rhat it emits a real [PressInteraction.Press] into the
+     * [MutableInteractionSource] and confirms the pixel under the press point
+     * actually changes once the ripple draws over it.
+     *
+     * This test may end up being flaky. If so, it can be dropped.
+     */
+    @Test
+    fun pressInteractionChangesThePixelsUnderThePress() = runComposeUiTest {
+        val interactionSource = MutableInteractionSource()
+        val boxSizeDp = 80
+
+        setContent {
+            CloudStreamTheme(mode = CloudStreamThemeMode.Dark) {
+                Box(
+                    modifier = Modifier
+                        .testTag("target")
+                        .size(boxSizeDp.dp)
+                        .background(CloudStreamPalette.DarkBlackBg)
+                        .cloudStreamRipple(interactionSource),
+                )
+            }
+        }
+        waitForIdle()
+
+        val target = onNodeWithTag("target")
+        val idlePixels = target.captureToImage().toPixelMap()
+        val centerX = idlePixels.width / 2
+        val centerY = idlePixels.height / 2
+        val idleCenterColor = idlePixels[centerX, centerY]
+
+        val press = PressInteraction.Press(Offset(centerX.toFloat(), centerY.toFloat()))
+        interactionSource.tryEmit(press)
+        waitForIdle()
+
+        val pressedPixels = target.captureToImage().toPixelMap()
+        val pressedCenterColor = pressedPixels[centerX, centerY]
+
+        assertNotEquals(
+            idleCenterColor,
+            pressedCenterColor,
+            "Expected the ripple to visibly change the pixel under the press point",
+        )
+
+        // Release cleanly so the ripple doesn't leak a running animation past the test.
+        interactionSource.tryEmit(PressInteraction.Release(press))
+        waitForIdle()
+    }
+}