Add a test to introduce compose screenshot testing

.github/workflows/pr.yml

@@ -97,6 +97,26 @@ jobs:
         with:
           category: "Android Lint"
 
+  screenshot_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup-build-env
+        with:
+          mock-google-services: "true"
+
+      - name: Validate Screenshot Previews
+        run: ./gradlew validateDebugScreenshotTest
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: Screenshot test results
+          path: |
+              **/build/test-results/**/TEST-*.xml
+
   pr_build:
     needs: [yamllint, lockfiles]
     runs-on: ubuntu-latest
@@ -278,7 +298,7 @@ jobs:
 
   publish_test_results:
     name: "Publish Tests Results"
-    needs: [instrumentation_test, unit_tests]
+    needs: [instrumentation_test, unit_tests, screenshot_test]
     runs-on: ubuntu-latest
     permissions:
       checks: write

gradle.properties

@@ -28,6 +28,7 @@ org.gradle.vfs.watch=true
 android.defaults.buildfeatures.resvalues=false
 android.defaults.buildfeatures.shaders=false
 android.nonFinalResIds=false
+android.experimental.enableScreenshotTest=true
 
 # Uncomment to disable leak canary
 #noLeakCanary=true

gradle/libs.versions.toml

@@ -62,6 +62,7 @@ recyclerview = "1.4.0"
 reorderable = "0.9.6"
 retrofit = "2.9.0"
 room = "2.6.1"
+screenshot = "0.0.1-alpha09"
 sentry-android = "8.5.0"
 timber = "5.0.1"
 tools-desugar-jdk-libs = "2.1.5"
@@ -90,6 +91,7 @@ kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref =
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
+screenshot = { id = "com.android.compose.screenshot", version.ref = "screenshot" }
 
 # Plugins defined by this project in `:build-logic:convention` module.
 homeassistant-android-application = { id = "homeassistant.android.application" }

wear/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     alias(libs.plugins.homeassistant.android.application)
     alias(libs.plugins.google.services)
+    alias(libs.plugins.screenshot)
 }
 
 android {
@@ -12,6 +13,14 @@ android {
         // We add 1 because the app and wear versions need to have different version codes.
         versionCode = 1 + checkNotNull(versionCode) { "Did you forget to apply the convention plugin that set the version code?" }
     }
+
+    experimentalProperties["android.experimental.enableScreenshotTest"] = true
+
+    testOptions {
+        screenshotTests {
+            imageDifferenceThreshold = 0.00025f // 0.025%
+        }
+    }
 }
 
 dependencies {
@@ -66,6 +75,7 @@ dependencies {
 
     implementation(platform(libs.firebase.bom))
     implementation(libs.firebase.messaging)
+    screenshotTestImplementation(libs.compose.uiTooling)
 
     androidTestImplementation(platform(libs.compose.bom))
     androidTestImplementation(libs.bundles.androidx.test)

wear/src/screenshotTest/kotlin/io/homeassistant/companion/android/EntityListViewPreviewsTest.kt

@@ -0,0 +1,27 @@
+package io.homeassistant.companion.android
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.wear.tooling.preview.devices.WearDevices
+import io.homeassistant.companion.android.common.R
+import io.homeassistant.companion.android.home.views.EntityViewList
+import io.homeassistant.companion.android.util.previewEntity1
+import io.homeassistant.companion.android.util.previewEntity2
+
+class EntityListViewPreviewsTest {
+
+    @Preview(device = WearDevices.LARGE_ROUND)
+    @Composable
+    private fun PreviewEntityListView() {
+        EntityViewList(
+            entityLists = mapOf(stringResource(R.string.lights) to listOf(previewEntity1, previewEntity2)),
+            entityListsOrder = listOf(stringResource(R.string.lights)),
+            entityListFilter = { true },
+            onEntityClicked = { _, _ -> },
+            onEntityLongClicked = { },
+            isHapticEnabled = false,
+            isToastEnabled = false
+        )
+    }
+}