Enable gradle config cache (#7893)

Author: trask

buildSrc/src/main/kotlin/io/opentelemetry/gradle/OtelVersionClassPlugin.kt

@@ -1,9 +1,15 @@
 package io.opentelemetry.gradle
 
+import org.gradle.api.DefaultTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.plugins.JavaPlugin
 import org.gradle.api.plugins.JavaPluginExtension
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
 import org.gradle.kotlin.dsl.the
 import java.io.File
 
@@ -18,31 +24,48 @@ class OtelVersionClassPlugin : Plugin<Project> {
   override fun apply(project: Project) {
     project.plugins.apply(JavaPlugin::class.java)
 
-    project.tasks.register("generateOtelVersionClass") {
-      doLast {
-        writeFile(project)
-      }
+    val outDir = project.layout.buildDirectory.dir("generated/sources/version/java/main")
+
+    project.tasks.register("generateOtelVersionClass", GenerateOtelVersionClassTask::class.java) {
+      projectGroup.set("${project.group}")
+      projectName.set(project.name)
+      projectVersion.set("${project.version}")
+      outputDirectory.set(outDir)
     }
     // Add dependency on this task
-    project.tasks.getByName("compileJava") {
+    project.tasks.matching { it.name == "compileJava" || it.name == "sourcesJar" }.configureEach {
       dependsOn("generateOtelVersionClass")
     }
     // Add new source dir to the "main" source set
-    val outDir = buildOutDir(project)
     val java = project.the<JavaPluginExtension>()
     java.sourceSets.getByName("main").java {
       srcDir(outDir)
     }
   }
+}
+
+abstract class GenerateOtelVersionClassTask : DefaultTask() {
+  @get:Input
+  abstract val projectGroup: Property<String>
+
+  @get:Input
+  abstract val projectName: Property<String>
 
-  private fun writeFile(project: Project) {
-    val group = "${project.group}".replace('.', '/')
-    val projectName = project.name.replace('-', '/')
-    val outDir = buildOutDir(project)
-    val filename = "$group/$projectName/internal/OtelVersion.java"
+  @get:Input
+  abstract val projectVersion: Property<String>
+
+  @get:OutputDirectory
+  abstract val outputDirectory: DirectoryProperty
+
+  @TaskAction
+  fun generate() {
+    val group = projectGroup.get().replace('.', '/')
+    val name = projectName.get().replace('-', '/')
+    val outDir = outputDirectory.get().asFile
+    val filename = "$group/$name/internal/OtelVersion.java"
     val outFile = File(outDir, filename)
-    val packageName = "${project.group}.${project.name.replace('-', '.')}.internal"
-    val classBody = getClassBody("${project.version}", packageName)
+    val packageName = "${projectGroup.get()}.${projectName.get().replace('-', '.')}.internal"
+    val classBody = getClassBody(projectVersion.get(), packageName)
 
     outFile.parentFile.mkdirs()
     outFile.writeText(classBody)
@@ -63,8 +86,4 @@ class OtelVersionClassPlugin : Plugin<Project> {
       }
     """.trimIndent()
   }
-
-  private fun buildOutDir(project: Project): File {
-    return File(project.layout.buildDirectory.asFile.get(), "generated/sources/version/java/main")
-  }
 }

gradle.properties

@@ -1,5 +1,7 @@
 org.gradle.parallel=true
 org.gradle.caching=true
+org.gradle.configuration-cache=true
+org.gradle.configuration-cache.parallel=true
 
 org.gradle.priority=low
 

integration-tests/graal-incubating/build.gradle.kts

@@ -39,4 +39,17 @@ graalvmNative {
     }
   }
   toolchainDetection.set(false)
+  // Disable metadata repository to work around configuration cache incompatibility
+  // https://github.com/graalvm/native-build-tools/issues/477
+  metadataRepository {
+    enabled.set(false)
+  }
+}
+
+// GraalVM Native Build Tools plugin is not yet compatible with configuration cache
+// https://github.com/graalvm/native-build-tools/issues/477
+tasks.configureEach {
+  if (name.startsWith("native")) {
+    notCompatibleWithConfigurationCache("GraalVM Native Build Tools plugin is not compatible with configuration cache")
+  }
 }

integration-tests/graal/build.gradle.kts

@@ -36,4 +36,17 @@ graalvmNative {
     }
   }
   toolchainDetection.set(false)
+  // Disable metadata repository to work around configuration cache incompatibility
+  // https://github.com/graalvm/native-build-tools/issues/477
+  metadataRepository {
+    enabled.set(false)
+  }
+}
+
+// GraalVM Native Build Tools plugin is not yet compatible with configuration cache
+// https://github.com/graalvm/native-build-tools/issues/477
+tasks.configureEach {
+  if (name.startsWith("native")) {
+    notCompatibleWithConfigurationCache("GraalVM Native Build Tools plugin is not compatible with configuration cache")
+  }
 }

sdk-extensions/incubator/build.gradle.kts

@@ -146,36 +146,36 @@ val deleteJs2pTmp by tasks.registering(Delete::class) {
 }
 
 val buildGraalVmReflectionJson = tasks.register("buildGraalVmReflectionJson") {
+  val buildDir = buildDirectory
   val targetFile = File(
-    buildDirectory,
+    buildDir,
     "resources/main/META-INF/native-image/io.opentelemetry/io.opentelemetry.sdk.extension.incubator/reflect-config.json"
   )
+  val sourcePackage =
+    "io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model"
+  val sourcePackagePath = sourcePackage.replace(".", "/")
+  val classesDir =
+    File(
+      buildDir,
+      "classes/java/main/$sourcePackagePath"
+    )
+
+  inputs.dir(classesDir)
+  outputs.file(targetFile)
 
   onlyIf { !targetFile.exists() }
 
   dependsOn("compileJava")
 
   doLast {
     println("Generating GraalVM reflection config at: ${targetFile.absolutePath}")
-    val sourcePackage =
-      "io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model"
-    val sourcePackagePath = sourcePackage.replace(".", "/")
-
-    val classesDir =
-      File(
-        buildDirectory,
-        "classes/java/main/$sourcePackagePath"
-      )
 
     val classes = mutableListOf<String>()
-    fileTree(classesDir).forEach {
-      val path = it.path
-
-      val className = path
-        .substringAfter(sourcePackagePath)
-        .removePrefix("/")
+    classesDir.walkTopDown().filter { it.isFile && it.extension == "class" }.forEach { file ->
+      val relativePath = file.toRelativeString(classesDir)
+      val className = relativePath
         .removeSuffix(".class")
-        .replace("/", ".")
+        .replace(File.separatorChar, '.')
       classes.add("$sourcePackage.$className")
     }
     classes.sort()