Added test to check that we do not generate spans for initial telemetry forwarder sub-process any more.

Author: AlexeyKuznetsov-DD

dd-java-agent/src/test/groovy/datadog/trace/agent/InitializationTelemetryTest.groovy

@@ -1,11 +1,11 @@
 package datadog.trace.agent
 
-import spock.lang.Specification
-import spock.lang.Timeout
-import spock.lang.IgnoreIf
+import datadog.test.SimpleAgentMock
 import datadog.trace.api.Platform
-
 import jvmbootstraptest.InitializationTelemetryCheck
+import spock.lang.IgnoreIf
+import spock.lang.Specification
+import spock.lang.Timeout
 
 @Timeout(30)
 @IgnoreIf(reason = "SecurityManager is permanently disabled as of JDK 24", value = {
@@ -26,19 +26,39 @@ class InitializationTelemetryTest extends Specification {
 
   def "normal start-up"() {
     when:
-    def result = InitializationTelemetryCheck.runTestJvm(null, false, "sleep")
+    def result = InitializationTelemetryCheck.runTestJvm(null)
+
+    then:
+    result.exitCode == 0
+    result.telemetryJson.contains('library_entrypoint.complete')
+  }
+
+  def "test initial telemetry forwarder trace muted"() {
+    when:
+    def agent = new SimpleAgentMock().start()
+    def result = InitializationTelemetryCheck.runTestJvm(null, agent.port)
 
     then:
     result.exitCode == 0
     result.telemetryJson.contains('library_entrypoint.complete')
+
+    // Check that we have only one span related to sub-process execution,
+    // and it is not initial telemetry forwarder.
+    agent.spans.size() == 1
+    def span = agent.spans.get(0)
+    span.name == 'command_execution'
+    span.resource == 'echo'
+
+    cleanup:
+    agent.close()
   }
 
   def "incomplete agent start-up"() {
     // In this case, the SecurityManager blocks a custom permission that is checked by bytebuddy causing
     // agent initialization to fail.  However, we should catch the exception allowing the application
     // to run normally.
     when:
-    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockByteBuddy, false, "sleep")
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockByteBuddy)
 
     then:
     result.exitCode == 0
@@ -50,7 +70,7 @@ class InitializationTelemetryTest extends Specification {
     // In this case, the SecurityManager blocks access to the forwarder environment variable,
     // so the tracer is unable to report initialization telemetry
     when:
-    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderEnvVar, true)
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderEnvVar)
 
     then:
     result.exitCode == 0
@@ -62,7 +82,7 @@ class InitializationTelemetryTest extends Specification {
     // In this case, the SecurityManager blocks access to process execution, so the tracer is
     // unable to invoke the forwarder executable
     when:
-    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderExecution, true)
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderExecution)
 
     then:
     result.exitCode == 0

dd-java-agent/src/test/java/datadog/test/SimpleAgentMock.java

@@ -0,0 +1,67 @@
+package datadog.test;
+
+import datadog.trace.test.agent.decoder.DecodedMessage;
+import datadog.trace.test.agent.decoder.DecodedSpan;
+import datadog.trace.test.agent.decoder.DecodedTrace;
+import datadog.trace.test.agent.decoder.Decoder;
+import java.io.Closeable;
+import java.io.IOException;
+import java.util.List;
+import java.util.concurrent.CopyOnWriteArrayList;
+import okhttp3.mockwebserver.Dispatcher;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+
+/**
+ * Simple web server to mock responses from agent and collect spans. We can not use `TestHttpServer`
+ * from `:dd-java-agent:testing` because it will bring unwanted dependencies into classpath and were
+ * are trying to make sure that we expose as little as possible into the bootstrap and system class
+ * loaders.
+ */
+public class SimpleAgentMock implements Closeable {
+  private static final MockResponse EMPTY_200_RESPONSE = new MockResponse().setResponseCode(200);
+
+  private final MockWebServer server;
+  private final List<DecodedSpan> spans = new CopyOnWriteArrayList<>();
+
+  public SimpleAgentMock() {
+    server = new MockWebServer();
+
+    server.setDispatcher(
+        new Dispatcher() {
+          @Override
+          public MockResponse dispatch(final RecordedRequest request) {
+            if ("/v0.4/traces".equals(request.getPath())) {
+              byte[] body = request.getBody().readByteArray();
+
+              DecodedMessage message = Decoder.decodeV04(body);
+              for (DecodedTrace trace : message.getTraces()) {
+                spans.addAll(trace.getSpans());
+              }
+            }
+
+            return EMPTY_200_RESPONSE;
+          }
+        });
+  }
+
+  public SimpleAgentMock start() throws IOException {
+    server.start();
+
+    return this;
+  }
+
+  public int getPort() {
+    return server.getPort();
+  }
+
+  public List<DecodedSpan> getSpans() {
+    return spans;
+  }
+
+  @Override
+  public void close() throws IOException {
+    server.shutdown();
+  }
+}

dd-java-agent/src/test/java/jvmbootstraptest/InitializationTelemetryCheck.java

@@ -1,5 +1,7 @@
 package jvmbootstraptest;
 
+import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_AGENT_PORT;
+
 import datadog.trace.agent.test.IntegrationTestUtils;
 import java.io.File;
 import java.io.FilePermission;
@@ -9,25 +11,34 @@
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFilePermission;
 import java.nio.file.attribute.PosixFilePermissions;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 /**
  * Basic sanity check that InitializationTelemetry is functioning
  *
  * <p>Checks edge cases where InitializationTelemetry is blocked by SecurityManagers
  */
 public class InitializationTelemetryCheck {
-  public static void main(String[] args) throws InterruptedException {
+  public static void main(String[] args) throws Exception {
     // Emulates the real application performing work in main().
-    // That should give enough time to send initial telemetry from daemon thread.
-    if (args.length > 0 && "sleep".equals(args[0])) {
-      Thread.sleep(5000);
+    // Start sub-process to generate one trace.
+    try {
+      ProcessBuilder builder = new ProcessBuilder("echo");
+      Process process = builder.start();
+      process.waitFor(5, TimeUnit.SECONDS);
+    } catch (SecurityException se) {
+      // Ignore security exceptions, as it can be part of strict security manager test.
     }
+
+    // That should give enough time to send initial telemetry and traces.
+    Thread.sleep(2000);
   }
 
   /** Blocks the loading of the agent bootstrap */
@@ -79,20 +90,11 @@ protected boolean checkFileExecutePermission(FilePermission perm, Object ctx, St
 
   public static final Result runTestJvm(Class<? extends TestSecurityManager> securityManagerClass)
       throws Exception {
-    return runTestJvm(securityManagerClass, false, null);
-  }
-
-  public static final Result runTestJvm(
-      Class<? extends TestSecurityManager> securityManagerClass, boolean printStreams)
-      throws Exception {
-    return runTestJvm(securityManagerClass, printStreams, null);
+    return runTestJvm(securityManagerClass, DEFAULT_TRACE_AGENT_PORT);
   }
 
   public static final Result runTestJvm(
-      Class<? extends TestSecurityManager> securityManagerClass,
-      boolean printStreams,
-      String mainArgs)
-      throws Exception {
+      Class<? extends TestSecurityManager> securityManagerClass, int port) throws Exception {
 
     File jarFile =
         IntegrationTestUtils.createJarFileWithClasses(requiredClasses(securityManagerClass));
@@ -101,6 +103,12 @@ public static final Result runTestJvm(
         createTempFile("forwarder", "sh", PosixFilePermissions.fromString("rwxr--r--"));
     File outputFile = new File(forwarderFile.getAbsoluteFile() + ".out");
 
+    List<String> jvmArgs = new ArrayList<>();
+    jvmArgs.add("-Ddd.trace.agent.port=" + port);
+    if (securityManagerClass != null) {
+      jvmArgs.add("-Djava.security.manager=" + securityManagerClass.getName());
+    }
+
     write(
         forwarderFile,
         "#!/usr/bin/env bash\n",
@@ -110,11 +118,11 @@ public static final Result runTestJvm(
       int exitCode =
           IntegrationTestUtils.runOnSeparateJvm(
               InitializationTelemetryCheck.class.getName(),
-              InitializationTelemetryCheck.jvmArgs(securityManagerClass),
-              InitializationTelemetryCheck.mainArgs(mainArgs),
+              jvmArgs,
+              Collections.emptyList(),
               InitializationTelemetryCheck.envVars(forwarderFile),
               jarFile,
-              printStreams);
+              true);
 
       return new Result(exitCode, read(outputFile));
     } finally {
@@ -170,23 +178,6 @@ public static final Class<?>[] requiredClasses(
     }
   }
 
-  public static final List<String> jvmArgs(
-      Class<? extends TestSecurityManager> securityManagerClass) {
-    if (securityManagerClass == null) {
-      return Collections.emptyList();
-    } else {
-      return Collections.singletonList("-Djava.security.manager=" + securityManagerClass.getName());
-    }
-  }
-
-  public static final List<String> mainArgs(String args) {
-    if (args == null) {
-      return Collections.emptyList();
-    } else {
-      return Arrays.asList(args.split(","));
-    }
-  }
-
   public static final Map<String, String> envVars(File forwarderFile) {
     Map<String, String> envVars = new HashMap<>();
     envVars.put("DD_TELEMETRY_FORWARDER_PATH", forwarderFile.getAbsolutePath());