Add stricter plugin validation and fix issues. (#894)

* Add stricter plugin validation and fix issues.

This adds stricter plugin validation to check that all tasks are
declared cacheable or not and all properties are correctly marked.

This also fixes issues that the task discovered and adds it as a
dependency to the check task.

* Add changelog

* Update CHANGELOG.md

Co-authored-by: Roman Zavarnitsyn <[email protected]>

* Set path sensitivity to none

* Update plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryUploadProguardMappingsTask.kt

Co-authored-by: Roman Zavarnitsyn <[email protected]>

---------

Co-authored-by: Roman Zavarnitsyn <[email protected]>

Author: runningcode

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Enable caching for BundleSourcesTask ([#894](https://github.com/getsentry/sentry-android-gradle-plugin/pull/894)
+
 ### Dependencies
 
 - Bump Android SDK from v8.12.0 to v8.13.2 ([#896](https://github.com/getsentry/sentry-android-gradle-plugin/pull/896))

plugin-build/build.gradle.kts

@@ -319,3 +319,10 @@ buildConfig {
 }
 
 tasks.register<ASMifyTask>("asmify")
+
+tasks.named("check").configure { dependsOn(tasks.named("validatePlugins")) }
+
+tasks.withType<ValidatePlugins>().configureEach {
+  failOnWarning.set(true)
+  enableStricterValidation.set(true)
+}

plugin-build/src/main/kotlin/io/sentry/android/gradle/sourcecontext/BundleSourcesTask.kt

@@ -17,6 +17,7 @@ import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
+import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.InputFile
@@ -25,6 +26,7 @@ import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskProvider
 
+@CacheableTask
 abstract class BundleSourcesTask : SentryCliExecTask() {
 
   init {
@@ -41,7 +43,9 @@ abstract class BundleSourcesTask : SentryCliExecTask() {
   @get:InputDirectory
   abstract val sourceDir: DirectoryProperty
 
-  @get:InputFile abstract val bundleIdFile: RegularFileProperty
+  @get:InputFile
+  @get:PathSensitive(PathSensitivity.NONE)
+  abstract val bundleIdFile: RegularFileProperty
 
   @get:OutputDirectory abstract val output: DirectoryProperty
 

plugin-build/src/main/kotlin/io/sentry/android/gradle/sourcecontext/UploadSourceBundleTask.kt

@@ -15,8 +15,12 @@ import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskProvider
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "Uploads should not be cached")
 abstract class UploadSourceBundleTask : SentryCliExecTask() {
 
   init {
@@ -38,7 +42,9 @@ abstract class UploadSourceBundleTask : SentryCliExecTask() {
 
   @get:Input abstract val includeSourceContext: Property<Boolean>
 
-  @get:InputDirectory abstract val sourceBundleDir: DirectoryProperty
+  @get:InputDirectory
+  @get:PathSensitive(PathSensitivity.RELATIVE)
+  abstract val sourceBundleDir: DirectoryProperty
 
   @get:Input abstract val autoUploadSourceContext: Property<Boolean>
 

plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/DirectoryOutputTask.kt

@@ -3,7 +3,9 @@ package io.sentry.android.gradle.tasks
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.tasks.OutputDirectory
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "abstract task, should not be used directly")
 abstract class DirectoryOutputTask : DefaultTask() {
 
   @get:OutputDirectory abstract val output: DirectoryProperty

plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/PropertiesFileOutputTask.kt

@@ -3,7 +3,9 @@ package io.sentry.android.gradle.tasks
 import org.gradle.api.file.RegularFile
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Internal
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "abstract task, should not be used directly")
 abstract class PropertiesFileOutputTask : DirectoryOutputTask() {
   @get:Internal abstract val outputFile: Provider<RegularFile>
 }

plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryCliExecTask.kt

@@ -13,14 +13,21 @@ import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.Optional
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "abstract task, should not be used directly")
 abstract class SentryCliExecTask : Exec() {
 
   @get:Input @get:Optional abstract val debug: Property<Boolean>
 
   @get:Input abstract val cliExecutable: Property<String>
 
-  @get:InputFile @get:Optional abstract val sentryProperties: RegularFileProperty
+  @get:InputFile
+  @get:Optional
+  @get:PathSensitive(PathSensitivity.RELATIVE)
+  abstract val sentryProperties: RegularFileProperty
 
   @get:Input @get:Optional abstract val sentryOrganization: Property<String>
 

plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryUploadNativeSymbolsTask.kt

@@ -16,7 +16,9 @@ import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.TaskProvider
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "Uploads should not be cached")
 abstract class SentryUploadNativeSymbolsTask : SentryCliExecTask() {
 
   init {

plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryUploadProguardMappingsTask.kt

@@ -16,8 +16,12 @@ import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.InputFiles
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskProvider
+import org.gradle.work.DisableCachingByDefault
 
+@DisableCachingByDefault(because = "Uploads should not be cached")
 abstract class SentryUploadProguardMappingsTask : SentryCliExecTask() {
 
   init {
@@ -33,9 +37,11 @@ abstract class SentryUploadProguardMappingsTask : SentryCliExecTask() {
     outputs.upToDateWhen { true }
   }
 
-  @get:InputFile abstract val uuidFile: RegularFileProperty
+  @get:InputFile @get:PathSensitive(PathSensitivity.NONE) abstract val uuidFile: RegularFileProperty
 
-  @get:InputFiles abstract var mappingsFiles: Provider<FileCollection>
+  @get:InputFiles
+  @get:PathSensitive(PathSensitivity.RELATIVE)
+  abstract var mappingsFiles: Provider<FileCollection>
 
   @get:Input abstract val autoUploadProguardMapping: Property<Boolean>