Adapt screenshot tests to fetch screenshots from the device and save them to the host.

Archive screenshots at the end of tests.

Author: caarmen

Diff for: .github/workflows/tests.yaml

@@ -83,3 +83,11 @@ jobs:
           path: |
             ./app/build/outputs/apk/debug/app-debug.apk
             ./app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk
+      - name: Archive screenshots
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshots
+          path: |
+            ./screenshots-Light
+            ./screenshots-Dark

Diff for: app/src/androidTest/kotlin/ca/rmen/android/poetassistant/main/ScreenshotTest.kt

@@ -18,15 +18,14 @@
  */
 package ca.rmen.android.poetassistant.main
 
-import android.Manifest
+import android.app.Application
 import android.graphics.Bitmap
 import android.os.SystemClock
 import androidx.test.core.app.ApplicationProvider
 import androidx.test.espresso.Espresso
 import androidx.test.filters.LargeTest
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.test.rule.GrantPermissionRule
-import androidx.test.runner.screenshot.BasicScreenCaptureProcessor
+import androidx.test.runner.screenshot.ScreenCapture
 import androidx.test.runner.screenshot.ScreenCaptureProcessor
 import androidx.test.runner.screenshot.Screenshot
 import ca.rmen.android.poetassistant.R
@@ -41,6 +40,7 @@ import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
+import java.io.File
 import java.io.IOException
 
 
@@ -56,24 +56,33 @@ class ScreenshotTest {
     @TestParameter
     lateinit var themePreference: ThemePreference
 
+    private lateinit var deviceScreenshotsFolder: File
+
     @JvmField
     @Rule
-    var activityTestRule: PoetAssistantActivityTestRule<MainActivity> = PoetAssistantActivityTestRule(
+    val activityTestRule: PoetAssistantActivityTestRule<MainActivity> = PoetAssistantActivityTestRule(
         MainActivity::class.java, true
     )
 
-    @JvmField
-    @Rule
-    var writeScreenshotRule: GrantPermissionRule = GrantPermissionRule.grant(Manifest.permission.WRITE_EXTERNAL_STORAGE)
-
     @Before
-    fun setupTheme() {
+    fun setup() {
+        // Set the theme
         InstrumentationRegistry.getInstrumentation().runOnMainSync {
             val settingsPrefs =
                 SettingsPrefs(ApplicationProvider.getApplicationContext())
             settingsPrefs.theme = themePreference.value
             setThemeFromSettings(settingsPrefs)
         }
+
+        // Create a fresh folder to store the screenshots
+        deviceScreenshotsFolder = File(
+            ApplicationProvider.getApplicationContext<Application>().getExternalFilesDir(null),
+            "screenshots-${themePreference.value}"
+        )
+        if (deviceScreenshotsFolder.exists()) {
+            deviceScreenshotsFolder.deleteRecursively()
+        }
+        deviceScreenshotsFolder.mkdirs()
     }
 
     @Test
@@ -113,6 +122,22 @@ class ScreenshotTest {
         }
     }
 
+    private inner class Processor : ScreenCaptureProcessor {
+        override fun process(capture: ScreenCapture): String {
+            val deviceFile = File(deviceScreenshotsFolder, "${capture.name}.png")
+            deviceFile.outputStream().use {
+                capture.bitmap.compress(
+                    Bitmap.CompressFormat.PNG,
+                    0,
+                    it,
+                )
+            }
+            return deviceFile.absolutePath
+        }
+    }
+
+    private val processor = Processor()
+
     // https://stackoverflow.com/questions/38519568/how-to-take-screenshot-at-the-point-where-test-fail-in-espresso
     private fun takeScreenshot(filename: String) {
         SystemClock.sleep(500) // :(
@@ -121,11 +146,8 @@ class ScreenshotTest {
         capture.setName(filename)
         capture.setFormat(Bitmap.CompressFormat.PNG)
 
-        val processors = HashSet<ScreenCaptureProcessor>()
-        processors.add(BasicScreenCaptureProcessor())
-
         try {
-            capture.process(processors)
+            capture.process(setOf(processor))
         } catch (e: IOException) {
             e.printStackTrace()
         }

Diff for: etc/screenshots/rename.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+./gradlew assembleDebug assembleDebugAndroidTest
+mapfile -t devices < <(adb devices | grep "device$" | sed -e 's/\t.*$//g')
+
+# Install the app and test apk to the devices.
+for device in "${devices[@]}"; 
+do
+  echo "Installing apks to ${device}"
+  adb -s "${device}" install -r ./app/build/outputs/apk/debug/app-debug.apk
+  adb -s "${device}" install -r ./app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk
+done
+
+run_tests() {
+  device="$1"
+  output="/tmp/${device}.log"
+  echo "Running tests on ${device}, output to ${output}"
+  adb -s "${device}" shell settings put global animator_duration_scale 0
+  adb -s "${device}" shell settings put global transition_animation_scale 0
+  adb -s "${device}" shell settings put global window_animation_scale 0
+  adb -s "${device}" shell am instrument -w -m -e debug false -e class ca.rmen.android.poetassistant.main.ScreenshotTest ca.rmen.android.poetassistant.test.test/androidx.test.runner.AndroidJUnitRunner > "${output}" 2>&1
+
+  echo "pulling screenshots to ${device}-light and ${device}-dark"
+  if [ -e "${device}-light" ]
+  then
+    rm -rf "${device}-light"
+  fi
+  if [ -e "${device}-dark" ]
+  then
+    rm -rf "${device}-dark"
+  fi
+  base_folder=/storage/emulated/0/Android/data/ca.rmen.android.poetassistant.test/files
+  adb -s "${device}" pull "${base_folder}/screenshots-Light" "${device}-light"
+  adb -s "${device}" pull "${base_folder}/screenshots-Dark" "${device}-dark"
+}
+for device in "${devices[@]}"; 
+do
+  run_tests "$device" &
+done
+

Diff for: etc/screenshots/run.sh

@@ -5,3 +5,7 @@ adb shell settings put global transition_animation_scale 0
 adb shell settings put global window_animation_scale 0
 
 ./gradlew --no-daemon testDebugUnitTest cAT jacocoTestReport
+
+base_folder=/storage/emulated/0/Android/data/ca.rmen.android.poetassistant.test/files
+adb pull "${base_folder}/screenshots-Light"
+adb pull "${base_folder}/screenshots-Dark"