Instrument Gradle Launcher to avoid overwriting org.gradle.jvmargs property (#8001)

Author: nikita-tkachenko-datadog

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ProcessHierarchy.java

@@ -50,13 +50,21 @@ public boolean isChild() {
    * not one of the supported build system processes.
    */
   public boolean isHeadless() {
-    return !isChild() && !isParent();
+    return !isChild() && !isParent() && !isWrapper();
   }
 
   private boolean isParent() {
     return isMavenParent() || isGradleDaemon();
   }
 
+  /**
+   * Determines if current process is a wrapper that starts the build system. In other words a
+   * process that is not a build system, and not a JVM that runs tests.
+   */
+  private boolean isWrapper() {
+    return isGradleLauncher();
+  }
+
   private boolean isMavenParent() {
     return System.getProperty("maven.home") != null
         && System.getProperty("classworlds.conf") != null;
@@ -70,6 +78,12 @@ private boolean isGradleDaemon() {
         && System.getProperties().getProperty("org.gradle.internal.worker.tmpdir") == null;
   }
 
+  private boolean isGradleLauncher() {
+    ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
+    return contextClassLoader.getResource("org/gradle/launcher/Main.class") != null
+        || contextClassLoader.getResource("org/gradle/launcher/GradleMain.class") != null;
+  }
+
   @Nullable
   public InetSocketAddress getSignalServerAddress() {
     // System.getProperty is used rather than Config,

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/test/ExecutionStrategy.java

@@ -99,8 +99,11 @@ public TestRetryPolicy retryPolicy(TestIdentifier test) {
   public boolean isEarlyFlakeDetectionLimitReached() {
     int detectionsUsed = earlyFlakeDetectionsUsed.get();
     Collection<TestIdentifier> knownTests = executionSettings.getKnownTests();
-    int totalTests = knownTests.size() + detectionsUsed;
+    if (knownTests == null) {
+      return false;
+    }
 
+    int totalTests = knownTests.size() + detectionsUsed;
     EarlyFlakeDetectionSettings earlyFlakeDetectionSettings =
         executionSettings.getEarlyFlakeDetectionSettings();
     int threshold =

dd-java-agent/instrumentation/gradle-8.3/src/main/groovy/datadog/trace/instrumentation/gradle/GradleDaemonInjectionUtils.java

@@ -0,0 +1,33 @@
+package datadog.trace.instrumentation.gradle;
+
+import datadog.trace.api.Config;
+import java.io.File;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+
+public class GradleDaemonInjectionUtils {
+
+  public static Map<String, String> addJavaagentToGradleDaemonProperties(
+      Map<String, String> jvmOptions) {
+    File agentJar = Config.get().getCiVisibilityAgentJarFile();
+    Path agentJarPath = agentJar.toPath();
+
+    StringBuilder agentArg = new StringBuilder("-javaagent:").append(agentJarPath).append('=');
+
+    Properties systemProperties = System.getProperties();
+    for (Map.Entry<Object, Object> e : systemProperties.entrySet()) {
+      String propertyName = (String) e.getKey();
+      Object propertyValue = e.getValue();
+      if (propertyName.startsWith(Config.PREFIX)) {
+        agentArg.append(propertyName).append('=').append(propertyValue).append(',');
+      }
+    }
+
+    // creating a new map in case jvmOptions is immutable
+    Map<String, String> updatedJvmOptions = new HashMap<>(jvmOptions);
+    updatedJvmOptions.merge("org.gradle.jvmargs", agentArg.toString(), (o, n) -> o + " " + n);
+    return updatedJvmOptions;
+  }
+}

dd-java-agent/instrumentation/gradle-8.3/src/main/groovy/datadog/trace/instrumentation/gradle/GradleLauncherInstrumentation.java

@@ -0,0 +1,63 @@
+package datadog.trace.instrumentation.gradle;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.implementsInterface;
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+
+import com.google.auto.service.AutoService;
+import datadog.trace.agent.tooling.Instrumenter;
+import datadog.trace.agent.tooling.InstrumenterModule;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.util.Map;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+/**
+ * This instrumentation targets Gradle Launcher, which is the process that is started with
+ * `gradle`/`gradlew` commands. The launcher starts Gradle Daemon (if not started yet), which is a
+ * long-lived process that actually runs builds. The instrumentation injects the tracer and its
+ * config properties into Gradle Daemon JVM settings when the daemon is started.
+ */
+@AutoService(InstrumenterModule.class)
+public class GradleLauncherInstrumentation extends InstrumenterModule.CiVisibility
+    implements Instrumenter.ForTypeHierarchy {
+
+  public GradleLauncherInstrumentation() {
+    super("gradle", "gradle-daemon-jvm-options");
+  }
+
+  @Override
+  public String hierarchyMarkerType() {
+    return "org.gradle.launcher.configuration.AllProperties";
+  }
+
+  @Override
+  public ElementMatcher<TypeDescription> hierarchyMatcher() {
+    return implementsInterface(named(hierarchyMarkerType()));
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        named("getProperties"),
+        GradleLauncherInstrumentation.class.getName() + "$PropertiesAugmentationAdvice");
+  }
+
+  @Override
+  public String[] helperClassNames() {
+    return new String[] {
+      packageName + ".GradleDaemonInjectionUtils",
+    };
+  }
+
+  @SuppressFBWarnings(
+      value = "UC_USELESS_OBJECT",
+      justification = "jvmOptions is the return value of the original method")
+  public static class PropertiesAugmentationAdvice {
+    @Advice.OnMethodExit(suppress = Throwable.class)
+    public static void addJavaagentToGradleDaemonProperties(
+        @Advice.Return(readOnly = false) Map<String, String> jvmOptions) {
+      jvmOptions = GradleDaemonInjectionUtils.addJavaagentToGradleDaemonProperties(jvmOptions);
+    }
+  }
+}