Updates dropshots to always write reference image.

.github/workflows/publish.yml

@@ -71,23 +71,6 @@ jobs:
       pull-requests: write
 
     steps:
-      - name: Delete unnecessary tools 🔧
-        run: |
-          echo Remote tool cache
-          sudo rm -rf "$AGENT_TOOLSDIRECTORY" || true
-
-          echo Remove dotnet runtime
-          sudo rm -rf /usr/share/dotnet || true
-
-          echo Remove haskell runtime
-          sudo rm -rf /opt/ghc || true
-          sudo rm -rf /usr/local/.ghcup || true
-
-          echo Remove swap storage
-          sudo swapoff -a || true
-          sudo rm -f /mnt/swapfile || true
-          free -h
-
       - name: Enable KVM
         run: |
           echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
@@ -117,35 +100,32 @@ jobs:
           path: |
             ~/.android/avd/*
             ~/.android/adb*
-          key: ${{ runner.os }}-avd-x86_64-pixel_5-31
+          key: ${{ runner.os }}-avd1-x86_64-pixel_5-31
 
-      - name: Create AVD snapshot for caching
+      - name: Create AVD and generate snapshot for caching
         if: steps.avd-cache.outputs.cache-hit != 'true'
-        uses: reactivecircus/android-emulator-runner@v2
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d # v2.33.0
         with:
           api-level: 31
           arch: x86_64
           profile: pixel_5
           force-avd-creation: false
-          disable-animations: false
-          ram-size: 4096M
           emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
-          script: ./.github/scripts/emu_setup.sh && echo "Generated AVD snapshot for caching."
+          disable-animations: false
+          script: echo "Generated AVD snapshot for caching."
 
       - name: Run instrumentation tests
         id: screenshotsverify
         continue-on-error: true
-        uses: reactivecircus/android-emulator-runner@v2
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d # v2.33.0
         with:
           api-level: 31
           arch: x86_64
           profile: pixel_5
-          disable-animations: true
           force-avd-creation: false
-          ram-size: 4096M
           emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
-          # Workaround for https://github.com/ReactiveCircus/android-emulator-runner/issues/319
-          script: ./.github/scripts/emu_setup.sh && ./gradlew connectedCheck --stacktrace
+          disable-animations: true
+          script: ./gradlew connectedCheck --stacktrace
 
       - name: Prevent pushing new screenshots if this is a fork
         id: checkfork_screenshots
@@ -154,28 +134,28 @@ jobs:
         run: |
           echo "::error::Screenshot tests failed, please create a PR in your fork first." && exit 1
 
-      - name: Record new screenshots
-        id: screenshotsrecord
+      - name: Pull screenshots
+        id: screenshotspull
+        continue-on-error: true
         if: steps.screenshotsverify.outcome == 'failure' && github.event_name == 'pull_request'
-        uses: reactivecircus/android-emulator-runner@v2
+        run: |
+          echo "Pulling $(ls -1q dropshots/build/reports/androidTests/dropshots/reference/*.png | wc -l) files..."
+          ls -1q dropshots/build/reports/androidTests/dropshots/reference/*.png
+          cp dropshots/build/reports/androidTests/dropshots/reference/*.png dropshots/src/androidTest/assets/
+
+      # Since commits from actions don't trigger new actions, we validate the new screenshots here
+      # before we commit them to ensure there isn't flakiness in the tests.
+      - name: Validate updated screenshots
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d # v2.33.0
+        if: steps.screenshotsverify.outcome == 'failure' && steps.screenshotspull.outcome == 'success'
         with:
           api-level: 31
           arch: x86_64
           profile: pixel_5
-          disable-animations: true
           force-avd-creation: false
-          ram-size: 4096M
           emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
-          # Workaround for https://github.com/ReactiveCircus/android-emulator-runner/issues/319
-          script: ./.github/scripts/emu_setup.sh && ./gradlew connectedCheck -Pdropshots.record --stacktrace
-
-      - name: Pull screenshots
-        id: screenshotspull
-        continue-on-error: true
-        if: steps.screenshotsrecord.outcome == 'success' && github.event_name == 'pull_request'
-        run: |
-          rm dropshots/src/androidTest/assets/*.png || true
-          cp dropshots/build/reports/androidTests/dropshots/*.png dropshots/src/androidTest/assets/
+          disable-animations: true
+          script: ./gradlew connectedCheck --stacktrace
 
       - name: Push new screenshots if available
         uses: stefanzweifel/git-auto-commit-action@4b8a201e31cadd9829df349894b28c54e6c19fe6

README.md

@@ -132,15 +132,15 @@ have to create them...
 
 ### Updating reference images
 
-Updating reference screenshots is as simple as running the tests with a `dropshots.record` property
-added to Gradle. This makes it easy to update screenshots in a single step, without requiring you to
+Updating reference screenshots is as simple as running the `record[variant]Screenshots` Gradle task.
+This makes it easy to update screenshots in a single step, without requiring you to
 interact with the emulator or use esoteric `adb` commands.
 
 > **Important**: Ensure that you record screenshots on an emulator that's been configured in the
 > same way as the emulators on which you'll validate the screenshots.
 
 ```shell
-./gradlew :path:to:module:connectedAndroidTest -Pdropshots.record
+./gradlew :path:to:module:recordDebugScreenshots
 ```
 
 After running this command, you'll see that all reference screenshots for the module will have been

dropshots-gradle-plugin/api/dropshots-gradle-plugin.api

@@ -21,6 +21,16 @@ public abstract class com/dropbox/dropshots/PullScreenshotsTask : org/gradle/api
 	public final fun pullScreenshots ()V
 }
 
+public abstract class com/dropbox/dropshots/PushFileTask : org/gradle/api/DefaultTask {
+	public fun <init> ()V
+	public abstract fun getAdbExecutable ()Lorg/gradle/api/provider/Property;
+	protected abstract fun getExecOperations ()Lorg/gradle/process/ExecOperations;
+	public abstract fun getFileContents ()Lorg/gradle/api/provider/Property;
+	public abstract fun getRemotePath ()Lorg/gradle/api/provider/Property;
+	protected abstract fun getTempFileProvider ()Lorg/gradle/api/internal/file/temp/TemporaryFileProvider;
+	public final fun push ()V
+}
+
 public final class com/dropbox/dropshots/VersionKt {
 	public static final field VERSION Ljava/lang/String;
 }

dropshots-gradle-plugin/src/main/kotlin/com/dropbox/dropshots/DropshotsPlugin.kt

@@ -5,6 +5,7 @@ import com.android.build.gradle.LibraryExtension
 import com.android.build.gradle.TestedExtension
 import com.android.build.gradle.api.ApkVariant
 import com.android.build.gradle.internal.tasks.AndroidTestTask
+import com.android.build.gradle.internal.tasks.factory.dependsOn
 import java.util.Locale
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -27,12 +28,6 @@ public class DropshotsPlugin : Plugin<Project> {
   }
 
   private fun Project.configureDropshots(extension: TestedExtension) {
-    val isRecordingScreenshots = hasProperty(recordScreenshotsArg)
-
-    extension.buildTypes.getByName("debug") {
-      it.resValue("bool", "is_recording_screenshots", isRecordingScreenshots.toString())
-    }
-
     project.afterEvaluate {
       it.dependencies.add(
         "androidTestImplementation",
@@ -54,6 +49,7 @@ public class DropshotsPlugin : Plugin<Project> {
     val adbExecutablePath = provider { extension.adbExecutable.path }
     extension.testVariants.all { variant ->
       val testTaskProvider = variant.connectedInstrumentTestProvider
+      val variantSlug = variant.name.replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }
 
       val screenshotDir = provider {
         val appId = if (variant.testedVariant is ApkVariant) {
@@ -66,49 +62,61 @@ public class DropshotsPlugin : Plugin<Project> {
       }
 
       val clearScreenshotsTask = tasks.register(
-        "clear${variant.name.replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }}Screenshots",
+        "clear${variantSlug}Screenshots",
         ClearScreenshotsTask::class.java,
       ) {
         it.adbExecutable.set(adbExecutablePath)
         it.screenshotDir.set(screenshotDir)
       }
 
       val pullScreenshotsTask = tasks.register(
-        "pull${variant.name.replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }}Screenshots",
+        "pull${variantSlug}Screenshots",
         PullScreenshotsTask::class.java,
       ) {
-        it.onlyIf { !isRecordingScreenshots }
         it.adbExecutable.set(adbExecutablePath)
-        it.screenshotDir.set(screenshotDir)
+        it.screenshotDir.set(screenshotDir.map { base -> "$base/diff" })
         it.outputDirectory.set(testTaskProvider.flatMap { (it as AndroidTestTask).resultsDir })
         it.finalizedBy(clearScreenshotsTask)
       }
 
-      val updateScreenshotsTask = tasks.register(
-        "update${variant.name.replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }}Screenshots",
+      val recordScreenshotsTask = tasks.register(
+        "record${variantSlug}Screenshots",
         PullScreenshotsTask::class.java,
       ) {
         it.description = "Updates the local reference screenshots"
 
-        it.onlyIf { isRecordingScreenshots }
         it.adbExecutable.set(adbExecutablePath)
-        it.screenshotDir.set(screenshotDir)
+        it.screenshotDir.set(screenshotDir.map { base -> "$base/reference" })
         it.outputDirectory.set(referenceScreenshotDirectory)
         it.dependsOn(testTaskProvider)
         it.finalizedBy(clearScreenshotsTask)
       }
 
-      testTaskProvider.configure {
-        it.finalizedBy(pullScreenshotsTask, updateScreenshotsTask)
+      val isRecordingScreenshots = project.objects.property(Boolean::class.java)
+      if (hasProperty(recordScreenshotsArg)) {
+        project.logger.warn("The 'dropshots.record' property has been deprecated and will " +
+          "be removed in a future version.")
+        isRecordingScreenshots.set(true)
       }
-    }
-  }
+      project.gradle.taskGraph.whenReady { graph ->
+        isRecordingScreenshots.set(recordScreenshotsTask.map { graph.hasTask(it) })
+      }
+
+      val writeMarkerFileTask = tasks.register(
+        "push${variantSlug}ScreenshotMarkerFile",
+        PushFileTask::class.java,
+      ) {
+        it.onlyIf { isRecordingScreenshots.get() }
+        it.adbExecutable.set(adbExecutablePath)
+        it.fileContents.set("\n")
+        it.remotePath.set(screenshotDir.map { dir -> "$dir/.isRecordingScreenshots" })
+        it.finalizedBy(clearScreenshotsTask)
+      }
+      testTaskProvider.dependsOn(writeMarkerFileTask)
 
-  private fun Project.getAndroidExtension(): TestedExtension {
-    return when {
-      plugins.hasPlugin("com.android.application") -> extensions.findByType(AppExtension::class.java)!!
-      plugins.hasPlugin("com.android.library") -> extensions.findByType(LibraryExtension::class.java)!!
-      else -> throw IllegalArgumentException("Dropshots can only be applied to an Android project.")
+      testTaskProvider.configure {
+        it.finalizedBy(pullScreenshotsTask)
+      }
     }
   }
 }

dropshots-gradle-plugin/src/main/kotlin/com/dropbox/dropshots/PushFileTask.kt

@@ -0,0 +1,68 @@
+package com.dropbox.dropshots
+
+import java.io.ByteArrayOutputStream
+import java.nio.charset.StandardCharsets
+import java.util.regex.Pattern
+import javax.inject.Inject
+import org.gradle.api.DefaultTask
+import org.gradle.api.internal.file.temp.TemporaryFileProvider
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+import org.gradle.process.ExecOperations
+
+public abstract class PushFileTask : DefaultTask() {
+
+  @get:Input
+  public abstract val adbExecutable: Property<String>
+
+  /**
+   * The file to push to the emulator.
+   */
+  @get:Input
+  public abstract val fileContents: Property<String>
+
+  /**
+   * The path to the file or directory on the emulator.
+   */
+  @get:Input
+  public abstract val remotePath: Property<String>
+
+  @get:Inject
+  protected abstract val execOperations: ExecOperations
+
+  @get:Inject
+  protected abstract val tempFileProvider: TemporaryFileProvider
+
+  init {
+    description = "Push files to an emulator or device using adb."
+    outputs.upToDateWhen { false }
+  }
+
+  @TaskAction
+  public fun push() {
+    val tempFile = tempFileProvider.createTemporaryFile("adb-file", "", "dropshots")
+    tempFile.writeText(fileContents.get())
+
+    val adb = adbExecutable.get()
+    val remote = remotePath.get()
+    val output = ByteArrayOutputStream()
+    val checkResult = execOperations.exec {
+      it.executable = adb
+      it.args = listOf("devices")
+      it.isIgnoreExitValue = true
+      it.standardOutput = output
+    }
+
+    val whitespacePattern = Pattern.compile("\\s")
+    val hasConnectedDevice = output.toString(StandardCharsets.UTF_8).lines()
+      .any { it.trim().split(whitespacePattern).last() == "device" }
+
+    if (checkResult.exitValue == 0 && hasConnectedDevice) {
+      execOperations.exec {
+        it.executable = adb
+        it.args = listOf("push", tempFile.absolutePath, remote)
+      }
+    }
+  }
+}