Merge pull request #30 from android/screenshot-testing-roborazzi

romanofranz · web-flow · commit d525bdd063c5 · 2025-11-10T16:25:03.000+01:00
Add screenshot testing
diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml
@@ -1,4 +1,4 @@
-name: Build cahier
+name: Build and verify cahier
 
 on:
   workflow_dispatch:
@@ -11,7 +11,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout codebase
+        uses: actions/checkout@v4
 
       - name: Set Up JDK
         uses: actions/setup-java@v4
@@ -31,7 +32,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: checkout
+      - name: Checkout codebase
         uses: actions/checkout@v4
 
       - name: Enable KVM
@@ -50,3 +51,9 @@ jobs:
           device: desktop_large
           arch: x86_64
           script: ./gradlew :app:connectedAndroidTest
+
+      - name: Run Roborazzi
+        id: verify-test
+        run: |
+          # If there is a difference between the screenshots, the test will fail.
+          ./gradlew app:verifyRoborazziDebug --stacktrace
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -17,6 +17,7 @@ plugins {
     alias(libs.plugins.androidApplication)
     alias(libs.plugins.jetbrainsKotlinAndroid)
     alias(libs.plugins.ksp)
+    alias(libs.plugins.roborazzi)
     id("org.jetbrains.kotlin.plugin.compose") version "2.2.20"
     id("kotlin-parcelize")
     kotlin("plugin.serialization")
@@ -61,6 +62,14 @@ android {
             excludes += "/META-INF/{AL2.0,LGPL2.1}"
         }
     }
+    testOptions {
+        unitTests {
+            isIncludeAndroidResources = true
+        }
+    }
+    roborazzi {
+        outputDir.set(file("../screenshots"))
+    }
 }
 
 dependencies {
@@ -97,6 +106,12 @@ dependencies {
     testImplementation(libs.androidx.arch.core.testing)
     testImplementation(libs.kotlinx.coroutines.test)
     testImplementation(libs.turbine)
+    testImplementation(libs.robolectric)
+    testImplementation(libs.roborazzi)
+    testImplementation(libs.roborazzi.compose)
+    testImplementation(libs.roborazzi.rule)
+    testImplementation(platform(libs.androidx.compose.bom))
+    testImplementation(libs.androidx.ui.test.junit4)
 
     // Android Testing - For instrumented tests
     androidTestImplementation(libs.androidx.junit)
diff --git a/app/src/test/java/com/example/cahier/ScreenshotTest.kt b/app/src/test/java/com/example/cahier/ScreenshotTest.kt
@@ -0,0 +1,53 @@
+package com.example.cahier
+
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.test.junit4.createComposeRule
+import androidx.compose.ui.test.onRoot
+import com.example.cahier.data.FakeNotesRepository
+import com.example.cahier.ui.HomePane
+import com.example.cahier.ui.viewmodels.HomeScreenViewModel
+import com.github.takahirom.roborazzi.RobolectricDeviceQualifiers
+import com.github.takahirom.roborazzi.captureRoboImage
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import org.robolectric.annotation.Config
+import org.robolectric.annotation.GraphicsMode
+
+@GraphicsMode(GraphicsMode.Mode.NATIVE)
+@RunWith(RobolectricTestRunner::class)
+class ScreenshotTest {
+
+    @get:Rule
+    val composeTestRule = createComposeRule()
+
+    private val fakeViewModel = HomeScreenViewModel(FakeNotesRepository())
+
+    @Composable
+    private fun HomeContent() {
+        HomePane(
+            navigateToCanvas = { _ -> },
+            navigateToDrawingCanvas = { _ -> },
+            navigateUp = {},
+            homeScreenViewModel = fakeViewModel
+        )
+    }
+
+    @Config(qualifiers = RobolectricDeviceQualifiers.MediumTablet)
+    @Test
+    fun globalNavigation_showNavRail() {
+        composeTestRule.setContent { HomeContent() }
+
+        composeTestRule.onRoot().captureRoboImage("reference_screenshot_navrail.png")
+    }
+
+    @Config(qualifiers = RobolectricDeviceQualifiers.Pixel7Pro)
+    @Test
+    fun globalNavigation_showBottomNavBar() {
+        composeTestRule.setContent { HomeContent() }
+
+        composeTestRule.onRoot().captureRoboImage("reference_screenshot_bottomnavbar.png")
+    }
+}
diff --git a/app/src/test/resources/robolectric.properties b/app/src/test/resources/robolectric.properties
@@ -0,0 +1 @@
+sdk=34
diff --git a/gradle.properties b/gradle.properties
@@ -21,4 +21,6 @@ kotlin.code.style=official
 # resources declared in the library itself and none from the library's dependencies,
 # thereby reducing the size of the R class for that library
 android.nonTransitiveRClass=true
-android.enableJetifier=false
+android.enableJetifier=false
+# Sets Roborazzi output folder to the one specified in the
+roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -35,6 +35,8 @@ coreTesting = "2.2.0"
 kotlinxCoroutinesTest = "1.10.2"
 turbine = "1.2.1"
 material3WindowSizeClass = "1.4.0"
+robolectric = "4.11.1"
+roborazzi = "1.51.0"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -92,9 +94,14 @@ hilt-android-testing = { module = "com.google.dagger:hilt-android-testing", vers
 turbine = { module = "app.cash.turbine:turbine", version.ref = "turbine" }
 mockito-android = { module = "org.mockito:mockito-android", version.ref = "mockito" }
 androidx-compose-material3-window-size-class1 = { group = "androidx.compose.material3", name = "material3-window-size-class", version.ref = "material3WindowSizeClass" }
+robolectric = { group = "org.robolectric", name = "robolectric", version.ref = "robolectric" }
+roborazzi = { group = "io.github.takahirom.roborazzi", name = "roborazzi", version.ref = "roborazzi" }
+roborazzi-compose = { group = "io.github.takahirom.roborazzi", name = "roborazzi-compose", version.ref = "roborazzi" }
+roborazzi-rule = { group = "io.github.takahirom.roborazzi", name = "roborazzi-junit-rule", version.ref = "roborazzi" }
 
 [plugins]
 androidApplication = { id = "com.android.application", version.ref = "agp" }
 androidLibrary = { id = "com.android.library", version.ref = "agp" }
 jetbrainsKotlinAndroid = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
-ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
+ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
+roborazzi = { id = "io.github.takahirom.roborazzi", version.ref = "roborazzi" }
diff --git a/screenshots/reference_screenshot_bottomnavbar.png b/screenshots/reference_screenshot_bottomnavbar.png
diff --git a/screenshots/reference_screenshot_navrail.png b/screenshots/reference_screenshot_navrail.png
