Improve screenshot testing with ComposablePreviewScanner (#3125)

* Use ComposablePreviewScanner to rework how screenshot testing works
* Add test sharding
* Update screenshots
* Fixes for Element Gallery

---------

Co-authored-by: ElementBot <[email protected]>
Co-authored-by: Benoit Marty <[email protected]>

Author: 3 people

.github/workflows/scripts/recordScreenshots.sh

@@ -65,7 +65,7 @@ echo "Deleting previous screenshots"
 ./gradlew removeOldSnapshots --stacktrace --warn
 
 echo "Record screenshots"
-./gradlew recordPaparazziDebug --stacktrace --warn
+./gradlew recordPaparazziDebug --stacktrace
 
 echo "Committing changes"
 git config http.sslVerify false

app/build.gradle.kts

@@ -31,7 +31,6 @@ plugins {
     id("io.element.android-compose-application")
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
     alias(libs.plugins.kapt)
     // When using precompiled plugins, we need to apply the firebase plugin like this
     id(libs.plugins.firebaseAppDistribution.get().pluginId)
@@ -283,6 +282,5 @@ dependencies {
     testImplementation(libs.test.turbine)
     testImplementation(projects.libraries.matrix.test)
 
-    ksp(libs.showkase.processor)
     koverDependencies()
 }

appconfig/build.gradle.kts

@@ -16,7 +16,6 @@
 plugins {
     id("io.element.android-library")
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
 }
 
 android {

appnav/build.gradle.kts

@@ -21,7 +21,6 @@ import extension.allFeaturesApi
 plugins {
     id("io.element.android-compose-library")
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
     alias(libs.plugins.kapt)
     id("kotlin-parcelize")
 }
@@ -78,6 +77,4 @@ dependencies {
     testImplementation(projects.services.analytics.test)
     testImplementation(libs.test.appyx.junit)
     testImplementation(libs.test.arch.core)
-
-    ksp(libs.showkase.processor)
 }

build.gradle.kts

@@ -160,15 +160,15 @@ allprojects {
             // Record all the languages?
             if (project.hasProperty("allLanguagesNoEnglish")) {
                 // Do not record English language
-                exclude("ui/S.class")
+                exclude("ui/*.class")
             } else if (project.hasProperty("allLanguages").not()) {
                 // Do not record other languages
-                exclude("ui/T.class")
+                exclude("translations/*.class")
             }
         } else {
             // Disable screenshot tests by default
-            exclude("ui/S.class")
-            exclude("ui/T.class")
+            exclude("ui/*.class")
+            exclude("translations/*.class")
         }
     }
 }

docs/screenshot_testing.md

@@ -13,7 +13,7 @@
 ## Overview
 
 - Screenshot tests are tests which record the content of a rendered screen and verify subsequent runs to check if the screen renders differently.
-- Element X uses [Paparazzi](https://github.com/cashapp/paparazzi) to render, record and verify Composable. All Composable Preview will be use to make screenshot test, thanks to the usage of [Showkase](https://github.com/airbnb/Showkase).
+- Element X uses [Paparazzi](https://github.com/cashapp/paparazzi) to render, record and verify Composables. All internal/public Composable Preview will be used for screenshot tests, thanks to the usage of [ComposablePreviewScanner](https://github.com/sergio-sastre/ComposablePreviewScanner).
 - The screenshot verification occurs on every pull request as part of the `tests.yml` workflow.
 
 ## Setup

features/analytics/api/build.gradle.kts

@@ -15,7 +15,6 @@
  */
 plugins {
     id("io.element.android-compose-library")
-    alias(libs.plugins.ksp)
 }
 
 android {
@@ -27,6 +26,4 @@ dependencies {
     implementation(projects.libraries.designsystem)
     implementation(projects.libraries.androidutils)
     implementation(projects.libraries.uiStrings)
-
-    ksp(libs.showkase.processor)
 }

features/analytics/impl/build.gradle.kts

@@ -17,7 +17,6 @@
 plugins {
     id("io.element.android-compose-library")
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
     id("kotlin-parcelize")
 }
 
@@ -42,7 +41,6 @@ dependencies {
     implementation(projects.appconfig)
     implementation(libs.androidx.datastore.preferences)
     implementation(libs.androidx.browser)
-    ksp(libs.showkase.processor)
 
     testImplementation(libs.test.junit)
     testImplementation(libs.coroutines.test)

features/call/impl/build.gradle.kts

@@ -17,7 +17,6 @@
 plugins {
     id("io.element.android-compose-library")
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
     id("kotlin-parcelize")
     alias(libs.plugins.kotlin.serialization)
 }
@@ -57,7 +56,6 @@ dependencies {
     implementation(libs.network.retrofit)
     implementation(libs.serialization.json)
     api(projects.features.call.api)
-    ksp(libs.showkase.processor)
 
     testImplementation(libs.coroutines.test)
     testImplementation(libs.molecule.runtime)

features/createroom/impl/build.gradle.kts

@@ -17,7 +17,6 @@
 plugins {
     id("io.element.android-compose-library")
     alias(libs.plugins.anvil)
-    alias(libs.plugins.ksp)
     id("kotlin-parcelize")
 }
 
@@ -71,6 +70,4 @@ dependencies {
     testImplementation(projects.tests.testutils)
     testImplementation(libs.androidx.compose.ui.test.junit)
     testReleaseImplementation(libs.androidx.compose.ui.test.manifest)
-
-    ksp(libs.showkase.processor)
 }