chore: Refactor additional configurations to a ConfigurableFileCollection

Author: bric3

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

@@ -2,19 +2,16 @@ package datadog.gradle.plugin.csi
 
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
+import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.model.ObjectFactory
-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.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 java.util.Locale
 import javax.inject.Inject
 
 
@@ -77,35 +74,12 @@ abstract class CallSiteInstrumentationExtension @Inject constructor(
     objectFactory.listProperty<String>().convention(listOf("-Xmx128m", "-Xms64m"))
 
   /**
-   * The configurations to use to look for the call site instrumenter dependencies.
+   * The paths used 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).
+   * The plugin includes by default **only** the `main` and `test` source sets, and their
+   * related compilation classpath. As we don't want other test configurations by default.
+   *
+   * However, it's possible to contribute additional paths to look for dependencies.
    */
-  val configurations: ListProperty<Configuration> = objectFactory.listProperty<Configuration>().convention(
-    project.provider {
-      project.configurations.matching {
-        // Includes all main* source sets, but only the test (as wee don;t want other )
-        // * For main => runtimeClasspath, compileClasspath
-        // * For test => testRuntimeClasspath, testCompileClasspath
-        // * For other main* => "main_javaXXRuntimeClasspath", "main_javaXXCompileClasspath"
-
-        when (it.name) {
-          // Regular main and test source sets
-          RUNTIME_CLASSPATH_CONFIGURATION_NAME,
-          COMPILE_CLASSPATH_CONFIGURATION_NAME,
-          TEST_SOURCE_SET_NAME + RUNTIME_CLASSPATH_CONFIGURATION_NAME.capitalize(),
-          TEST_SOURCE_SET_NAME + COMPILE_CLASSPATH_CONFIGURATION_NAME.capitalize() -> true
-
-          else -> false
-        }
-      }
-    }
-  )
-
-  private fun String.capitalize(): String = replaceFirstChar {
-    if (it.isLowerCase()) it.titlecase(
-      Locale.getDefault()
-    ) else it.toString()
-  }
+  val additionalPaths: ConfigurableFileCollection = objectFactory.fileCollection()
 }

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

@@ -2,9 +2,13 @@ package datadog.gradle.plugin.csi
 
 import org.gradle.api.GradleException
 import org.gradle.api.JavaVersion
+import org.gradle.api.NamedDomainObjectSet
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.artifacts.Configuration
 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.plugins.JavaPluginExtension
 import org.gradle.api.tasks.JavaExec
 import org.gradle.api.tasks.SourceSet.MAIN_SOURCE_SET_NAME
@@ -25,6 +29,7 @@ import org.gradle.kotlin.dsl.withType
 import java.io.File
 import java.nio.file.Files
 import java.nio.file.Paths
+import java.util.Locale
 import javax.inject.Inject
 
 private const val CALL_SITE_INSTRUMENTER_MAIN_CLASS = "datadog.trace.plugin.csi.PluginApplication"
@@ -159,7 +164,8 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
         val callsitesClassPath = project.objects.fileCollection()
           .from(
             project.sourceSets.named(MAIN_SOURCE_SET_NAME).map { it.output },
-            csiExtension.configurations
+            project.defaultConfigurations,
+            csiExtension.additionalPaths
           )
 
         if (project.logger.isInfoEnabled) {
@@ -209,6 +215,30 @@ abstract class CallSiteInstrumentationPlugin : Plugin<Project>{
     }
   }
 
+  private val Project.defaultConfigurations: NamedDomainObjectSet<Configuration>
+    get() = project.configurations.matching {
+      // Includes all main* source sets, but only the test (as wee don;t want other )
+      // * For main => runtimeClasspath, compileClasspath
+      // * For test => testRuntimeClasspath, testCompileClasspath
+      // * For other main* => "main_javaXXRuntimeClasspath", "main_javaXXCompileClasspath"
+
+      when (it.name) {
+        // Regular main and test source sets
+        RUNTIME_CLASSPATH_CONFIGURATION_NAME,
+        COMPILE_CLASSPATH_CONFIGURATION_NAME,
+        TEST_SOURCE_SET_NAME + RUNTIME_CLASSPATH_CONFIGURATION_NAME.capitalize(),
+        TEST_SOURCE_SET_NAME + COMPILE_CLASSPATH_CONFIGURATION_NAME.capitalize() -> true
+
+        else -> false
+      }
+    }
+
+  private fun String.capitalize(): String = replaceFirstChar {
+    if (it.isLowerCase()) it.titlecase(
+      Locale.getDefault()
+    ) else it.toString()
+  }
+
   private val Project.sourceSets: SourceSetContainer
     get() = project.extensions.getByType<JavaPluginExtension>().sourceSets
 }

dd-java-agent/instrumentation/scala/build.gradle

@@ -63,6 +63,10 @@ final testTasks = scalaVersions.collect { scalaLibrary ->
     }
   }
 
+  csi {
+    additionalPaths.from(classPathConfiguration)
+  }
+
   return tasks.register("test$version", Test) {
     classpath = classpath
       .filter { !it.toString().contains('scala-library') }   // exclude default scala-library