Support verify gifs

paparazzi/src/main/java/app/cash/paparazzi/HtmlReportWriter.kt

@@ -101,7 +101,7 @@ public class HtmlReportWriter @JvmOverloads constructor(
         val shot = if (hashes.size == 1) {
           val original = File(imagesDirectory, "${hashes[0]}.png")
           if (isRecording) {
-            val goldenFile = File(goldenImagesDirectory, snapshot.toFileName("_", "png"))
+            val goldenFile = snapshot.goldenFile(goldenImagesDirectory)
             original.copyTo(goldenFile, overwrite = true)
           }
           snapshot.copy(file = original.toJsonPath())
@@ -110,11 +110,10 @@ public class HtmlReportWriter @JvmOverloads constructor(
 
           if (isRecording) {
             for ((index, frameHash) in hashes.withIndex()) {
-              val originalFrame = File(imagesDirectory, "$frameHash.png")
-              val frameSnapshot = snapshot.copy(name = "${snapshot.name} $index")
-              val goldenFile = File(goldenImagesDirectory, frameSnapshot.toFileName("_", "png"))
+              val goldenFile = snapshot.goldenFile(goldenImagesDirectory, frame = index)
               if (!goldenFile.exists()) {
-                originalFrame.copyTo(goldenFile)
+                val original = File(imagesDirectory, "$frameHash.png")
+                original.copyTo(goldenFile)
               }
             }
           }

paparazzi/src/main/java/app/cash/paparazzi/Snapshot.kt

@@ -16,6 +16,7 @@
 package app.cash.paparazzi
 
 import dev.drewhamilton.poko.Poko
+import java.io.File
 import java.util.Date
 import java.util.Locale
 
@@ -47,3 +48,12 @@ internal fun Snapshot.toFileName(
   }
   return "${testName.packageName}${delimiter}${testName.className}${delimiter}${testName.methodName}$formattedLabel.$extension"
 }
+
+internal fun Snapshot.goldenFile(goldenImagesDirectory: File, frame: Int? = null): File {
+  return if (frame == null) {
+    File(goldenImagesDirectory, toFileName("_", "png"))
+  } else {
+    val frameSnapshot = copy(name = "$name $frame")
+    File(goldenImagesDirectory, frameSnapshot.toFileName("_", "png"))
+  }
+}

paparazzi/src/main/java/app/cash/paparazzi/SnapshotVerifier.kt

@@ -39,9 +39,14 @@ public class SnapshotVerifier @JvmOverloads constructor(
     fps: Int
   ): FrameHandler {
     return object : FrameHandler {
+      var frame = 0
       override fun handle(image: BufferedImage) {
-        // Note: does not handle videos or its frames at the moment
-        val expected = File(imagesDirectory, snapshot.toFileName(extension = "png"))
+        // Note: does not handle videos at the moment
+        val expected = if (frameCount == 1) {
+          snapshot.goldenFile(imagesDirectory)
+        } else {
+          snapshot.goldenFile(imagesDirectory, frame++)
+        }
         if (!expected.exists()) {
           throw AssertionError("File $expected does not exist")
         }
@@ -55,7 +60,9 @@ public class SnapshotVerifier @JvmOverloads constructor(
         )
       }
 
-      override fun close() = Unit
+      override fun close() {
+        frame = 0
+      }
     }
   }
 

paparazzi/src/test/java/app/cash/paparazzi/SnapshotKtTest.kt

@@ -0,0 +1,59 @@
+package app.cash.paparazzi
+
+import com.google.common.truth.Truth.assertThat
+import org.junit.Test
+import java.io.File
+import java.time.Instant
+import java.util.Date
+
+class SnapshotKtTest {
+  @Test
+  fun withName() {
+    val path = Snapshot(
+      name = "loading",
+      testName = TestName("app.cash.paparazzi", "CelebrityTest", "testSettings"),
+      timestamp = Instant.parse("2019-03-20T10:27:43Z").toDate()
+    ).goldenFile(File("/a/path"))
+
+    assertThat(path)
+      .isEqualTo(File("/a/path/app.cash.paparazzi_CelebrityTest_testSettings_loading.png"))
+  }
+
+  @Test
+  fun withoutName() {
+    val path = Snapshot(
+      name = null,
+      testName = TestName("app.cash.paparazzi", "CelebrityTest", "testSettings"),
+      timestamp = Instant.parse("2019-03-20T10:27:43Z").toDate()
+    ).goldenFile(File("/a/path"))
+
+    assertThat(path)
+      .isEqualTo(File("/a/path/app.cash.paparazzi_CelebrityTest_testSettings.png"))
+  }
+
+  @Test
+  fun withNameAndFrame() {
+    val path = Snapshot(
+      name = "loading",
+      testName = TestName("app.cash.paparazzi", "CelebrityTest", "testSettings"),
+      timestamp = Instant.parse("2019-03-20T10:27:43Z").toDate()
+    ).goldenFile(File("/a/path"), 0)
+
+    assertThat(path)
+      .isEqualTo(File("/a/path/app.cash.paparazzi_CelebrityTest_testSettings_loading_0.png"))
+  }
+
+  @Test
+  fun withoutNameAndWithFrame() {
+    val path = Snapshot(
+      name = null,
+      testName = TestName("app.cash.paparazzi", "CelebrityTest", "testSettings"),
+      timestamp = Instant.parse("2019-03-20T10:27:43Z").toDate()
+    ).goldenFile(File("/a/path"), 1)
+
+    assertThat(path)
+      .isEqualTo(File("/a/path/app.cash.paparazzi_CelebrityTest_testSettings_null_1.png"))
+  }
+}
+
+private fun Instant.toDate() = Date(toEpochMilli())

sample/src/test/java/app/cash/paparazzi/sample/KeypadViewTest.kt

@@ -60,8 +60,7 @@ class KeypadViewTest {
       }
       rotation.start()
 
-      // Uncomment once snapshot verification supports videos
-      // paparazzi.gif(root, "spin", start = 500, end = 1500, fps = 30)
+      paparazzi.gif(root, "spin", start = 500, end = 1500, fps = 30)
     }
   }
 }