Update task inputs for resources and assets to account for file renam…

…es and moves (#1226)
cashapp · Jan 13, 2024 · 23f0dcd · 23f0dcd
1 parent 8c17639
commit 23f0dcd
Show file tree

Hide file tree

Showing 28 changed files with 525 additions and 5 deletions.
diff --git a/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PrepareResourcesTask.kt b/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PrepareResourcesTask.kt
@@ -44,23 +44,23 @@ abstract class PrepareResourcesTask : DefaultTask() {
   abstract val compileSdkVersion: Property<String>
 
   @get:InputFiles
-  @get:PathSensitive(PathSensitivity.NONE)
+  @get:PathSensitive(PathSensitivity.RELATIVE)
   abstract val projectResourceDirs: ConfigurableFileCollection
 
   @get:InputFiles
-  @get:PathSensitive(PathSensitivity.NONE)
+  @get:PathSensitive(PathSensitivity.RELATIVE)
   abstract val moduleResourceDirs: ConfigurableFileCollection
 
   @get:InputFiles
-  @get:PathSensitive(PathSensitivity.NONE)
+  @get:PathSensitive(PathSensitivity.RELATIVE)
   abstract val aarExplodedDirs: ConfigurableFileCollection
 
   @get:InputFiles
-  @get:PathSensitive(PathSensitivity.NONE)
+  @get:PathSensitive(PathSensitivity.RELATIVE)
   abstract val projectAssetDirs: ConfigurableFileCollection
 
   @get:InputFiles
-  @get:PathSensitive(PathSensitivity.NONE)
+  @get:PathSensitive(PathSensitivity.RELATIVE)
   abstract val aarAssetDirs: ConfigurableFileCollection
 
   @Deprecated("legacy asset loading, to be removed in a future release")

diff --git a/paparazzi-gradle-plugin/src/test/java/app/cash/paparazzi/gradle/PaparazziPluginTest.kt b/paparazzi-gradle-plugin/src/test/java/app/cash/paparazzi/gradle/PaparazziPluginTest.kt
@@ -847,6 +847,286 @@ class PaparazziPluginTest {
     assertThat(resourceFileContents[8]).matches("^caches/transforms-3/[0-9a-f]{32}/transformed/external/res\$")
   }
 
+  @Test
+  fun verifyResourcesUpdatedWhenLocalResourceChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-local-resources-change")
+    val buildDir = fixtureRoot.resolve("build").registerForDeletionOnExit()
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    val valuesDir = File(fixtureRoot, "src/main/res/values/").registerForDeletionOnExit()
+    val destResourceFile = File(valuesDir, "colors.xml")
+    val firstResourceFile = File(fixtureRoot, "src/test/resources/colors1.xml")
+    val secondResourceFile = File(fixtureRoot, "src/test/resources/colors2.xml")
+
+    // Original resource
+    firstResourceFile.copyTo(destResourceFile, overwrite = false)
+
+    val firstRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(fixtureRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[6]).isEqualTo("src/main/res,src/debug/res")
+
+    buildDir.deleteRecursively()
+
+    // Update resource
+    secondResourceFile.copyTo(destResourceFile, overwrite = true)
+
+    val secondRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[6]).isEqualTo("src/main/res,src/debug/res")
+  }
+
+  @Test
+  fun verifyResourcesUpdatedWhenModuleResourceChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-module-resources-change")
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    val consumerModuleRoot = File(fixtureRoot, "consumer")
+    val buildDir = consumerModuleRoot.resolve("build").registerForDeletionOnExit()
+
+    val producerModuleRoot = File(fixtureRoot, "producer")
+    val valuesDir = File(producerModuleRoot, "src/main/res/values/").registerForDeletionOnExit()
+    val destResourceFile = File(valuesDir, "colors.xml")
+    val firstResourceFile = File(producerModuleRoot, "src/test/resources/colors1.xml")
+    val secondResourceFile = File(producerModuleRoot, "src/test/resources/colors2.xml")
+
+    // Original resource
+    firstResourceFile.copyTo(destResourceFile, overwrite = false)
+
+    val firstRun = gradleRunner
+      .withArguments(":consumer:preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":consumer:preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(consumerModuleRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[7]).isEqualTo("../producer/build/intermediates/packaged_res/debug")
+
+    buildDir.deleteRecursively()
+
+    // Update resource
+    secondResourceFile.copyTo(destResourceFile, overwrite = true)
+
+    val secondRun = gradleRunner
+      .withArguments(":consumer:preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":consumer:preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[7]).isEqualTo("../producer/build/intermediates/packaged_res/debug")
+  }
+
+  @Test
+  fun verifyResourcesUpdatedWhenExternalDependencyChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-aar-resources-change")
+    val buildDir = fixtureRoot.resolve("build").registerForDeletionOnExit()
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    System.setProperty("isFirstRun", "true")
+
+    val firstRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(fixtureRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[8]).matches("^caches/transforms-3/[0-9a-f]{32}/transformed/external1/res\$")
+
+    buildDir.deleteRecursively()
+
+    System.setProperty("isFirstRun", "false")
+
+    val secondRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[8]).matches("^caches/transforms-3/[0-9a-f]{32}/transformed/external2/res\$")
+  }
+
+  @Test
+  fun verifyAssetsUpdatedWhenLocalAssetChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-local-assets-change")
+    val buildDir = fixtureRoot.resolve("build").registerForDeletionOnExit()
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    val assetsDir = File(fixtureRoot, "src/main/assets/").registerForDeletionOnExit()
+    val destAssetFile = File(assetsDir, "secret.txt")
+    val firstAssetFile = File(fixtureRoot, "src/test/resources/secret1.txt")
+    val secondAssetFile = File(fixtureRoot, "src/test/resources/secret2.txt")
+
+    // Original asset
+    firstAssetFile.copyTo(destAssetFile, overwrite = false)
+
+    val firstRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(fixtureRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[9]).isEqualTo("src/main/assets,src/debug/assets")
+
+    buildDir.deleteRecursively()
+
+    // Update asset
+    secondAssetFile.copyTo(destAssetFile, overwrite = true)
+
+    val secondRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[9]).isEqualTo("src/main/assets,src/debug/assets")
+  }
+
+  @Test
+  fun verifyAssetsUpdatedWhenModuleAssetChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-module-assets-change")
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    val consumerModuleRoot = File(fixtureRoot, "consumer")
+    val buildDir = consumerModuleRoot.resolve("build").registerForDeletionOnExit()
+
+    val producerModuleRoot = File(fixtureRoot, "producer")
+    val assetsDir = File(producerModuleRoot, "src/main/assets/").registerForDeletionOnExit()
+    val destAssetFile = File(assetsDir, "secret.txt")
+    val firstAssetFile = File(producerModuleRoot, "src/test/resources/secret1.txt")
+    val secondAssetFile = File(producerModuleRoot, "src/test/resources/secret2.txt")
+
+    // Original asset
+    firstAssetFile.copyTo(destAssetFile, overwrite = false)
+
+    val firstRun = gradleRunner
+      .withArguments(":consumer:preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":consumer:preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(consumerModuleRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[9]).isEqualTo("src/main/assets,src/debug/assets,../producer/build/intermediates/library_assets/debug/out")
+
+    buildDir.deleteRecursively()
+
+    // Update asset
+    secondAssetFile.copyTo(destAssetFile, overwrite = true)
+
+    val secondRun = gradleRunner
+      .withArguments(":consumer:preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":consumer:preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[9]).isEqualTo("src/main/assets,src/debug/assets,../producer/build/intermediates/library_assets/debug/out")
+  }
+
+  @Test
+  fun verifyAssetsUpdatedWhenExternalDependencyChanges() {
+    val fixtureRoot = File("src/test/projects/verify-update-aar-assets-change")
+    val buildDir = fixtureRoot.resolve("build").registerForDeletionOnExit()
+    fixtureRoot.resolve("build-cache").registerForDeletionOnExit()
+
+    System.setProperty("isFirstRun", "true")
+
+    val firstRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(firstRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    val resourcesFile = File(fixtureRoot, "build/intermediates/paparazzi/debug/resources.txt")
+
+    var resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[10]).matches("^caches/transforms-3/[0-9a-f]{32}/transformed/external1/assets\$")
+
+    buildDir.deleteRecursively()
+
+    System.setProperty("isFirstRun", "false")
+
+    val secondRun = gradleRunner
+      .withArguments(":preparePaparazziDebugResources", "--build-cache", "--stacktrace")
+      .forwardOutput()
+      .runFixture(fixtureRoot) { build() }
+
+    with(secondRun.task(":preparePaparazziDebugResources")) {
+      assertThat(this).isNotNull()
+      assertThat(this!!.outcome).isEqualTo(SUCCESS)
+    }
+
+    resourceFileContents = resourcesFile.readLines()
+    assertThat(resourceFileContents[10]).matches("^caches/transforms-3/[0-9a-f]{32}/transformed/external2/assets\$")
+  }
+
   @Test
   fun verifyTargetSdkIsSameAsCompileSdk() {
     val fixtureRoot = File("src/test/projects/verify-resources-java")

diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/build.gradle b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/build.gradle
@@ -0,0 +1,26 @@
+plugins {
+  id 'com.android.library'
+  id 'kotlin-android'
+  id 'app.cash.paparazzi'
+}
+
+android {
+  namespace 'app.cash.paparazzi.plugin.test'
+  compileSdk libs.versions.compileSdk.get() as int
+  defaultConfig {
+    minSdk libs.versions.minSdk.get() as int
+  }
+  compileOptions {
+    sourceCompatibility = libs.versions.javaTarget.get()
+    targetCompatibility = libs.versions.javaTarget.get()
+  }
+}
+
+dependencies {
+  def isFirstRun = System.getProperty("isFirstRun", "false").toBoolean()
+  if (isFirstRun) {
+    implementation files('libs/external1.aar')
+  } else {
+    implementation files('libs/external2.aar')
+  }
+}
diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/libs/external1.aar b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/libs/external1.aar
diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/libs/external2.aar b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/libs/external2.aar
diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/settings.gradle b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-assets-change/settings.gradle
@@ -0,0 +1,7 @@
+apply from: '../test.settings.gradle'
+
+buildCache {
+  local {
+    directory = new File(rootDir, 'build-cache')
+  }
+}
diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/build.gradle b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/build.gradle
@@ -0,0 +1,26 @@
+plugins {
+  id 'com.android.library'
+  id 'kotlin-android'
+  id 'app.cash.paparazzi'
+}
+
+android {
+  namespace 'app.cash.paparazzi.plugin.test'
+  compileSdk libs.versions.compileSdk.get() as int
+  defaultConfig {
+    minSdk libs.versions.minSdk.get() as int
+  }
+  compileOptions {
+    sourceCompatibility = libs.versions.javaTarget.get()
+    targetCompatibility = libs.versions.javaTarget.get()
+  }
+}
+
+dependencies {
+  def isFirstRun = System.getProperty("isFirstRun", "false").toBoolean()
+  if (isFirstRun) {
+    implementation files('libs/external1.aar')
+  } else {
+    implementation files('libs/external2.aar')
+  }
+}
diff --git a/...zzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/libs/external1.aar b/...zzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/libs/external1.aar
diff --git a/...zzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/libs/external2.aar b/...zzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/libs/external2.aar
diff --git a/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/settings.gradle b/paparazzi-gradle-plugin/src/test/projects/verify-update-aar-resources-change/settings.gradle
@@ -0,0 +1,7 @@
+apply from: '../test.settings.gradle'
+
+buildCache {
+  local {
+    directory = new File(rootDir, 'build-cache')
+  }
+}