Merge branch 'master' into INPLAT-614

Author: sydney-tung

.gitlab-ci.yml

@@ -41,9 +41,6 @@ variables:
     description: "Enable flaky tests"
     value: "false"
 
-default:
-  interruptible: true
-
 # trigger new commit cancel
 workflow:
   auto_cancel:
@@ -100,6 +97,7 @@ workflow:
 
 default:
   tags: [ "arch:amd64" ]
+  interruptible: true
 
 .set_datadog_api_keys: &set_datadog_api_keys
   - export DATADOG_API_KEY_PROD=$(aws ssm get-parameter --region us-east-1 --name ci.dd-trace-java.DATADOG_API_KEY_PROD --with-decryption --query "Parameter.Value" --out text)
@@ -521,7 +519,7 @@ muzzle-dep-report:
     CI_USE_TEST_AGENT: "true"
     CI_AGENT_HOST: local-agent
   services:
-    - name: ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.24.1
+    - name: ghcr.io/datadog/dd-apm-test-agent/ddapm-test-agent:v1.27.1
       alias: local-agent
       variables:
         LOG_LEVEL: "DEBUG"

.gitlab/check_test_agent_results.sh

@@ -7,6 +7,10 @@ SUMMARY_RESPONSE_CODE=$(echo "$SUMMARY_RESPONSE" | awk 'END {print $NF}')
 
 if [[ SUMMARY_RESPONSE_CODE -eq 200 ]]; then
   echo "APM Test Agent is running. (HTTP 200)"
+elif [[ -n "$CI_USE_TEST_AGENT" ]]; then
+  echo "APM Test Agent failed to start, had an error, or exited early."
+  cat summary_response.txt
+  exit 1
 else
   echo "APM Test Agent is not running and was not used for testing. No checks failed."
   exit 0

communication/src/main/java/datadog/communication/ddagent/ExternalAgentLauncher.java

@@ -5,8 +5,8 @@
 import static datadog.trace.util.ProcessSupervisor.Health.NEVER_CHECKED;
 import static datadog.trace.util.ProcessSupervisor.Health.READY_TO_START;
 
+import datadog.environment.OperatingSystem;
 import datadog.trace.api.Config;
-import datadog.trace.api.Platform;
 import datadog.trace.util.ProcessSupervisor;
 import java.io.Closeable;
 import java.io.File;
@@ -17,7 +17,7 @@ public class ExternalAgentLauncher implements Closeable {
   private static final Logger log = LoggerFactory.getLogger(ExternalAgentLauncher.class);
 
   private static final ProcessBuilder.Redirect DISCARD =
-      ProcessBuilder.Redirect.to(new File((Platform.isWindows() ? "NUL" : "/dev/null")));
+      ProcessBuilder.Redirect.to(new File((OperatingSystem.isWindows() ? "NUL" : "/dev/null")));
 
   private ProcessSupervisor traceProcessSupervisor;
   private ProcessSupervisor dogStatsDProcessSupervisor;

communication/src/main/java/datadog/communication/monitor/DDAgentStatsDConnection.java

@@ -8,8 +8,8 @@
 import com.timgroup.statsd.NoOpDirectStatsDClient;
 import com.timgroup.statsd.NonBlockingStatsDClientBuilder;
 import com.timgroup.statsd.StatsDClientErrorHandler;
+import datadog.environment.OperatingSystem;
 import datadog.trace.api.Config;
-import datadog.trace.api.Platform;
 import datadog.trace.relocate.api.IOLogger;
 import datadog.trace.util.AgentTaskScheduler;
 import datadog.trace.util.AgentThreadFactory;
@@ -136,7 +136,7 @@ private void doConnect() {
           if (bufferSize != null) {
             clientBuilder.socketBufferSize(bufferSize);
           }
-          int packetSize = Platform.isMac() ? 2048 : 8192;
+          int packetSize = OperatingSystem.isMacOs() ? 2048 : 8192;
           if (bufferSize != null && bufferSize < packetSize) {
             packetSize = bufferSize;
           }
@@ -185,7 +185,7 @@ private void discoverConnectionSettings() {
     }
 
     if (null == host) {
-      if (!Platform.isWindows() && new File(DEFAULT_DOGSTATSD_SOCKET_PATH).exists()) {
+      if (!OperatingSystem.isWindows() && new File(DEFAULT_DOGSTATSD_SOCKET_PATH).exists()) {
         log.info("Detected {}.  Using it to send StatsD data.", DEFAULT_DOGSTATSD_SOCKET_PATH);
         host = DEFAULT_DOGSTATSD_SOCKET_PATH;
         port = 0; // tells dogstatsd client to treat host as a socket path

components/environment/build.gradle.kts

@@ -0,0 +1,31 @@
+plugins {
+  `java-library`
+  id("com.gradleup.shadow")
+}
+
+apply(from = "$rootDir/gradle/java.gradle")
+
+/*
+ * Add an addition gradle configuration to be consumed by bootstrap only.
+ * "datadog.trace." prefix is required to be excluded from Jacoco instrumentation.
+ * See ConfigDefaults.DEFAULT_CIVISIBILITY_JACOCO_PLUGIN_EXCLUDES for more details.
+ */
+tasks.shadowJar {
+  relocate("datadog.environment", "datadog.trace.bootstrap.environment")
+}
+
+/*
+ * Configure test coverage.
+ */
+extra.set("minimumInstructionCoverage", 0.7)
+val excludedClassesCoverage by extra {
+  listOf(
+    "datadog.environment.JavaVirtualMachine", // depends on OS and JVM vendor
+    "datadog.environment.JavaVirtualMachine.JvmOptionsHolder", // depends on OS and JVM vendor
+    "datadog.environment.JvmOptions", // depends on OS and JVM vendor
+    "datadog.environment.OperatingSystem", // depends on OS
+  )
+}
+val excludedClassesBranchCoverage by extra {
+  listOf("datadog.environment.CommandLine") // tested using forked process
+}

components/environment/src/main/java/datadog/environment/CommandLine.java

@@ -0,0 +1,48 @@
+package datadog.environment;
+
+import static java.util.Collections.emptyList;
+
+import de.thetaphi.forbiddenapis.SuppressForbidden;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Fetches and captures the command line, both command and its arguments. It relies on a
+ * non-standard {@code sun.java.command} system property and was tested on:
+ *
+ * <ul>
+ *   <li>OracleJDK,
+ *   <li>OpenJDK,
+ *   <li>Temurin based JDK,
+ *   <li>IMB JDK,
+ *   <li>Azul Zulu,
+ *   <li>Amazon Coretto,
+ * </ul>
+ *
+ * This should be replaced by {@code ProcessHandle} and {@code ProcessHandle.Info} once Java 9+
+ * become available.
+ */
+class CommandLine {
+  private static final String SUN_JAVA_COMMAND_PROPERTY = "sun.java.command";
+  final List<String> fullCommand = findFullCommand();
+  final String name = getCommandName();
+  final List<String> arguments = getCommandArguments();
+
+  @SuppressForbidden // split on single-character uses fast path
+  private List<String> findFullCommand() {
+    String command = SystemProperties.getOrDefault(SUN_JAVA_COMMAND_PROPERTY, "").trim();
+    return command.isEmpty() ? emptyList() : Arrays.asList(command.split(" "));
+  }
+
+  private String getCommandName() {
+    return fullCommand.isEmpty() ? null : fullCommand.get(0);
+  }
+
+  private List<String> getCommandArguments() {
+    if (fullCommand.isEmpty()) {
+      return fullCommand;
+    } else {
+      return fullCommand.subList(1, fullCommand.size());
+    }
+  }
+}

components/environment/src/main/java/datadog/environment/EnvironmentVariables.java

@@ -0,0 +1,41 @@
+package datadog.environment;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/**
+ * Safely queries environment variables against security manager.
+ *
+ * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityManager.html">Security
+ *     Manager</a>
+ */
+public final class EnvironmentVariables {
+  private EnvironmentVariables() {}
+
+  /**
+   * Gets an environment variable value.
+   *
+   * @param name The environment variable name.
+   * @return The environment variable value, {@code null} if missing or can't be retrieved.
+   */
+  public static @Nullable String get(String name) {
+    return getOrDefault(name, null);
+  }
+
+  /**
+   * Gets an environment variable value, or default value if missing or can't be retrieved.
+   *
+   * @param name The environment variable name.
+   * @param defaultValue The default value to return if the environment variable is missing or can't
+   *     be retrieved.
+   * @return The environment variable value, {@code defaultValue} if missing or can't be retrieved.
+   */
+  public static String getOrDefault(@Nonnull String name, String defaultValue) {
+    try {
+      String value = System.getenv(name);
+      return value == null ? defaultValue : value;
+    } catch (SecurityException e) {
+      return defaultValue;
+    }
+  }
+}

components/environment/src/main/java/datadog/environment/JavaVersion.java

@@ -0,0 +1,107 @@
+package datadog.environment;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This class represents a Java version according the String Naming Convention.
+ *
+ * @see <a href="https://www.oracle.com/java/technologies/javase/versioning-naming.html">String
+ *     Naming Convention</a>
+ */
+final class JavaVersion {
+  final int major;
+  final int minor;
+  final int update;
+
+  JavaVersion(int major, int minor, int update) {
+    this.major = major;
+    this.minor = minor;
+    this.update = update;
+  }
+
+  static JavaVersion getRuntimeVersion() {
+    return parseJavaVersion(SystemProperties.getOrDefault("java.version", ""));
+  }
+
+  static JavaVersion parseJavaVersion(String javaVersion) {
+    // Remove pre-release part, usually -ea
+    final int indexOfDash = javaVersion.indexOf('-');
+    if (indexOfDash >= 0) {
+      javaVersion = javaVersion.substring(0, indexOfDash);
+    }
+
+    int major = 0;
+    int minor = 0;
+    int update = 0;
+
+    try {
+      List<Integer> nums = splitDigits(javaVersion);
+      major = nums.get(0);
+
+      // for java 1.6/1.7/1.8
+      if (major == 1) {
+        major = nums.get(1);
+        minor = nums.get(2);
+        update = nums.get(3);
+      } else {
+        minor = nums.get(1);
+        update = nums.get(2);
+      }
+    } catch (NumberFormatException | IndexOutOfBoundsException e) {
+      // unable to parse version string - do nothing
+    }
+    return new JavaVersion(major, minor, update);
+  }
+
+  /* The method splits java version string by digits. Delimiters are: dot, underscore and plus */
+  private static List<Integer> splitDigits(String str) {
+    List<Integer> results = new ArrayList<>();
+
+    int len = str.length();
+    int value = 0;
+    for (int i = 0; i < len; i++) {
+      char ch = str.charAt(i);
+      if (ch >= '0' && ch <= '9') {
+        value = value * 10 + (ch - '0');
+      } else if (ch == '.' || ch == '_' || ch == '+') {
+        results.add(value);
+        value = 0;
+      } else {
+        throw new NumberFormatException();
+      }
+    }
+    results.add(value);
+    return results;
+  }
+
+  public boolean is(int major) {
+    return this.major == major;
+  }
+
+  public boolean is(int major, int minor) {
+    return this.major == major && this.minor == minor;
+  }
+
+  public boolean is(int major, int minor, int update) {
+    return this.major == major && this.minor == minor && this.update == update;
+  }
+
+  public boolean isAtLeast(int major, int minor, int update) {
+    return isAtLeast(this.major, this.minor, this.update, major, minor, update);
+  }
+
+  public boolean isBetween(
+      int fromMajor, int fromMinor, int fromUpdate, int toMajor, int toMinor, int toUpdate) {
+    return isAtLeast(toMajor, toMinor, toUpdate, fromMajor, fromMinor, fromUpdate)
+        && isAtLeast(fromMajor, fromMinor, fromUpdate)
+        && !isAtLeast(toMajor, toMinor, toUpdate);
+  }
+
+  private static boolean isAtLeast(
+      int major, int minor, int update, int atLeastMajor, int atLeastMinor, int atLeastUpdate) {
+    return (major > atLeastMajor)
+        || (major == atLeastMajor && minor > atLeastMinor)
+        || (major == atLeastMajor && minor == atLeastMinor && update >= atLeastUpdate);
+  }
+}