Completing the integration tests

InitializationTelemetryCheck now sets up a forwarder script that captures the output to a file

That output is then placed into the Result object in the new field telemetryJson

InitializationTelemetryTest has update to spot check the results of the Result.telemetryJson

Author: dougqh

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

@@ -10,34 +10,58 @@ class InitializationTelemetryTest extends Specification {
   def "block agent start-up"() {
     // In this case, the SecurityManager blocks loading of the Premain Class,
     // so the JVM is expected to terminate with an error
-    expect:
-    InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockAgentLoading).exitCode != 0
+    when:
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockAgentLoading)
+    
+    then:
+    result.exitCode != 0
+    // JVM fails before premain, so no telemetry output
+    result.telemetryJson == null
   }
 
   def "normal start-up"() {
-    expect:
-    InitializationTelemetryCheck.runTestJvm(null).exitCode == 0
+    when:
+    def result = InitializationTelemetryCheck.runTestJvm(null)
+    
+    then:
+    result.exitCode == 0
+    result.telemetryJson.contains('library_entrypoint.complete')
   }
 
   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.
-    expect:
-    InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockByteBuddy).exitCode == 0
+    when:
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockByteBuddy)
+    
+    then:
+    result.exitCode == 0
+    !result.telemetryJson.contains('library_entrypoint.complete')
+    result.telemetryJson.contains('error_type:java.lang.IllegalStateException')
   }
 
   def "block forwarder env var"() {
     // In this case, the SecurityManager blocks access to the forwarder environment variable,
     // so the tracer is unable to report initialization telemetry
-    expect:
-    InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderEnvVar, true).exitCode == 0
+    when:
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderEnvVar, true)
+    
+    then:
+    result.exitCode == 0
+    // forwarder env var unreadable, so no telemetry output
+    result.telemetryJson == null
   }
 
   def "block forwarder execution"() {
     // In this case, the SecurityManager blocks access to process execution, so the tracer is
     // unable to invoke the forwarder executable
-    expect:
-    InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderExecution, true).exitCode == 0
+    when:
+    def result = InitializationTelemetryCheck.runTestJvm(InitializationTelemetryCheck.BlockForwarderExecution, true)
+    
+    then:
+    result.exitCode == 0
+    // forwarder execution is blocked, so no telemetry output
+    result.telemetryJson == null
   }
 }

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

@@ -1,10 +1,19 @@
 package jvmbootstraptest;
 
-import datadog.trace.agent.test.IntegrationTestUtils;
 import java.io.File;
 import java.io.FilePermission;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.attribute.PosixFilePermission;
+import java.nio.file.attribute.PosixFilePermissions;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
+
+import datadog.trace.agent.test.IntegrationTestUtils;
 
 /**
  * Basic sanity check that InitializationTelemetry is functioning
@@ -69,22 +78,56 @@ public static final Result runTestJvm(Class<? extends TestSecurityManager> secur
   public static final Result runTestJvm(
       Class<? extends TestSecurityManager> securityManagerClass, boolean printStreams)
       throws Exception {
-    File jarFile =
+    
+	File jarFile =
         IntegrationTestUtils.createJarFileWithClasses(requiredClasses(securityManagerClass));
+    
+	File forwarderFile = createTempFile("forwarder", "sh", PosixFilePermissions.fromString("rwxr--r--"));
+	File outputFile = new File(forwarderFile.getAbsoluteFile() + ".out");
+	
+    write(forwarderFile,
+      "#!/usr/bin/env bash\n",
+      "echo \"$1	$(cat -)\" >> " + outputFile.getAbsolutePath() + "\n");
+    
     try {
       int exitCode = IntegrationTestUtils.runOnSeparateJvm(
           InitializationTelemetryCheck.class.getName(),
           InitializationTelemetryCheck.jvmArgs(securityManagerClass),
           InitializationTelemetryCheck.mainArgs(),
-          InitializationTelemetryCheck.envVars(),
+          InitializationTelemetryCheck.envVars(forwarderFile),
           jarFile,
           printStreams);
 
-      return new Result(exitCode);
+      return new Result(exitCode, read(outputFile));
     } finally {
-      jarFile.delete();
+      delete(jarFile, forwarderFile, outputFile);
     }
   }
+  
+  static final File createTempFile(String baseName, String extension, Set<PosixFilePermission> perms) throws IOException {
+    Path path = Files.createTempFile(baseName + "-integration-telemetry-check", "." + extension, PosixFilePermissions.asFileAttribute(perms));
+    File file = path.toFile();
+    file.deleteOnExit();
+    return file;
+  }
+  
+  static final void write(File file, String... lines) throws IOException {
+	Files.write(file.toPath(), Arrays.asList(lines));
+  }
+  
+  static final String read(File file) throws IOException {
+	try {
+	  return new String(Files.readAllBytes(file.toPath()), StandardCharsets.UTF_8);
+	} catch ( IOException e ) {
+	  return null;
+	}
+  }
+  
+  static final void delete(File... tempFiles) {
+	for ( File file: tempFiles ) {
+	  file.delete();
+	}
+  }
 
   public static final Class<?>[] requiredClasses(
       Class<? extends TestSecurityManager> securityManagerClass) {
@@ -116,17 +159,19 @@ public static final String[] mainArgs() {
     return new String[] {};
   }
 
-  public static final Map<String, String> envVars() {
+  public static final Map<String, String> envVars(File forwarderFile) {
     Map<String, String> envVars = new HashMap<>();
-    envVars.put("DD_TELEMETRY_FORWARDER_PATH", "/dummy/path");
+    envVars.put("DD_TELEMETRY_FORWARDER_PATH", forwarderFile.getAbsolutePath());
     return envVars;
   }
 
   public static final class Result {
 	public final int exitCode;
+	public final String telemetryJson;
 
-	public Result(int exitCode) {
+	public Result(int exitCode, String telemetryJson) {
 	  this.exitCode = exitCode;
+	  this.telemetryJson = telemetryJson;
 	}
   }
 }