|
1 | 1 | /* |
2 | 2 | * Gradle debugging plugin for dd-trace-java builds. |
| 3 | + * |
| 4 | + * Logs the JDK used by each scheduled task to diagnose unexpected Java versions. |
| 5 | + * |
| 6 | + * Usage: |
| 7 | + * ./gradlew <task> -PddGradleDebug e.g. ./gradlew assemble -PddGradleDebug |
| 8 | + * |
| 9 | + * Only tasks in the execution graph of the requested command are reported, so run it |
| 10 | + * against a real task (e.g. `build`, `:module:test`); `help` reports almost nothing. |
| 11 | + * |
| 12 | + * Output: build/datadog.gradle-debug.log (one JSON object per task), e.g. |
| 13 | + * {"task":":dd-trace-api:compileJava", "jdk":"8"} |
| 14 | + * {"task":":dd-trace-api:test", "jdk":"11"} |
| 15 | + * |
| 16 | + * "jdk":"unknown" means the task type carries no JVM (e.g. lifecycle/aggregate tasks like |
| 17 | + * `classes` or `assemble`, copy/`Sync` tasks); only Java/Groovy/Scala compile, Test, JavaExec, |
| 18 | + * Javadoc and Exec tasks report a version. |
3 | 19 | */ |
4 | 20 |
|
| 21 | +import org.gradle.api.Action |
| 22 | +import org.gradle.api.Task |
| 23 | +import org.gradle.api.execution.TaskExecutionGraph |
| 24 | + |
5 | 25 | val ddGradleDebugEnabled = project.hasProperty("ddGradleDebug") |
6 | 26 | val logPath = rootProject.layout.buildDirectory.file("datadog.gradle-debug.log") |
7 | 27 |
|
@@ -38,8 +58,8 @@ fun getJdkFromCompilerOptions(co: CompileOptions): String? { |
38 | 58 | return null |
39 | 59 | } |
40 | 60 |
|
41 | | -fun printJdkForProjectTasks(project: Project, logFile: File) { |
42 | | - project.tasks.forEach { task -> |
| 61 | +fun printJdkForTasks(tasks: Iterable<Task>, logFile: File) { |
| 62 | + tasks.forEach { task -> |
43 | 63 | val data = mutableMapOf<String, String>() |
44 | 64 | data["task"] = task.path |
45 | 65 | if (task is JavaExec) { |
@@ -83,23 +103,12 @@ fun printJdkForProjectTasks(project: Project, logFile: File) { |
83 | 103 | } |
84 | 104 | } |
85 | 105 |
|
86 | | -class DebugBuildListener : org.gradle.BuildListener { |
87 | | - override fun settingsEvaluated(settings: Settings) = Unit |
88 | | - |
89 | | - override fun projectsLoaded(gradle: Gradle) = Unit |
90 | | - |
91 | | - override fun buildFinished(result: BuildResult) = Unit |
92 | | - |
93 | | - override fun projectsEvaluated(gradle: Gradle) { |
94 | | - val logFile = logPath.get().asFile |
95 | | - logFile.writeText("") |
96 | | - gradle.rootProject.allprojects.forEach { project -> |
97 | | - printJdkForProjectTasks(project, logFile) |
98 | | - } |
99 | | - } |
100 | | -} |
101 | | - |
102 | 106 | if (ddGradleDebugEnabled) { |
103 | 107 | logger.lifecycle("datadog.gradle-debug plugin is enabled") |
104 | | - gradle.addListener(DebugBuildListener()) |
| 108 | + // Inspect tasks once the execution graph is ready, when scheduled tasks are fully configured. |
| 109 | + gradle.taskGraph.whenReady(Action<TaskExecutionGraph> { |
| 110 | + val logFile = logPath.get().asFile |
| 111 | + logFile.writeText("") |
| 112 | + printJdkForTasks(allTasks, logFile) |
| 113 | + }) |
105 | 114 | } |
0 commit comments