Merge pull request #240 from kozaxinan/depend-fix

joshafeinberg · web-flow · commit c5977c757098 · 2024-02-12T11:25:52.000-06:00
Set up dependOn task only if project is affected
diff --git a/affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorPlugin.kt b/affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorPlugin.kt
@@ -31,7 +31,7 @@ import org.gradle.util.GradleVersion
  *       logFolder = "${project.rootDir}".
  *   }
  *
- * To enable affected module detection, you need to pass [ENABLE_ARG]
+ * To enable affected module detection, you need to pass [com.dropbox.affectedmoduledetector.AffectedModuleDetector.Companion.ENABLE_ARG]
  * into the build as a command line parameter.
  *
  * See [AffectedModuleDetector] for additional flags.
@@ -125,7 +125,6 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {
         )
     }
 
-    @Suppress("UnstableApiUsage")
     @VisibleForTesting
     internal fun registerInternalTask(
         rootProject: Project,
@@ -151,6 +150,7 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {
         }
     }
 
+    @Suppress("UnstableApiUsage")
     private fun disableConfigCache(task: Task) {
         if (GradleVersion.current() >= GradleVersion.version("7.4")) {
             task.notCompatibleWithConfigurationCache("AMD requires knowledge of what has changed in the file system so we can not cache those values (https://github.com/dropbox/AffectedModuleDetector/issues/150)")
@@ -172,16 +172,16 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {
         project.pluginManager.withPlugin(pluginId) {
             getAffectedPath(testType, project)?.let { path ->
                 val pathOrNull = project.tasks.findByPath(path)
-                if (AffectedModuleDetector.isProjectProvided(project) && !isExcludedModule(config, path) && pathOrNull != null) {
-                    task.dependsOn(path)
+                val onlyIf = when {
+                    pathOrNull == null -> false
+                    !AffectedModuleDetector.isProjectEnabled(pathOrNull.project) -> true
+                    else -> AffectedModuleDetector.isProjectAffected(pathOrNull.project)
                 }
 
-                pathOrNull?.onlyIf { task ->
-                    when {
-                        !AffectedModuleDetector.isProjectEnabled(task.project) -> true
-                        else -> AffectedModuleDetector.isProjectAffected(task.project)
-                    }
+                if (onlyIf && AffectedModuleDetector.isProjectProvided(project)  && !isExcludedModule(config, path)) {
+                    task.dependsOn(path)
                 }
+                pathOrNull?.onlyIf { onlyIf }
             }
         }
     }
@@ -199,19 +199,23 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {
             InternalTaskType.ANDROID_TEST -> {
                 getPathAndTask(project, tasks.runAndroidTestTask)
             }
+
             InternalTaskType.ASSEMBLE_ANDROID_TEST -> {
                 getPathAndTask(project, tasks.assembleAndroidTestTask)
             }
+
             InternalTaskType.ANDROID_JVM_TEST -> {
                 getPathAndTask(project, tasks.jvmTestTask)
             }
+
             InternalTaskType.JVM_TEST -> {
                 if (tasks.jvmTestTask != AffectedTestConfiguration.DEFAULT_JVM_TEST_TASK) {
                     getPathAndTask(project, tasks.jvmTestTask)
                 } else {
                     getPathAndTask(project, taskType.originalGradleCommand)
                 }
             }
+
             else -> {
                 getPathAndTask(project, taskType.originalGradleCommand)
             }
@@ -254,14 +258,15 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {
     private fun requireConfiguration(project: Project): AffectedModuleConfiguration {
         return requireNotNull(
             value = project.rootProject.extensions.findByName(AffectedModuleConfiguration.name),
-            lazyMessage = {  "Unable to find ${AffectedModuleConfiguration.name} in ${project.rootProject}" }
+            lazyMessage = { "Unable to find ${AffectedModuleConfiguration.name} in ${project.rootProject}" }
         ) as AffectedModuleConfiguration
     }
 
     companion object {
 
         @VisibleForTesting
         internal const val TEST_TASK_GROUP_NAME = "Affected Module Detector"
+
         @VisibleForTesting
         internal const val CUSTOM_TASK_GROUP_NAME = "Affected Module Detector custom tasks"
 
diff --git a/affectedmoduledetector/src/test/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorIntegrationTest.kt b/affectedmoduledetector/src/test/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorIntegrationTest.kt
@@ -112,6 +112,9 @@ class AffectedModuleDetectorIntegrationTest {
 
         // THEN
         assertThat(result.output).contains(":sample-app:assembleDebugAndroidTest SKIPPED")
+        assertThat(result.output).contains(":sample-core:mergeDexDebugAndroidTest SKIPPED")
+        assertThat(result.output).contains(":sample-core:packageDebugAndroidTest SKIPPED")
+        assertThat(result.output).contains(":sample-core:assembleDebugAndroidTest SKIPPED")
         assertThat(result.output).contains(":sample-core:assembleAndroidTest SKIPPED")
         assertThat(result.output).contains(":assembleAffectedAndroidTests SKIPPED")
     }
@@ -190,7 +193,10 @@ class AffectedModuleDetectorIntegrationTest {
 
         // THEN
         assertThat(result.output).contains(":sample-app:assembleDebugAndroidTest SKIPPED")
-        assertThat(result.output).doesNotContain(":sample-core:assembleAndroidTest SKIPPED")
+        assertThat(result.output).doesNotContain(":sample-core:mergeDexDebugAndroidTest")
+        assertThat(result.output).doesNotContain(":sample-core:packageDebugAndroidTest")
+        assertThat(result.output).doesNotContain(":sample-core:assembleDebugAndroidTest")
+        assertThat(result.output).doesNotContain(":sample-core:assembleAndroidTest")
         assertThat(result.output).contains(":assembleAffectedAndroidTests SKIPPED")
     }
-}
+}
diff --git a/sample/buildSrc/src/main/kotlin/com/dropbox/sample/tasks/AffectedTasksPlugin.kt b/sample/buildSrc/src/main/kotlin/com/dropbox/sample/tasks/AffectedTasksPlugin.kt
@@ -53,16 +53,15 @@ class AffectedTasksPlugin : Plugin<Project> {
     private fun registerAffectedTestTask(
         taskName: String, testTask: String, testTaskBackup: String?,
         rootProject: Project
-    ): Task {
-        val task = rootProject.tasks.register(taskName) { task ->
+    ) {
+        rootProject.tasks.register(taskName) { task ->
             val paths = getAffectedPaths(testTask, testTaskBackup, rootProject)
             paths.forEach { path ->
                 task.dependsOn(path)
             }
             task.enabled = paths.isNotEmpty()
             task.onlyIf { paths.isNotEmpty() }
         }
-        return task.get()
     }
 
     private fun getAffectedPaths(

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ import org.gradle.util.GradleVersion`
`31`	`31`	`* logFolder = "${project.rootDir}".`
`32`	`32`	`* }`
`33`	`33`	`*`
`34`		`- * To enable affected module detection, you need to pass [ENABLE_ARG]`
	`34`	`+ * To enable affected module detection, you need to pass [com.dropbox.affectedmoduledetector.AffectedModuleDetector.Companion.ENABLE_ARG]`
`35`	`35`	`* into the build as a command line parameter.`
`36`	`36`	`*`
`37`	`37`	`* See [AffectedModuleDetector] for additional flags.`
`@@ -125,7 +125,6 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {`
`125`	`125`	`)`
`126`	`126`	`}`
`127`	`127`
`128`		`- @Suppress("UnstableApiUsage")`
`129`	`128`	`@VisibleForTesting`
`130`	`129`	`internal fun registerInternalTask(`
`131`	`130`	`rootProject: Project,`
`@@ -151,6 +150,7 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {`
`151`	`150`	`}`
`152`	`151`	`}`
`153`	`152`
	`153`	`+ @Suppress("UnstableApiUsage")`
`154`	`154`	`private fun disableConfigCache(task: Task) {`
`155`	`155`	`if (GradleVersion.current() >= GradleVersion.version("7.4")) {`
`156`	`156`	`task.notCompatibleWithConfigurationCache("AMD requires knowledge of what has changed in the file system so we can not cache those values (https://github.com/dropbox/AffectedModuleDetector/issues/150)")`
`@@ -172,16 +172,16 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {`
`172`	`172`	`project.pluginManager.withPlugin(pluginId) {`
`173`	`173`	`getAffectedPath(testType, project)?.let { path ->`
`174`	`174`	`val pathOrNull = project.tasks.findByPath(path)`
`175`		`- if (AffectedModuleDetector.isProjectProvided(project) && !isExcludedModule(config, path) && pathOrNull != null) {`
`176`		`- task.dependsOn(path)`
	`175`	`+ val onlyIf = when {`
	`176`	`+ pathOrNull == null -> false`
	`177`	`+ !AffectedModuleDetector.isProjectEnabled(pathOrNull.project) -> true`
	`178`	`+ else -> AffectedModuleDetector.isProjectAffected(pathOrNull.project)`
`177`	`179`	`}`
`178`	`180`
`179`		`- pathOrNull?.onlyIf { task ->`
`180`		`- when {`
`181`		`- !AffectedModuleDetector.isProjectEnabled(task.project) -> true`
`182`		`- else -> AffectedModuleDetector.isProjectAffected(task.project)`
`183`		`- }`
	`181`	`+ if (onlyIf && AffectedModuleDetector.isProjectProvided(project) && !isExcludedModule(config, path)) {`
	`182`	`+ task.dependsOn(path)`
`184`	`183`	`}`
	`184`	`+ pathOrNull?.onlyIf { onlyIf }`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`	`}`
`@@ -199,19 +199,23 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {`
`199`	`199`	`InternalTaskType.ANDROID_TEST -> {`
`200`	`200`	`getPathAndTask(project, tasks.runAndroidTestTask)`
`201`	`201`	`}`
	`202`	`+`
`202`	`203`	`InternalTaskType.ASSEMBLE_ANDROID_TEST -> {`
`203`	`204`	`getPathAndTask(project, tasks.assembleAndroidTestTask)`
`204`	`205`	`}`
	`206`	`+`
`205`	`207`	`InternalTaskType.ANDROID_JVM_TEST -> {`
`206`	`208`	`getPathAndTask(project, tasks.jvmTestTask)`
`207`	`209`	`}`
	`210`	`+`
`208`	`211`	`InternalTaskType.JVM_TEST -> {`
`209`	`212`	`if (tasks.jvmTestTask != AffectedTestConfiguration.DEFAULT_JVM_TEST_TASK) {`
`210`	`213`	`getPathAndTask(project, tasks.jvmTestTask)`
`211`	`214`	`} else {`
`212`	`215`	`getPathAndTask(project, taskType.originalGradleCommand)`
`213`	`216`	`}`
`214`	`217`	`}`
	`218`	`+`
`215`	`219`	`else -> {`
`216`	`220`	`getPathAndTask(project, taskType.originalGradleCommand)`
`217`	`221`	`}`
`@@ -254,14 +258,15 @@ class AffectedModuleDetectorPlugin : Plugin<Project> {`
`254`	`258`	`private fun requireConfiguration(project: Project): AffectedModuleConfiguration {`
`255`	`259`	`return requireNotNull(`
`256`	`260`	`value = project.rootProject.extensions.findByName(AffectedModuleConfiguration.name),`
`257`		`- lazyMessage = { "Unable to find ${AffectedModuleConfiguration.name} in ${project.rootProject}" }`
	`261`	`+ lazyMessage = { "Unable to find ${AffectedModuleConfiguration.name} in ${project.rootProject}" }`
`258`	`262`	`) as AffectedModuleConfiguration`
`259`	`263`	`}`
`260`	`264`
`261`	`265`	`companion object {`
`262`	`266`
`263`	`267`	`@VisibleForTesting`
`264`	`268`	`internal const val TEST_TASK_GROUP_NAME = "Affected Module Detector"`
	`269`	`+`
`265`	`270`	`@VisibleForTesting`
`266`	`271`	`internal const val CUSTOM_TASK_GROUP_NAME = "Affected Module Detector custom tasks"`
`267`	`272`
Original file line number	Diff line number	Diff line change
`@@ -53,16 +53,15 @@ class AffectedTasksPlugin : Plugin<Project> {`
`53`	`53`	`private fun registerAffectedTestTask(`
`54`	`54`	`taskName: String, testTask: String, testTaskBackup: String?,`
`55`	`55`	`rootProject: Project`
`56`		`- ): Task {`
`57`		`- val task = rootProject.tasks.register(taskName) { task ->`
	`56`	`+ ) {`
	`57`	`+ rootProject.tasks.register(taskName) { task ->`
`58`	`58`	`val paths = getAffectedPaths(testTask, testTaskBackup, rootProject)`
`59`	`59`	`paths.forEach { path ->`
`60`	`60`	`task.dependsOn(path)`
`61`	`61`	`}`
`62`	`62`	`task.enabled = paths.isNotEmpty()`
`63`	`63`	`task.onlyIf { paths.isNotEmpty() }`
`64`	`64`	`}`
`65`		`- return task.get()`
`66`	`65`	`}`
`67`	`66`
`68`	`67`	`private fun getAffectedPaths(`