Refactored groovy and spock configuration to plugin.

Author: AlexeyKuznetsov-DD

build.gradle.kts

@@ -2,21 +2,23 @@ import com.diffplug.gradle.spotless.SpotlessExtension
 import datadog.gradle.plugin.ci.testAggregate
 
 plugins {
-  id("datadog.gradle-debug")
+  kotlin("jvm") version libs.versions.kotlin.plugin apply false
+
+  id("datadog.ci-jobs")
+  id("datadog.config-inversion-linter")
   id("datadog.dependency-locking")
-  id("datadog.tracer-version")
   id("datadog.dump-hanged-test")
-  id("config-inversion-linter")
-  id("datadog.ci-jobs")
+  id("datadog.gradle-debug")
+  id("datadog.groovy-spock")
+  id("datadog.tracer-version")
 
   id("com.diffplug.spotless") version "6.13.0"
   id("com.github.spotbugs") version "5.0.14"
+  id("com.gradleup.shadow") version "8.3.6" apply false
   id("de.thetaphi.forbiddenapis") version "3.8"
   id("io.github.gradle-nexus.publish-plugin") version "2.0.0"
-  id("com.gradleup.shadow") version "8.3.6" apply false
   id("me.champeau.jmh") version "0.7.3" apply false
   id("org.gradle.playframework") version "0.13" apply false
-  kotlin("jvm") version libs.versions.kotlin.plugin apply false
 }
 
 description = "dd-trace-java"

buildSrc/build.gradle.kts

@@ -13,35 +13,47 @@ java {
 }
 
 gradlePlugin {
+  // Sorted list of plugins:
   plugins {
-    create("instrument-plugin") {
-      id = "instrument"
-      implementationClass = "InstrumentPlugin"
-    }
-    create("muzzle-plugin") {
-      id = "muzzle"
-      implementationClass = "datadog.gradle.plugin.muzzle.MuzzlePlugin"
-    }
     create("call-site-instrumentation-plugin") {
       id = "call-site-instrumentation"
       implementationClass = "datadog.gradle.plugin.CallSiteInstrumentationPlugin"
     }
-    create("tracer-version-plugin") {
-      id = "datadog.tracer-version"
-      implementationClass = "datadog.gradle.plugin.version.TracerVersionPlugin"
-    }
+
     create("dump-hanged-test-plugin") {
       id = "datadog.dump-hanged-test"
       implementationClass = "datadog.gradle.plugin.dump.DumpHangedTestPlugin"
     }
+
+    create("groovy-spock-plugin") {
+      id = "datadog.groovy-spock"
+      implementationClass = "datadog.gradle.plugin.config.groovy.GroovySpockConventionPlugin"
+    }
+
+    create("instrument-plugin") {
+      id = "instrument"
+      implementationClass = "InstrumentPlugin"
+    }
+
+    create("muzzle-plugin") {
+      id = "muzzle"
+      implementationClass = "datadog.gradle.plugin.muzzle.MuzzlePlugin"
+    }
+
     create("supported-config-generation") {
-      id = "supported-config-generator"
+      id = "datadog.supported-config-generator"
       implementationClass = "datadog.gradle.plugin.config.SupportedConfigPlugin"
     }
+
     create("supported-config-linter") {
-      id = "config-inversion-linter"
+      id = "datadog.config-inversion-linter"
       implementationClass = "datadog.gradle.plugin.config.ConfigInversionLinter"
     }
+
+    create("tracer-version-plugin") {
+      id = "datadog.tracer-version"
+      implementationClass = "datadog.gradle.plugin.version.TracerVersionPlugin"
+    }
   }
 }
 
@@ -76,6 +88,10 @@ dependencies {
   implementation("com.fasterxml.jackson.core:jackson-core")
 
   compileOnly(libs.develocity)
+
+  // We have to use Spock with Groovy3 as Gradle 8.x bundled with Groovy3.
+  // TODO: We can refactor `buildSrc` folder to not use Groovy at all.
+  testImplementation(libs.spock.core.groovy3)
 }
 
 tasks.compileKotlin {
@@ -86,10 +102,6 @@ testing {
   @Suppress("UnstableApiUsage")
   suites {
     val test by getting(JvmTestSuite::class) {
-      dependencies {
-        implementation(libs.groovy)
-        implementation(libs.spock.core)
-      }
       targets.configureEach {
         testTask.configure {
           enabled = project.hasProperty("runBuildSrcTests")

buildSrc/call-site-instrumentation-plugin/build.gradle.kts

@@ -35,8 +35,8 @@ dependencies {
   implementation(libs.javaparser.solver)
 
   testImplementation(libs.bytebuddy)
-  testImplementation(libs.bundles.groovy)
-  testImplementation(libs.bundles.spock)
+  testImplementation(libs.groovy4)
+  testImplementation(libs.spock.core.groovy4)
   testImplementation("javax.servlet", "javax.servlet-api", "3.0.1")
   testImplementation("com.github.spotbugs", "spotbugs-annotations", "4.2.0")
 }

buildSrc/src/main/kotlin/datadog/gradle/plugin/config/SupportedConfigPlugin.kt

@@ -19,8 +19,8 @@ class SupportedConfigPlugin : Plugin<Project> {
         className.set(extension.className)
       }
 
-    val sourceset = targetProject.extensions.getByType(SourceSetContainer::class.java).named(SourceSet.MAIN_SOURCE_SET_NAME)
-    sourceset.configure {
+    val sourceSet = targetProject.extensions.getByType(SourceSetContainer::class.java).named(SourceSet.MAIN_SOURCE_SET_NAME)
+    sourceSet.configure {
       java.srcDir(generateTask)
     }
 

buildSrc/src/main/kotlin/datadog/gradle/plugin/config/groovy/GroovySpockConventionPlugin.kt

@@ -0,0 +1,78 @@
+package datadog.gradle.plugin.config.groovy
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.artifacts.VersionCatalogsExtension
+import org.gradle.api.plugins.JavaLibraryPlugin
+import org.gradle.api.plugins.JavaPlugin
+
+@Suppress("unused")
+class GroovySpockConventionPlugin : Plugin<Project> {
+  override fun apply(project: Project) {
+    if (project == project.rootProject) {
+      project.subprojects {
+        this.pluginManager.apply(GroovySpockConventionPlugin::class.java)
+      }
+      return
+    }
+
+    val extension = project.extensions.create("groovySpock", GroovySpockExtension::class.java)
+
+    project.plugins.withType(JavaPlugin::class.java) {
+      configure(project, extension)
+    }
+
+    project.plugins.withType(JavaLibraryPlugin::class.java) {
+      configure(project, extension)
+    }
+  }
+
+  private fun configure(
+    project: Project,
+    extension: GroovySpockExtension
+  ) {
+    // TODO: check `afterEvaluate` is really needed.
+    project.afterEvaluate {
+      val groovyAlias = when (val groovyVersion = extension.groovyVersion.get()) {
+        3 -> "groovy3"
+        4 -> "groovy4"
+        else -> error("Unsupported groovyVersion=$groovyVersion (only 3 or 4 supported)")
+      }
+
+      val catalogs = project.extensions.getByType(VersionCatalogsExtension::class.java)
+      val libsCatalog = catalogs.named("libs")
+
+      fun findLibrary(alias: String) =
+        libsCatalog.findLibrary(alias)
+          .orElseThrow { IllegalArgumentException("No library '$alias' in version catalog 'libs'") }
+
+      val defaultLibs = listOf(
+        findLibrary(groovyAlias),
+        findLibrary("$groovyAlias-json"),
+        findLibrary("spock-core-$groovyAlias"),
+        findLibrary("objenesis")
+      )
+
+      fun configureDependencies(cfg: String, deps: List<Any>) =
+        deps.forEach { project.dependencies.add(cfg, it) }
+
+      // If nothing configured, setup default configuration
+      val configurations = extension.configurations
+
+      if (configurations.isEmpty()) {
+          configureDependencies("testImplementation", defaultLibs)
+      } else {
+        configurations.forEach { (cfg, deps) ->
+          deps.forEach { dep ->
+            if (dep is String && "default".equals(dep, ignoreCase = true)) {
+              configureDependencies(cfg, defaultLibs)
+            }
+            else {
+              project.dependencies.add(cfg, dep)
+            }
+          }
+        }
+      }
+    }
+  }
+}

buildSrc/src/main/kotlin/datadog/gradle/plugin/config/groovy/GroovySpockExtension.kt

@@ -0,0 +1,32 @@
+package datadog.gradle.plugin.config.groovy
+
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+import java.util.concurrent.ConcurrentHashMap
+import javax.inject.Inject
+
+/**
+ * Configuration for Groovy and Spock.
+ */
+abstract class GroovySpockExtension @Inject constructor(
+  objects: ObjectFactory
+) {
+  internal val configurations: MutableMap<String, MutableList<Any>> = ConcurrentHashMap()
+
+  internal val groovyVersion: Property<Int> =
+    objects.property(Int::class.java)
+      .convention(4)
+
+  fun groovyVersion(version: Int) {
+    groovyVersion.set(version)
+  }
+
+  fun configureDependency(taskName: String, dependency: Any) {
+    configurations.computeIfAbsent(taskName) { mutableListOf() }.add(dependency)
+  }
+
+  fun configureDefaultDependencies(taskName: String) {
+    configureDependency(taskName, "default")
+  }
+}
+

components/json/build.gradle.kts

@@ -5,5 +5,5 @@ plugins {
 apply(from = "$rootDir/gradle/java.gradle")
 
 jmh {
-  version = "1.28"
+  jmhVersion = libs.versions.jmh.get()
 }

dd-java-agent/agent-ci-visibility/civisibility-instrumentation-test-fixtures/build.gradle

@@ -1,6 +1,10 @@
 apply from: "$rootDir/gradle/java.gradle"
 apply from: "$rootDir/gradle/version.gradle"
 
+groovySpock {
+  configureDefaultDependencies("compileOnly")
+}
+
 dependencies {
   api project(':dd-java-agent:instrumentation-testing')
   api project(':dd-java-agent:agent-ci-visibility:civisibility-test-fixtures')

dd-java-agent/agent-ci-visibility/civisibility-test-fixtures/build.gradle

@@ -1,6 +1,10 @@
 apply from: "$rootDir/gradle/java.gradle"
 apply from: "$rootDir/gradle/version.gradle"
 
+groovySpock {
+  configureDefaultDependencies("compileOnly")
+}
+
 dependencies {
   api project(':dd-java-agent:agent-ci-visibility')
   api project(':dd-java-agent:testing')
@@ -12,6 +16,6 @@ dependencies {
   api group: 'org.msgpack', name: 'jackson-dataformat-msgpack', version: '0.9.6'
   api group: 'org.xmlunit', name: 'xmlunit-core', version: '2.10.3'
 
-  compileOnly libs.bundles.spock
+  compileOnly libs.junit.jupiter
 }
 

dd-java-agent/agent-iast/build.gradle

@@ -34,6 +34,11 @@ protobuf {
   }
 }
 
+groovySpock {
+  configureDefaultDependencies("testImplementation")
+  configureDependency("testImplementation", libs.groovy4.yaml)
+}
+
 dependencies {
   api libs.slf4j
 
@@ -49,7 +54,6 @@ dependencies {
   testImplementation project(':dd-java-agent:agent-bootstrap')
   testImplementation libs.bytebuddy
   testImplementation('org.skyscreamer:jsonassert:1.5.1')
-  testImplementation libs.groovy.yaml
   testImplementation libs.guava
 
   testImplementation group: 'io.grpc', name: 'grpc-core', version: grpcVersion
@@ -90,15 +94,6 @@ ext {
     'com.datadog.iast.model.json.FormattingAdapter',
     'com.datadog.iast.model.json.SourceTypeAdapter',
     'com.datadog.iast.model.json.VulnerabilityTypeAdapter',
-    'com.datadog.iast.taint.TaintedMap',
-    // TODO: Groovy 4 issues
-    'com.datadog.iast.taint.TaintedMap.TaintedMapImpl',
-    // TODO: Groovy 4 issues
-    'com.datadog.iast.taint.TaintedMap.TaintedMapImpl.1',
-    // TODO: Groovy 4 issues
-    'com.datadog.iast.taint.TaintedMap.Debug',
-    // TODO: Groovy 4 issues
-    'com.datadog.iast.taint.TaintedMap.NoOp', // TODO: Groovy 4 issues
   ]
   excludedClassesBranchCoverage = []
   excludedClassesInstructionCoverage = []