Migrate Querying of Environment Variables to to ConfigHelper (#9620)

* Refactored EnvironmentVariables to be testable.

* adding supported-configurations.json file

* removing extra supported-configurations.json

* migrating config-utils tests and ConfigInversionMetric telemetry

* config inversion init

* migrating config-utils tests

* undo move of test files that rely on inject*config

* responding to PR comments

* updating class coverage exclude

* cleanup and code coverage

* init migration

* creating noop implementation of ConfigInversionMetricCollector

* adding Noop implementation to exclude code coverage

* adding to bootstrap classpath for testing

* bugfixes

* adding more configurations to supported-configurations and updating native test classes

* fix native build and update telemetry test with clear error message

* PR comments

* removing explicit dependency on environment component

* responding to PR comments

* updating native loading

* updating failing tests

* updating memory for native build

* adding documentation for failing tests

* increasing memory

* reverting gradle memory

* cleanup

---------

Co-authored-by: Alexey Kuznetsov <alexey.kuznetsov@datadoghq.com>

Author: 2 people

buildSrc/src/main/kotlin/datadog/gradle/plugin/config/ConfigInversionLinter.kt

@@ -97,9 +97,9 @@ private fun registerCheckEnvironmentVariablesUsage(project: Project) {
       val javaFiles = project.fileTree(project.projectDir) {
         include("**/src/main/java/**/*.java")
         exclude("**/build/**")
-        exclude("internal-api/src/main/java/datadog/trace/api/ConfigHelper.java")
+        exclude("utils/config-utils/src/main/java/datadog/trace/config/inversion/ConfigHelper.java")
         exclude("dd-java-agent/agent-bootstrap/**")
-        exclude("dd-java-agent/src/main/java/datadog/trace/bootstrap/BootstrapInitializationTelemetry.java")
+        exclude("dd-java-agent/src/main/java/datadog/trace/bootstrap/**")
       }
 
       val pattern = Regex("""EnvironmentVariables\.get\s*\(""")

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

@@ -3,6 +3,7 @@
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.unmodifiableMap;
 
+import de.thetaphi.forbiddenapis.SuppressForbidden;
 import java.util.HashMap;
 import java.util.Map;
 import javax.annotation.Nullable;
@@ -17,10 +18,15 @@ public final class EnvironmentVariables {
   private EnvironmentVariables() {}
 
   public static class EnvironmentVariablesProvider {
+
+    // Environment Component has SecurityException handling, so it is safe to call System.getenv
+    // here
+    @SuppressForbidden
     public String get(String name) {
       return System.getenv(name);
     }
 
+    @SuppressForbidden
     public Map<String, String> getAll() {
       return System.getenv();
     }

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/Constants.java

@@ -23,6 +23,7 @@ public final class Constants {
     "datadog.appsec.api",
     "datadog.trace.api",
     "datadog.trace.bootstrap",
+    "datadog.trace.config.inversion",
     "datadog.trace.context",
     "datadog.trace.instrumentation.api",
     "datadog.trace.logging",

dd-java-agent/agent-ci-visibility/civisibility-test-fixtures/src/main/groovy/datadog/trace/civisibility/CiVisibilitySmokeTest.groovy

@@ -83,7 +83,7 @@ abstract class CiVisibilitySmokeTest extends Specification {
   protected verifyEventsAndCoverages(String projectName, String toolchain, String toolchainVersion, List<Map<String, Object>> events, List<Map<String, Object>> coverages, List<String> additionalDynamicTags = []) {
     def additionalReplacements = ["content.meta.['test.toolchain']": "$toolchain:$toolchainVersion"]
 
-    if (System.getenv().get("GENERATE_TEST_FIXTURES") != null) {
+    if (System.getenv("GENERATE_TEST_FIXTURES") != null) {
       def baseTemplatesPath = CiVisibilitySmokeTest.classLoader.getResource(projectName).toURI().schemeSpecificPart.replace('build/resources/test', 'src/test/resources')
       CiVisibilityTestUtils.generateTemplates(baseTemplatesPath, events, coverages, additionalReplacements.keySet() + additionalDynamicTags, SMOKE_IGNORED_TAGS)
     } else {

dd-java-agent/agent-logging/src/main/java/datadog/trace/logging/ddlogger/DDLoggerFactory.java

@@ -1,8 +1,8 @@
 package datadog.trace.logging.ddlogger;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
 import datadog.trace.api.Platform;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.trace.logging.LogLevel;
 import datadog.trace.logging.LogLevelSwitcher;
 import datadog.trace.logging.LoggerHelper;
@@ -108,7 +108,7 @@ private static boolean isFlagEnabled(
     if ("false".equalsIgnoreCase(value)) {
       return false;
     }
-    value = EnvironmentVariables.get(envVar);
+    value = ConfigHelper.env(envVar);
     if ("true".equalsIgnoreCase(value)) {
       return true;
     }

dd-java-agent/instrumentation-testing/src/main/java/datadog/trace/agent/test/BootstrapClasspathSetupListener.java

@@ -70,6 +70,7 @@ public void launcherSessionOpened(LauncherSession session) {
     "datadog.appsec.api",
     "datadog.trace.api",
     "datadog.trace.bootstrap",
+    "datadog.trace.config.inversion",
     "datadog.trace.context",
     "datadog.trace.instrumentation.api",
     "datadog.trace.logging",

dd-java-agent/instrumentation/aws-java/aws-java-lambda-handler-1.2/src/main/java/datadog/trace/instrumentation/aws/v1/lambda/LambdaHandlerInstrumentation.java

@@ -16,14 +16,14 @@
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import com.google.auto.service.AutoService;
-import datadog.environment.EnvironmentVariables;
 import datadog.trace.agent.tooling.Instrumenter;
 import datadog.trace.agent.tooling.InstrumenterModule;
 import datadog.trace.bootstrap.CallDepthThreadLocalMap;
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
+import datadog.trace.config.inversion.ConfigHelper;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
@@ -61,7 +61,7 @@ public String[] helperClassNames() {
 
   @Override
   protected boolean defaultEnabled() {
-    return EnvironmentVariables.get(HANDLER_ENV_NAME) != null;
+    return ConfigHelper.env(HANDLER_ENV_NAME) != null;
   }
 
   @Override

dd-java-agent/instrumentation/graal/native-image/src/main/java/datadog/trace/instrumentation/graal/nativeimage/NativeImageGeneratorRunnerInstrumentation.java

@@ -102,8 +102,10 @@ public static void onEnter(@Advice.Argument(value = 0, readOnly = false) String[
               + "datadog.trace.api.ResolverCacheConfig$5:build_time,"
               + "datadog.trace.api.TracePropagationStyle:build_time,"
               + "datadog.trace.api.TracePropagationBehaviorExtract:build_time,"
-              + "datadog.trace.api.telemetry.OtelEnvMetricCollectorImpl:build_time,"
+              + "datadog.trace.api.telemetry.ConfigInversionMetricCollectorProvider:rerun,"
               + "datadog.trace.api.telemetry.ConfigInversionMetricCollectorImpl:build_time,"
+              + "datadog.trace.api.telemetry.ConfigInversionMetricCollectorImpl$ConfigInversionMetric:build_time,"
+              + "datadog.trace.api.telemetry.OtelEnvMetricCollectorImpl:build_time,"
               + "datadog.trace.api.profiling.ProfilingEnablement:build_time,"
               + "datadog.trace.bootstrap.config.provider.ConfigConverter:build_time,"
               + "datadog.trace.bootstrap.config.provider.ConfigConverter$ValueOfLookup:build_time,"
@@ -140,6 +142,9 @@ public static void onEnter(@Advice.Argument(value = 0, readOnly = false) String[
               + "datadog.trace.bootstrap.instrumentation.jfr.backpressure.BackpressureSampleEvent:build_time,"
               + "datadog.trace.bootstrap.instrumentation.jfr.directallocation.DirectAllocationTotalEvent:build_time,"
               + "datadog.trace.bootstrap.WeakMapContextStore:build_time,"
+              + "datadog.trace.config.inversion.ConfigHelper:rerun,"
+              + "datadog.trace.config.inversion.ConfigHelper$StrictnessPolicy:rerun,"
+              + "datadog.trace.config.inversion.GeneratedSupportedConfigurations:rerun,"
               + "datadog.trace.instrumentation.guava10.GuavaAsyncResultExtension:build_time,"
               + "datadog.trace.instrumentation.reactivestreams.ReactiveStreamsAsyncResultExtension:build_time,"
               + "datadog.trace.instrumentation.reactor.core.ReactorAsyncResultExtension:build_time,"

dd-java-agent/instrumentation/maven/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenUtils.java

@@ -1,7 +1,7 @@
 package datadog.trace.instrumentation.maven3;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.trace.api.civisibility.domain.JavaAgent;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.trace.util.MethodHandles;
 import datadog.trace.util.Strings;
 import de.thetaphi.forbiddenapis.SuppressForbidden;
@@ -66,7 +66,7 @@ public abstract class MavenUtils {
    * of the request object
    */
   public static String getCommandLine(MavenSession session) {
-    String mavenCmdLineArgsEnvVar = EnvironmentVariables.get(MAVEN_CMD_LINE_ARGS_ENVIRONMENT_VAR);
+    String mavenCmdLineArgsEnvVar = ConfigHelper.env(MAVEN_CMD_LINE_ARGS_ENVIRONMENT_VAR);
     if (mavenCmdLineArgsEnvVar != null) {
       return MVN_CMD_LINE_INVOCATION + mavenCmdLineArgsEnvVar;
     }

dd-java-agent/src/main/java6/datadog/trace/bootstrap/AgentPreCheck.java

@@ -90,6 +90,9 @@ private static boolean compatible() {
   }
 
   // Reachable for testing
+  // System.getenv usage is necessary since class is designed to be Java 6 compatible, while
+  // Environment component is for Java 8+
+  @SuppressForbidden
   static boolean compatible(String javaVersion, String javaHome, PrintStream output) {
     int majorJavaVersion = parseJavaMajorVersion(javaVersion);