Introduced groovySpock plugin for explicit Groovy and Spock configuration.

Author: AlexeyKuznetsov-DD

build.gradle.kts

@@ -2,10 +2,13 @@ import com.diffplug.gradle.spotless.SpotlessExtension
 import datadog.gradle.plugin.ci.testAggregate
 
 plugins {
+  kotlin("jvm") version libs.versions.kotlin.plugin apply false
+
   id("datadog.gradle-debug")
   id("datadog.dependency-locking")
   id("datadog.tracer-version")
   id("datadog.dump-hanged-test")
+  id("datadog.groovy-spock")
   id("config-inversion-linter")
   id("datadog.ci-jobs")
 
@@ -16,7 +19,6 @@ plugins {
   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

@@ -18,6 +18,7 @@ gradlePlugin {
       id = "instrument"
       implementationClass = "InstrumentPlugin"
     }
+
     create("muzzle-plugin") {
       id = "muzzle"
       implementationClass = "datadog.gradle.plugin.muzzle.MuzzlePlugin"
@@ -26,18 +27,27 @@ gradlePlugin {
       id = "call-site-instrumentation"
       implementationClass = "datadog.gradle.plugin.csi.CallSiteInstrumentationPlugin"
     }
+
+    create("groovy-spock-plugin") {
+      id = "datadog.groovy-spock"
+      implementationClass = "datadog.gradle.plugin.config.GroovySpockConventionPlugin"
+    }
+
     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("supported-config-generation") {
       id = "supported-config-generator"
       implementationClass = "datadog.gradle.plugin.config.SupportedConfigPlugin"
     }
+
     create("supported-config-linter") {
       id = "config-inversion-linter"
       implementationClass = "datadog.gradle.plugin.config.ConfigInversionLinter"
@@ -87,6 +97,7 @@ testing {
   suites {
     val test by getting(JvmTestSuite::class) {
       dependencies {
+        // TODO: We can refactor `buildSrc` code and tests to not use Groovy and Spock at all.
         implementation(libs.groovy)
         implementation(libs.spock.core)
       }

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

@@ -32,11 +32,12 @@ dependencies {
   implementation("org.freemarker", "freemarker", "2.3.30")
   implementation(libs.asm)
   implementation(libs.asm.tree)
-  implementation("com.github.javaparser", "javaparser-symbol-solver-core", "3.24.4")
+  implementation(libs.javaparser.solver)
 
   testImplementation(libs.bytebuddy)
   testImplementation(libs.groovy)
-  testImplementation(libs.bundles.spock)
+  testImplementation(libs.spock.core)
+  testImplementation(libs.objenesis)
   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/GroovySpockConventionPlugin.kt

@@ -0,0 +1,112 @@
+package datadog.gradle.plugin.config
+
+import groovy.lang.Closure
+import org.gradle.api.JavaVersion
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.artifacts.VersionCatalogsExtension
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.plugins.JavaLibraryPlugin
+import org.gradle.api.plugins.JavaPlugin
+import org.gradle.api.provider.MapProperty
+import org.gradle.api.tasks.compile.GroovyCompile
+import org.gradle.kotlin.dsl.extra
+import org.gradle.kotlin.dsl.mapProperty
+import org.gradle.kotlin.dsl.named
+import javax.inject.Inject
+
+/**
+ * Convention plugin that will configure Groovy and Spock.
+ *
+ * If nothing configured, then default configuration will be applied.
+ *
+ *  Following dependencies will be added to `testImplementation`:
+ *   * groovy-core
+ *   * groovy-json
+ *   * spock-core
+ *   * objenesis
+ */
+@Suppress("unused")
+class GroovySpockConventionPlugin : Plugin<Project> {
+  abstract class GroovySpockProperties @Inject constructor(objects: ObjectFactory) {
+    internal val compilerSettings: MapProperty<Int, List<String>> = objects.mapProperty()
+
+    internal val configurations: MapProperty<String, List<Any>> = objects.mapProperty()
+
+    fun configureGroovyCompiler(toolchainVersion: Int, vararg taskNames: String) {
+      compilerSettings.put(toolchainVersion, taskNames.toList())
+    }
+
+    fun configureDependencies(taskName: String, vararg dependencies: Any) {
+      configurations.put(taskName, dependencies.toList())
+    }
+  }
+
+  override fun apply(project: Project) {
+    if (project == project.rootProject) {
+      project.subprojects {
+        this.pluginManager.apply(GroovySpockConventionPlugin::class.java)
+      }
+      return
+    }
+
+    val extension = project.extensions.create("groovySpock", GroovySpockProperties::class.java)
+
+    configureCompiler(project, extension)
+
+    project.plugins.withType(JavaPlugin::class.java) {
+      configureDependencies(project, extension)
+    }
+
+    project.plugins.withType(JavaLibraryPlugin::class.java) {
+      configureDependencies(project, extension)
+    }
+  }
+
+  private fun configureCompiler(project: Project, properties: GroovySpockProperties) {
+    val compilerSettings = properties.compilerSettings
+
+    if (compilerSettings.isPresent) {
+      compilerSettings.get().forEach { (toolchainVersion: Int, taskNames: List<String>) ->
+        taskNames.forEach { taskName ->
+          project.tasks.named<GroovyCompile>(taskName) {
+            (project.extra["configureCompiler"] as Closure<*>).call(this, toolchainVersion, JavaVersion.VERSION_1_8, null)
+          }
+        }
+      }
+    }
+  }
+
+  private fun configureDependencies(project: Project, properties: GroovySpockProperties) {
+    // TODO: check `afterEvaluate` can be refactored to something else?
+    project.afterEvaluate {
+      val catalogs = project.extensions.getByType(VersionCatalogsExtension::class.java).named("libs")
+
+      fun findLibrary(alias: String) = catalogs.findLibrary(alias)
+        .orElseThrow { IllegalArgumentException("Library not found in catalog for alias: $alias") }
+
+      val defaultLibs = listOf(
+        findLibrary("groovy"),
+        findLibrary("groovy-json"),
+        findLibrary("spock-core"),
+        findLibrary("objenesis")
+      )
+
+      if (properties.configurations.isPresent) {
+        val configurations = properties.configurations.get()
+        if (configurations.isEmpty()) {
+          // If nothing configured, setup default configuration, suitable in most cases.
+          defaultLibs.forEach { project.dependencies.add("testImplementation", it) }
+        } else {
+          configurations.forEach { (cfg, deps) ->
+            defaultLibs.forEach { project.dependencies.add(cfg, it) }
+            deps.forEach { project.dependencies.add(cfg, it) }
+          }
+        }
+      } else {
+        // If nothing configured, setup default configuration, suitable in most cases.
+        defaultLibs.forEach { project.dependencies.add("testImplementation", it) }
+      }
+    }
+  }
+}

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 {
+  configureDependencies("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 {
+  configureDependencies("compileOnly")
+}
+
 dependencies {
   api project(':dd-java-agent:agent-ci-visibility')
   api project(':dd-java-agent:testing')
@@ -11,5 +15,7 @@ dependencies {
   api libs.jackson.databind
   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.junit.jupiter
 }
 

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

@@ -34,6 +34,10 @@ protobuf {
   }
 }
 
+groovySpock {
+  configureDependencies("testImplementation", libs.groovy.yaml)
+}
+
 dependencies {
   api libs.slf4j
 
@@ -50,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

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

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

dd-java-agent/appsec/appsec-test-fixtures/build.gradle

@@ -1,9 +1,15 @@
 apply from: "$rootDir/gradle/java.gradle"
 apply from: "$rootDir/gradle/version.gradle"
 
+groovySpock {
+  configureDependencies("compileOnly")
+}
+
 dependencies {
   api project(':dd-java-agent:appsec')
   api project(':dd-java-agent:instrumentation-testing')
+
+  compileOnly(libs.junit.jupiter)
 }
 
 configurations.named('api') {

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

@@ -1,17 +1,22 @@
 apply from: "$rootDir/gradle/java.gradle"
 
+groovySpock {
+  configureDependencies("compileOnly")
+  configureDependencies("testImplementation")
+}
+
 dependencies {
   api libs.bytebuddy
   api libs.bytebuddyagent
   api libs.slf4j
-  api libs.bundles.spock
   api libs.bundles.test.logging
   api libs.guava
 
   api project(':dd-java-agent:testing')
 
   implementation project(':dd-java-agent:agent-debugger')
 
+  implementation(libs.junit.jupiter)
   implementation "org.junit.platform:junit-platform-runner:${libs.versions.junit.platform.get()}"
 
   testImplementation project(':dd-java-agent:instrumentation:trace-annotation')