feat(environment): Add new API to EnvironmentVariables and SystemProperties

Author: PerfectSlayer

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

@@ -1,5 +1,10 @@
 package datadog.environment;
 
+import static java.util.Collections.emptyMap;
+import static java.util.Collections.unmodifiableMap;
+
+import java.util.HashMap;
+import java.util.Map;
 import javax.annotation.Nullable;
 
 /**
@@ -42,4 +47,18 @@ public static String getOrDefault(String name, String defaultValue) {
       return defaultValue;
     }
   }
+
+  /**
+   * Gets all environment variables.
+   *
+   * @return All environment variables captured in an unmodifiable {@link Map}, or an empty {@link
+   *     Map} if they can't be retrieved.
+   */
+  public static Map<String, String> getAll() {
+    try {
+      return unmodifiableMap(new HashMap<>(System.getenv()));
+    } catch (SecurityException e) {
+      return emptyMap();
+    }
+  }
 }

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

@@ -1,5 +1,10 @@
 package datadog.environment;
 
+import static java.util.Collections.emptyMap;
+import static java.util.Collections.unmodifiableMap;
+
+import java.util.HashMap;
+import java.util.Map;
 import javax.annotation.Nullable;
 
 /**
@@ -42,6 +47,24 @@ public static String getOrDefault(String property, String defaultValue) {
     }
   }
 
+  /**
+   * Convert system properties to an unmodifiable {@link Map}.
+   *
+   * @return All system properties captured in an unmodifiable {@link Map}, or an empty {@link Map}
+   *     if they can't be retrieved.
+   */
+  public static Map<String, String> asStringMap() {
+    try {
+      Map<String, String> map = new HashMap<>();
+      for (String propertyName : System.getProperties().stringPropertyNames()) {
+        map.put(propertyName, System.getProperty(propertyName));
+      }
+      return unmodifiableMap(map);
+    } catch (SecurityException ignored) {
+      return emptyMap();
+    }
+  }
+
   /**
    * Sets a system property value.
    *

components/environment/src/test/java/datadog/environment/EnvironmentVariablesTest.java

@@ -2,9 +2,12 @@
 
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import java.util.Map;
 import org.junit.jupiter.api.Test;
 
 class EnvironmentVariablesTest {
@@ -36,4 +39,13 @@ void testGetOrDefault() {
     assertDoesNotThrow(() -> EnvironmentVariables.getOrDefault(MISSING_ENV_VAR, null));
     assertNull(EnvironmentVariables.getOrDefault(MISSING_ENV_VAR, null));
   }
+
+  @Test
+  void testGetAll() {
+    Map<String, String> all = EnvironmentVariables.getAll();
+    assertNotNull(all);
+    assertFalse(all.isEmpty());
+    // Unmodifiable collection
+    assertThrows(UnsupportedOperationException.class, all::clear);
+  }
 }

components/environment/src/test/java/datadog/environment/SystemPropertiesTest.java

@@ -3,6 +3,7 @@
 import static org.junit.jupiter.api.Assertions.*;
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
+import java.util.Map;
 import org.junit.jupiter.api.Test;
 
 class SystemPropertiesTest {
@@ -63,4 +64,15 @@ void testClear() {
     assertDoesNotThrow(() -> SystemProperties.clear(null));
     assertNull(SystemProperties.clear(null));
   }
+
+  @Test
+  void testAsStringMap() {
+    Map<String, String> stringMap = SystemProperties.asStringMap();
+    assertNotNull(stringMap);
+    assertFalse(stringMap.isEmpty());
+    // Unmodifiable collection
+    assertThrows(
+        UnsupportedOperationException.class,
+        () -> stringMap.put(MISSING_SYSTEM_PROPERTY, DEFAULT_VALUE));
+  }
 }

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

@@ -9,22 +9,22 @@
 import datadog.trace.bootstrap.instrumentation.api.AgentPropagation;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import java.net.InetSocketAddress;
-import java.util.Properties;
+import java.util.Map;
 import javax.annotation.Nullable;
 
 public class ProcessHierarchy {
 
   private static final class SystemPropertiesPropagationGetter
-      implements AgentPropagation.ContextVisitor<Properties> {
-    static final AgentPropagation.ContextVisitor<Properties> INSTANCE =
+      implements AgentPropagation.ContextVisitor<Map<String, String>> {
+    static final AgentPropagation.ContextVisitor<Map<String, String>> INSTANCE =
         new SystemPropertiesPropagationGetter();
 
     private SystemPropertiesPropagationGetter() {}
 
     @Override
-    public void forEachKey(Properties carrier, AgentPropagation.KeyClassifier classifier) {
-      for (String propertyName : carrier.stringPropertyNames()) {
-        if (!classifier.accept(propertyName, carrier.getProperty(propertyName))) {
+    public void forEachKey(Map<String, String> carrier, AgentPropagation.KeyClassifier classifier) {
+      for (Map.Entry<String, String> property : carrier.entrySet()) {
+        if (!classifier.accept(property.getKey(), property.getValue())) {
           return;
         }
       }
@@ -36,7 +36,7 @@ public void forEachKey(Properties carrier, AgentPropagation.KeyClassifier classi
   ProcessHierarchy() {
     parentProcessModuleContext =
         extractContextAndGetSpanContext(
-            System.getProperties(), SystemPropertiesPropagationGetter.INSTANCE);
+            SystemProperties.asStringMap(), SystemPropertiesPropagationGetter.INSTANCE);
   }
 
   /**

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

@@ -1,6 +1,6 @@
 package datadog.trace.civisibility.ci.env;
 
-import java.util.Collections;
+import datadog.environment.EnvironmentVariables;
 import java.util.Map;
 
 public class CiEnvironmentImpl implements CiEnvironment {
@@ -12,13 +12,7 @@ public CiEnvironmentImpl(Map<String, String> env) {
   }
 
   public static CiEnvironment local() {
-    Map<String, String> env;
-    try {
-      env = System.getenv();
-    } catch (SecurityException e) {
-      env = Collections.emptyMap();
-    }
-    return new CiEnvironmentImpl(env);
+    return new CiEnvironmentImpl(EnvironmentVariables.getAll());
   }
 
   @Override

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/domain/buildsystem/BuildSystemModuleImpl.java

@@ -4,6 +4,7 @@
 
 import datadog.communication.ddagent.TracerVersion;
 import datadog.context.propagation.CarrierSetter;
+import datadog.environment.SystemProperties;
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTags;
 import datadog.trace.api.civisibility.domain.BuildModuleLayout;
@@ -37,7 +38,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Properties;
 import java.util.concurrent.atomic.LongAdder;
 import java.util.function.Consumer;
 import javax.annotation.Nullable;
@@ -137,18 +137,14 @@ private Map<String, String> getPropertiesPropagatedToChildProcess(
       ExecutionSettings executionSettings,
       BuildSessionSettings sessionSettings) {
     Map<String, String> propagatedSystemProperties = new HashMap<>();
-    try {
-      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)
-                || propertyName.startsWith("datadog.slf4j.simpleLogger.defaultLogLevel"))
-            && propertyValue != null) {
-          propagatedSystemProperties.put(propertyName, propertyValue.toString());
-        }
+    for (Map.Entry<String, String> p : SystemProperties.asStringMap().entrySet()) {
+      String propertyName = p.getKey();
+      String propertyValue = p.getValue();
+      if ((propertyName.startsWith(Config.PREFIX)
+              || propertyName.startsWith("datadog.slf4j.simpleLogger.defaultLogLevel"))
+          && propertyValue != null) {
+        propagatedSystemProperties.put(propertyName, propertyValue);
       }
-    } catch (SecurityException ignored) {
     }
 
     propagatedSystemProperties.put(

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

@@ -9,7 +9,6 @@
 import java.nio.file.Path;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Properties;
 
 public class GradleDaemonInjectionUtils {
 
@@ -28,20 +27,16 @@ public static Map<String, String> addJavaagentToGradleDaemonProperties(
     Path agentJarPath = agentJar.toPath();
     StringBuilder agentArg = new StringBuilder("-javaagent:").append(agentJarPath).append('=');
 
-    try {
-      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(String.valueOf(propertyValue).replace("'", "'\\''"))
-              .append("',");
-        }
+    for (Map.Entry<String, String> p : SystemProperties.asStringMap().entrySet()) {
+      String propertyName = p.getKey();
+      String propertyValue = p.getValue();
+      if (propertyName.startsWith(Config.PREFIX)) {
+        agentArg
+            .append(propertyName)
+            .append("='")
+            .append(propertyValue.replace("'", "'\\''"))
+            .append("',");
       }
-    } catch (SecurityException ignored) {
     }
 
     // creating a new map in case jvmOptions is immutable