fix: Restrict default CSI classpath to main and test, compile and runtime configurations.

Author: bric3

buildSrc/src/main/kotlin/datadog/gradle/plugin/csi/CallSiteInstrumentationExtension.kt

@@ -1,11 +1,20 @@
 package datadog.gradle.plugin.csi
 
+import org.gradle.api.Project
+import org.gradle.api.artifacts.Configuration
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.model.ObjectFactory
+import org.gradle.api.plugins.JavaPlugin
+import org.gradle.api.plugins.JavaPlugin.COMPILE_CLASSPATH_CONFIGURATION_NAME
+import org.gradle.api.plugins.JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
+import org.gradle.api.tasks.SourceSet.MAIN_SOURCE_SET_NAME
+import org.gradle.api.tasks.SourceSet.TEST_SOURCE_SET_NAME
 import org.gradle.jvm.toolchain.JavaLanguageVersion
+import org.gradle.kotlin.dsl.listProperty
+import org.gradle.kotlin.dsl.property
 import java.io.File
 import javax.inject.Inject
 
@@ -14,6 +23,7 @@ import javax.inject.Inject
  * This extension allows to configure the Call Site Instrumenter plugin execution.
  */
 abstract class CallSiteInstrumentationExtension @Inject constructor(
+  project: Project,
   objectFactory: ObjectFactory,
   layout: ProjectLayout
 ) {
@@ -66,4 +76,20 @@ abstract class CallSiteInstrumentationExtension @Inject constructor(
    */
   val jvmArgs: ListProperty<String> =
     objectFactory.listProperty<String>().convention(listOf("-Xmx128m", "-Xms64m"))
+
+  /**
+   * The configurations to use to look for the call site instrumenter dependencies.
+   *
+   * By default, includes all `main*` source sets, but only the `test`
+   * (as wee don't want other test configurations by default).
+   */
+  val configurations = objectFactory.listProperty<Configuration>().convention(
+    project.provider {
+      project.configurations.matching {
+        // Includes all main* source sets, but only the test (as wee don;t want other )
+        (it.name.startsWith(MAIN_SOURCE_SET_NAME) || it.name == TEST_SOURCE_SET_NAME)
+            && (it.name.endsWith(RUNTIME_CLASSPATH_CONFIGURATION_NAME, ignoreCase = true) || it.name.endsWith(COMPILE_CLASSPATH_CONFIGURATION_NAME, ignoreCase = true))
+      }
+    }
+  )
 }

buildSrc/src/main/kotlin/datadog/gradle/plugin/csi/CallSiteInstrumentationPlugin.kt

@@ -4,10 +4,10 @@ import org.gradle.api.GradleException
 import org.gradle.api.JavaVersion
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.JavaExec
-import org.gradle.api.tasks.SourceSet
+import org.gradle.api.tasks.SourceSet.MAIN_SOURCE_SET_NAME
+import org.gradle.api.tasks.SourceSet.TEST_SOURCE_SET_NAME
 import org.gradle.api.tasks.SourceSetContainer
 import org.gradle.api.tasks.compile.AbstractCompile
 import org.gradle.api.tasks.testing.Test
@@ -43,7 +43,7 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
     // create a new source set for the csi files
     val targetFolder = newBuildFolder(project, extension.targetFolder.get().asFile.toString())
     val sourceSets = getSourceSets(project)
-    val mainSourceSet = sourceSets.named(SourceSet.MAIN_SOURCE_SET_NAME).get()
+    val mainSourceSet = sourceSets.named(MAIN_SOURCE_SET_NAME).get()
     val csiSourceSet = sourceSets.create("csi") {
       compileClasspath += mainSourceSet.output // mainly needed for the plugin tests
       annotationProcessorPath += mainSourceSet.annotationProcessorPath
@@ -60,7 +60,7 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
     }
 
     // add csi classes to test classpath
-    sourceSets.named(SourceSet.TEST_SOURCE_SET_NAME) {
+    sourceSets.named(TEST_SOURCE_SET_NAME) {
       compileClasspath += csiSourceSet.output.classesDirs
       runtimeClasspath += csiSourceSet.output.classesDirs
     }
@@ -152,7 +152,10 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
 
       // Write the call site instrumenter arguments into a temporary file
       doFirst {
-        val programClassPath = getProgramClasspath(project).map { it.toString() }
+        val programClassPath = extension.configurations.get().flatMap {
+          it.files
+        }.map { it.toString() }
+
         val arguments = listOf(
           extension.srcFolder.get().asFile.toString(),
           inputProvider.get().asFile.toString(),
@@ -172,7 +175,7 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
 
     // make all sourcesets' class tasks depend on call site generator
     val sourceSets = getSourceSets(project)
-    sourceSets.named(SourceSet.MAIN_SOURCE_SET_NAME) {
+    sourceSets.named(MAIN_SOURCE_SET_NAME) {
       project.tasks.named(classesTaskName) {
         dependsOn(callSiteGeneratorTask)
       }
@@ -185,19 +188,4 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
       }
     }
   }
-
-  private fun getProgramClasspath(project: Project): List<File> {
-    val classpath = ArrayList<File>()
-    // 1. Compilation outputs - exclude latestDep and forked test variants
-    project.tasks.withType<AbstractCompile>()
-      .filter { task -> !task.name.contains("LatestDep", ignoreCase = true) && !task.name.contains("Forked", ignoreCase = true) }
-      .map { it.destinationDirectory.asFile.get() }
-      .forEach(classpath::add)
-    // 2. Compile time dependencies - exclude latestDep and forked test variants
-    project.tasks.withType<AbstractCompile>()
-      .filter { task -> !task.name.contains("LatestDep", ignoreCase = true) && !task.name.contains("Forked", ignoreCase = true) }
-      .flatMap { it.classpath }
-      .forEach(classpath::add)
-    return classpath
-  }
 }