Add roborazzi snapshots (#231)

trevor-e · web-flow · commit f71febffd361 · 2024-11-20T17:02:31.000-05:00
diff --git a/.github/workflows/android_emerge_snapshots.yml b/.github/workflows/android_emerge_snapshots.yml
@@ -8,7 +8,7 @@ on:
     paths: [ android/** ]
 
 jobs:
-  build:
+  emerge:
     runs-on: ubuntu-latest
 
     defaults:
@@ -30,3 +30,44 @@ jobs:
           EMERGE_API_TOKEN: ${{ secrets.EMERGE_API_KEY }}
           PR_SHA: ${{ github.event.pull_request.head.sha }}
           PR_BASE_SHA: ${{ github.event.pull_request.base.sha }}
+
+  roborazzi:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./android
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Ruby setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.5
+          bundler-cache: true
+
+      - name: Setup gems
+        run: gem install emerge
+
+      - name: Generate Roborazzi snapshots
+        run: ./gradlew :app:recordRoborazziDebug
+
+      - name: Upload snapshots
+        env:
+          EMERGE_API_TOKEN: ${{ secrets.EMERGE_API_KEY }}
+        run: |
+          emerge upload snapshots \
+            --name "HackerNews Swift-Snapshot-Testing" \
+            --id "com.emerge.hackernews.roborazzi" \
+            --repo-name "EmergeTools/hackernews" \
+            --debug \
+            app/build/outputs/roborazzi
diff --git a/android/app/build.gradle.kts b/android/app/build.gradle.kts
@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.ksp)
   alias(libs.plugins.emerge)
   alias(libs.plugins.sentry)
+  alias(libs.plugins.roborazzi)
 }
 
 val runningEnv: String? = System.getenv("RUNNING_ENV")
@@ -81,6 +82,11 @@ android {
       excludes += "/META-INF/{AL2.0,LGPL2.1}"
     }
   }
+  testOptions {
+    unitTests {
+      isIncludeAndroidResources = true
+    }
+  }
 }
 
 composeCompiler {
@@ -145,9 +151,15 @@ dependencies {
 
   implementation(libs.androidx.room)
   implementation(libs.androidx.room.ktx)
+  implementation(libs.androidx.ui.test.junit4.android)
   ksp(libs.androidx.room.compiler)
 
   testImplementation(libs.junit)
+  testImplementation(libs.robolectric)
+  testImplementation(libs.roborazzi)
+  testImplementation(libs.roborazzi.compose)
+  testImplementation(libs.roborazzi.rule)
+
   androidTestImplementation(libs.androidx.junit)
   androidTestImplementation(libs.androidx.espresso.core)
   androidTestImplementation(platform(libs.androidx.compose.bom))
diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml
@@ -30,6 +30,8 @@
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+
+        <activity android:name="androidx.activity.ComponentActivity" android:exported="true" />
     </application>
 
-</manifest>
+</manifest>
diff --git a/android/app/src/test/kotlin/BookmarksScreenComposeTest.kt b/android/app/src/test/kotlin/BookmarksScreenComposeTest.kt
@@ -0,0 +1,73 @@
+package com.github.takahirom.roborazzi.usage.examples
+
+import androidx.compose.ui.test.junit4.createComposeRule
+import androidx.compose.ui.test.onRoot
+import com.emergetools.hackernews.features.bookmarks.BookmarksScreen
+import com.emergetools.hackernews.features.bookmarks.BookmarksState
+import com.emergetools.hackernews.features.stories.StoryItem
+import com.emergetools.hackernews.ui.theme.HackerNewsTheme
+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.GraphicsMode
+import java.time.Instant
+
+@GraphicsMode(GraphicsMode.Mode.NATIVE)
+@RunWith(RobolectricTestRunner::class)
+class BookmarksScreenComposeTest {
+
+  @get:Rule
+  val composeRule = createComposeRule()
+
+  @Test
+  fun roborazziTest() {
+    composeRule.setContent {
+      HackerNewsTheme {
+        BookmarksScreen(
+          state = BookmarksState(
+            bookmarks = listOf(
+              StoryItem.Content(
+                id = 1L,
+                title = "Show HN: A new Android client",
+                author = "heyrikin",
+                score = 10,
+                commentCount = 45,
+                epochTimestamp = Instant.now().minusSeconds(60 * 60 * 3).epochSecond,
+                bookmarked = true,
+                url = ""
+              ),
+              StoryItem.Content(
+                id = 2L,
+                title = "Can we stop the decline of monarch butterflies and other pollinators?",
+                author = "rbro112",
+                score = 40,
+                commentCount = 23,
+                epochTimestamp = Instant.now().minusSeconds(60 * 60 * 2).epochSecond,
+                bookmarked = true,
+                url = ""
+              ),
+              StoryItem.Content(
+                id = 3L,
+                title = "Andy Warhol's lost Amiga art found",
+                author = "telkins",
+                score = 332,
+                commentCount = 103,
+                epochTimestamp = Instant.now().minusSeconds(60 * 60 * 7).epochSecond,
+                bookmarked = true,
+                url = ""
+              ),
+            )
+          ),
+          actions = {},
+          navigator = {}
+        )
+      }
+    }
+
+    composeRule
+      .onRoot()
+      .captureRoboImage()
+  }
+}
diff --git a/android/app/src/test/kotlin/StoryRowComposeTest.kt b/android/app/src/test/kotlin/StoryRowComposeTest.kt
@@ -0,0 +1,39 @@
+package com.github.takahirom.roborazzi.usage.examples
+
+import androidx.compose.ui.test.junit4.createComposeRule
+import androidx.compose.ui.test.onRoot
+import com.emergetools.hackernews.features.stories.StoryItem
+import com.emergetools.hackernews.ui.components.StoryRow
+import com.emergetools.hackernews.ui.theme.HackerNewsTheme
+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.GraphicsMode
+
+@GraphicsMode(GraphicsMode.Mode.NATIVE)
+@RunWith(RobolectricTestRunner::class)
+class StoryRowComposeTest {
+
+  @get:Rule
+  val composeRule = createComposeRule()
+
+  @Test
+  fun roborazziTest() {
+    composeRule.setContent {
+      HackerNewsTheme {
+        StoryRow(
+          item = StoryItem.Loading(id = 1L),
+          onClick = {},
+          onBookmark = {},
+          onCommentClicked = {},
+        )
+      }
+    }
+
+    composeRule
+      .onRoot()
+      .captureRoboImage()
+  }
+}
diff --git a/android/build.gradle.kts b/android/build.gradle.kts
@@ -5,4 +5,5 @@ plugins {
   alias(libs.plugins.compose.compiler) apply false
   alias(libs.plugins.kotlin.serialization) apply false
   alias(libs.plugins.kotlin.ksp) apply false
+  alias(libs.plugins.roborazzi) apply false
 }
diff --git a/android/gradle/libs.versions.toml b/android/gradle/libs.versions.toml
@@ -4,8 +4,10 @@ kotlin = "2.0.21"
 ksp = "2.0.21-1.0.28"
 coreKtx = "1.13.1"
 junit = "4.13.2"
-junitVersion = "1.2.1"
-espressoCore = "3.6.1"
+junitVersion = "1.1.5" # This is to match Compose's version
+robolectric = "4.14"
+roborazzi = "1.8.0-alpha-5"
+espressoCore = "3.5.0" # This is to match Compose's version
 lifecycleRuntimeKtx = "2.8.7"
 activityCompose = "1.9.3"
 retrofit = "2.11.0"
@@ -25,6 +27,7 @@ room = "2.6.1"
 jsoup = "1.18.1"
 extendedspans = "1.4.0"
 composeBom = "2024.11.00"
+uiTestJunit4Android = "1.7.5"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -62,8 +65,13 @@ emerge-reaper = { group = "com.emergetools.reaper", name = "reaper", version.ref
 emerge-distribution = { group = "com.emergetools.distribution", name = "distribution", version.ref = "emergeDistribution" }
 
 junit = { group = "junit", name = "junit", version.ref = "junit" }
+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" }
 androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
 androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
+androidx-ui-test-junit4-android = { group = "androidx.compose.ui", name = "ui-test-junit4-android", version.ref = "uiTestJunit4Android" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
@@ -73,5 +81,6 @@ kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", versi
 kotlin-ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 emerge = { id = "com.emergetools.android", version.ref = "emergePlugin" }
 sentry = { id = "io.sentry.android.gradle", version.ref = "sentry" }
+roborazzi = { id = "io.github.takahirom.roborazzi", version.ref = "roborazzi" }
 
 

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@ plugins {`
`5`	`5`	`alias(libs.plugins.compose.compiler) apply false`
`6`	`6`	`alias(libs.plugins.kotlin.serialization) apply false`
`7`	`7`	`alias(libs.plugins.kotlin.ksp) apply false`
	`8`	`+ alias(libs.plugins.roborazzi) apply false`
`8`	`9`	`}`