Add StoreScreenshotTest to generate store screenshots programmatically

opatry · opatry · commit de0039e0f640 · 2025-05-20T21:37:44.000+02:00
diff --git a/tasks-app-android/src/androidTest/kotlin/ScreenshotOnFailureRule.kt b/tasks-app-android/src/androidTest/kotlin/ScreenshotOnFailureRule.kt
@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2024 Olivier Patry
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software
+ * is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.uiautomator.UiDevice
+import org.junit.rules.TestWatcher
+import org.junit.runner.Description
+import java.io.File
+
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER)
+annotation class NoScreenshot
+
+private fun defaultScreenshotDir() = File(InstrumentationRegistry.getInstrumentation().targetContext.cacheDir, "test_failed_screenshots")
+
+class ScreenshotOnFailureRule(private val screenshotsDir: File = defaultScreenshotDir()) : TestWatcher() {
+    private val Description.allowScreenshot: Boolean
+        get() = getAnnotation(NoScreenshot::class.java) == null
+
+    override fun failed(e: Throwable?, description: Description?) {
+        description?.let { testDescription ->
+            if (testDescription.allowScreenshot) {
+                try {
+                    takeScreenshot(testDescription)
+                } catch (_: Exception) {
+                    // ignore screenshot processing errors
+                }
+            }
+        }
+        super.failed(e, description)
+    }
+
+    private fun takeScreenshot(testDescription: Description) {
+        val fileName = testDescription.displayName.take(150)
+        val outputFile = File(screenshotsDir, "$fileName.png").also {
+            it.parentFile?.mkdirs()
+        }
+        if (outputFile.exists()) {
+            outputFile.delete()
+        }
+        UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
+            .takeScreenshot(outputFile)
+    }
+}
diff --git a/tasks-app-android/src/androidTest/kotlin/StoreScreenshotTest.kt b/tasks-app-android/src/androidTest/kotlin/StoreScreenshotTest.kt
@@ -0,0 +1,198 @@
+/*
+ * Copyright (c) 2025 Olivier Patry
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software
+ * is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+
+import android.content.Context
+import androidx.appcompat.app.AppCompatDelegate
+import androidx.compose.ui.test.ExperimentalTestApi
+import androidx.compose.ui.test.assertIsDisplayed
+import androidx.compose.ui.test.hasTestTag
+import androidx.compose.ui.test.hasText
+import androidx.compose.ui.test.isDialog
+import androidx.compose.ui.test.junit4.createAndroidComposeRule
+import androidx.compose.ui.test.onNodeWithTag
+import androidx.compose.ui.test.onNodeWithText
+import androidx.compose.ui.test.performClick
+import androidx.compose.ui.test.performTextInput
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.uiautomator.UiDevice
+import kotlinx.coroutines.test.runTest
+import net.opatry.tasks.app.MainActivity
+import net.opatry.tasks.app.R
+import net.opatry.tasks.app.ui.component.TaskListScaffoldTestTag.ADD_TASK_FAB
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.COMPLETED_TASKS_TOGGLE
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.TASK_NOTES_FIELD
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.TASK_TITLE_FIELD
+import org.junit.Rule
+import org.junit.Test
+import java.io.File
+
+
+@OptIn(ExperimentalTestApi::class)
+class StoreScreenshotTest {
+
+    @get:Rule
+    val composeTestRule = createAndroidComposeRule<MainActivity>()
+
+    @get:Rule
+    val screenshotOnFailureRule = ScreenshotOnFailureRule()
+
+    private val targetContext: Context
+        get() = InstrumentationRegistry.getInstrumentation().targetContext
+
+    private fun takeScreenshot(name: String) {
+        val instrumentation = InstrumentationRegistry.getInstrumentation()
+        val outputDir = File(instrumentation.targetContext.cacheDir, "store_screenshots").also(File::mkdirs)
+        val outputFile = File(outputDir, "$name.png")
+        if (outputFile.exists()) {
+            outputFile.delete()
+        }
+        UiDevice.getInstance(instrumentation)
+            .takeScreenshot(outputFile)
+    }
+
+    private fun pressBack() {
+        // FIXME how to "press back" with ComposeTestRule (without Espresso)
+        //  UiDevice.getInstance(InstrumentationRegistry.getInstrumentation()).pressBack()
+        //  UI Automator doesn't work for navigation (but does for IME dismiss)
+        composeTestRule.activity.onBackPressed()
+    }
+
+    private fun dismissKeyboard() {
+        UiDevice.getInstance(InstrumentationRegistry.getInstrumentation()).pressBack()
+    }
+
+    private fun switchToNightMode(nightMode: Int) {
+        composeTestRule.activity.runOnUiThread {
+            composeTestRule.activity.delegate.localNightMode = nightMode
+        }
+        composeTestRule.activityRule.scenario.recreate()
+        composeTestRule.waitForIdle()
+    }
+
+    /**
+     * This test should be executed with the `demo` flavor which stub content for store screenshots.
+     */
+    @Test
+    fun storeScreenshotSequence() = runTest {
+        val initialNightMode = composeTestRule.activity.delegate.localNightMode
+
+        composeTestRule.waitForIdle()
+        takeScreenshot("initial_screen")
+
+        switchToNightMode(AppCompatDelegate.MODE_NIGHT_NO)
+
+        val defaultTaskTitle = targetContext.getString(R.string.demo_task_list_default)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(defaultTaskTitle))
+        composeTestRule.onNodeWithText(defaultTaskTitle)
+            .assertIsDisplayed()
+
+        val homeTaskTitle = targetContext.getString(R.string.demo_task_list_home)
+        composeTestRule.onNodeWithText(homeTaskTitle)
+            .assertIsDisplayed()
+
+        val groceriesTaskTitle = targetContext.getString(R.string.demo_task_list_groceries)
+        composeTestRule.onNodeWithText(groceriesTaskTitle)
+            .assertIsDisplayed()
+
+        val workTaskTitle = targetContext.getString(R.string.demo_task_list_work)
+        composeTestRule.onNodeWithText(workTaskTitle)
+            .assertIsDisplayed()
+
+        takeScreenshot("task_lists_light")
+
+        composeTestRule.onNodeWithText(defaultTaskTitle)
+            .assertIsDisplayed()
+            .performClick()
+        val defaultTask1Title = targetContext.getString(R.string.demo_task_list_default_task1)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(defaultTask1Title))
+        // FIXME unreliable, need to wait for something else?
+        takeScreenshot("my_tasks_light")
+
+        composeTestRule.waitUntilExactlyOneExists(hasTestTag(ADD_TASK_FAB))
+        composeTestRule.onNodeWithTag(ADD_TASK_FAB)
+            .assertIsDisplayed()
+            .performClick()
+        composeTestRule.waitUntilExactlyOneExists(isDialog())
+
+        composeTestRule.waitUntilExactlyOneExists(hasTestTag(TASK_TITLE_FIELD))
+        composeTestRule.onNodeWithTag(TASK_TITLE_FIELD)
+            .performTextInput("Wash the car 🧽")
+        composeTestRule.waitForIdle()
+        dismissKeyboard()
+
+        composeTestRule.waitUntilExactlyOneExists(hasTestTag(TASK_NOTES_FIELD))
+        composeTestRule.onNodeWithTag(TASK_NOTES_FIELD)
+            .performTextInput("Keys are in the drawer")
+
+        dismissKeyboard()
+
+        composeTestRule.waitForIdle()
+        takeScreenshot("add_task_light")
+
+        // FIXME how to dismiss bottom sheet without clicking on the button? (press back somehow? tap outside?)
+        // FIXME how to use Res strings from :tasks-app-shared?
+        composeTestRule.onNodeWithText("Cancel")
+            .assertIsDisplayed()
+            .performClick()
+        // go back
+        pressBack()
+        composeTestRule.waitUntilAtLeastOneExists(hasText(groceriesTaskTitle))
+
+        composeTestRule.onNodeWithText(groceriesTaskTitle)
+            .assertIsDisplayed()
+            .performClick()
+        val groceriesTask1Title = targetContext.getString(R.string.demo_task_list_groceries_task1)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(groceriesTask1Title))
+        composeTestRule.onNodeWithTag(COMPLETED_TASKS_TOGGLE)
+            .assertIsDisplayed()
+            .performClick()
+        val groceriesTask3Title = targetContext.getString(R.string.demo_task_list_groceries_task3)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(groceriesTask3Title))
+        takeScreenshot("groceries_light")
+
+        pressBack()
+        composeTestRule.waitUntilAtLeastOneExists(hasText(workTaskTitle))
+
+        composeTestRule.onNodeWithText(workTaskTitle)
+            .assertIsDisplayed()
+            .performClick()
+        val workTask1Title = targetContext.getString(R.string.demo_task_list_work_task1)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(workTask1Title))
+        takeScreenshot("work_light")
+
+        pressBack()
+        composeTestRule.waitUntilAtLeastOneExists(hasText(homeTaskTitle))
+
+        composeTestRule.onNodeWithText(homeTaskTitle)
+            .assertIsDisplayed()
+            .performClick()
+        val homeTask1Title = targetContext.getString(R.string.demo_task_list_home_task1)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(homeTask1Title))
+        takeScreenshot("home_light")
+
+        switchToNightMode(AppCompatDelegate.MODE_NIGHT_YES)
+        composeTestRule.waitUntilAtLeastOneExists(hasText(homeTask1Title))
+        takeScreenshot("home_dark")
+        switchToNightMode(initialNightMode)
+    }
+}
diff --git a/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/ui/component/TaskListScaffold.kt b/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/ui/component/TaskListScaffold.kt
@@ -41,7 +41,7 @@ import net.opatry.tasks.app.ui.component.TaskListScaffoldTestTag.ADD_TASK_FAB
 import net.opatry.tasks.data.TaskListSorting
 
 @VisibleForTesting
-internal object TaskListScaffoldTestTag {
+object TaskListScaffoldTestTag {
     const val ADD_TASK_FAB = "TASK_LIST_SCAFFOLD_ADD_TASK_FAB"
 }
 
diff --git a/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/ui/screen/tasksPane.kt b/tasks-app-shared/src/commonMain/kotlin/net/opatry/tasks/app/ui/screen/tasksPane.kt
@@ -26,6 +26,7 @@ import CalendarDays
 import ListPlus
 import LucideIcons
 import NotepadText
+import androidx.annotation.VisibleForTesting
 import androidx.compose.animation.AnimatedVisibility
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
@@ -69,6 +70,7 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.text.input.ImeAction
 import androidx.compose.ui.text.input.KeyboardType
 import androidx.compose.ui.unit.dp
@@ -94,6 +96,9 @@ import net.opatry.tasks.app.ui.component.TaskListEditMenuAction
 import net.opatry.tasks.app.ui.component.TaskListScaffold
 import net.opatry.tasks.app.ui.component.toColor
 import net.opatry.tasks.app.ui.component.toLabel
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.TASK_EDITOR_SHEET
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.TASK_NOTES_FIELD
+import net.opatry.tasks.app.ui.screen.TaskListPaneTestTag.TASK_TITLE_FIELD
 import net.opatry.tasks.resources.Res
 import net.opatry.tasks.resources.dialog_cancel
 import net.opatry.tasks.resources.task_due_date_update_cta
@@ -123,6 +128,14 @@ import net.opatry.tasks.resources.task_menu_move_to_new_list_create_task_list_di
 import net.opatry.tasks.resources.task_menu_move_to_new_list_create_task_list_dialog_title
 import org.jetbrains.compose.resources.stringResource
 
+@VisibleForTesting
+object TaskListPaneTestTag {
+    const val COMPLETED_TASKS_TOGGLE = "COMPLETED_TASKS_TOGGLE"
+    const val TASK_TITLE_FIELD = "TASK_TITLE_FIELD"
+    const val TASK_NOTES_FIELD = "TASK_NOTES_FIELD"
+    const val TASK_EDITOR_SHEET = "TASK_EDITOR_SHEET"
+}
+
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
 fun TaskListDetail(
@@ -320,6 +333,7 @@ fun TaskListDetail(
         val task = taskOfInterest
         ModalBottomSheet(
             sheetState = taskEditorSheetState,
+            modifier = Modifier.testTag(TASK_EDITOR_SHEET),
             onDismissRequest = {
                 taskOfInterest = null
                 showEditTaskSheet = false
@@ -368,7 +382,9 @@ fun TaskListDetail(
                         alreadyHadSomeContent = alreadyHadSomeContent || it.isNotBlank()
                         newTitle = it
                     },
-                    modifier = Modifier.fillMaxWidth(),
+                    modifier = Modifier
+                        .fillMaxWidth()
+                        .testTag(TASK_TITLE_FIELD),
                     label = { Text(stringResource(Res.string.task_editor_sheet_title_field_label)) },
                     placeholder = { Text(stringResource(Res.string.task_editor_sheet_title_field_placeholder)) },
                     maxLines = 1,
@@ -387,7 +403,9 @@ fun TaskListDetail(
                 OutlinedTextField(
                     newNotes,
                     onValueChange = { newNotes = it },
-                    modifier = Modifier.fillMaxWidth(),
+                    modifier = Modifier
+                        .fillMaxWidth()
+                        .testTag(TASK_NOTES_FIELD),
                     label = { Text(stringResource(Res.string.task_editor_sheet_notes_field_label)) },
                     placeholder = { Text(stringResource(Res.string.task_editor_sheet_notes_field_placeholder)) },
                     leadingIcon = { Icon(LucideIcons.NotepadText, null) },

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ import net.opatry.tasks.app.ui.component.TaskListScaffoldTestTag.ADD_TASK_FAB`
`41`	`41`	`import net.opatry.tasks.data.TaskListSorting`
`42`	`42`
`43`	`43`	`@VisibleForTesting`
`44`		`-internal object TaskListScaffoldTestTag {`
	`44`	`+object TaskListScaffoldTestTag {`
`45`	`45`	`const val ADD_TASK_FAB = "TASK_LIST_SCAFFOLD_ADD_TASK_FAB"`
`46`	`46`	`}`
`47`	`47`