Implement backend config setting and killswitch for impacted tests detection

Author: nikita-tkachenko-datadog

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

@@ -8,13 +8,14 @@ public class CiVisibilitySettings {
 
   public static final CiVisibilitySettings DEFAULT =
       new CiVisibilitySettings(
-          false, false, false, false, false, EarlyFlakeDetectionSettings.DEFAULT);
+          false, false, false, false, false, false, EarlyFlakeDetectionSettings.DEFAULT);
 
   private final boolean itrEnabled;
   private final boolean codeCoverage;
   private final boolean testsSkipping;
   private final boolean requireGit;
   private final boolean flakyTestRetriesEnabled;
+  private final boolean impactedTestsDetectionEnabled;
   private final EarlyFlakeDetectionSettings earlyFlakeDetectionSettings;
 
   private CiVisibilitySettings(
@@ -23,12 +24,14 @@ private CiVisibilitySettings(
       boolean testsSkipping,
       boolean requireGit,
       boolean flakyTestRetriesEnabled,
+      boolean impactedTestsDetectionEnabled,
       EarlyFlakeDetectionSettings earlyFlakeDetectionSettings) {
     this.itrEnabled = itrEnabled;
     this.codeCoverage = codeCoverage;
     this.testsSkipping = testsSkipping;
     this.requireGit = requireGit;
     this.flakyTestRetriesEnabled = flakyTestRetriesEnabled;
+    this.impactedTestsDetectionEnabled = impactedTestsDetectionEnabled;
     this.earlyFlakeDetectionSettings = earlyFlakeDetectionSettings;
   }
 
@@ -52,6 +55,10 @@ public boolean isFlakyTestRetriesEnabled() {
     return flakyTestRetriesEnabled;
   }
 
+  public boolean isImpactedTestsDetectionEnabled() {
+    return impactedTestsDetectionEnabled;
+  }
+
   public EarlyFlakeDetectionSettings getEarlyFlakeDetectionSettings() {
     return earlyFlakeDetectionSettings;
   }
@@ -76,6 +83,7 @@ public CiVisibilitySettings fromJson(Map<String, Object> json) {
           getBoolean(json, "tests_skipping", false),
           getBoolean(json, "require_git", false),
           getBoolean(json, "flaky_test_retries_enabled", false),
+          getBoolean(json, "impacted_tests_enabled", false),
           EarlyFlakeDetectionSettingsJsonAdapter.INSTANCE.fromJson(
               (Map<String, Object>) json.get("early_flake_detection")));
     }

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

@@ -22,6 +22,7 @@ public class ExecutionSettings {
           false,
           false,
           false,
+          false,
           EarlyFlakeDetectionSettings.DEFAULT,
           null,
           Collections.emptyMap(),
@@ -34,6 +35,7 @@ public class ExecutionSettings {
   private final boolean codeCoverageEnabled;
   private final boolean testSkippingEnabled;
   private final boolean flakyTestRetriesEnabled;
+  private final boolean impactedTestsDetectionEnabled;
   @Nonnull private final EarlyFlakeDetectionSettings earlyFlakeDetectionSettings;
   @Nullable private final String itrCorrelationId;
   @Nonnull private final Map<TestIdentifier, TestMetadata> skippableTests;
@@ -47,6 +49,7 @@ public ExecutionSettings(
       boolean codeCoverageEnabled,
       boolean testSkippingEnabled,
       boolean flakyTestRetriesEnabled,
+      boolean impactedTestsDetectionEnabled,
       @Nonnull EarlyFlakeDetectionSettings earlyFlakeDetectionSettings,
       @Nullable String itrCorrelationId,
       @Nonnull Map<TestIdentifier, TestMetadata> skippableTests,
@@ -58,6 +61,7 @@ public ExecutionSettings(
     this.codeCoverageEnabled = codeCoverageEnabled;
     this.testSkippingEnabled = testSkippingEnabled;
     this.flakyTestRetriesEnabled = flakyTestRetriesEnabled;
+    this.impactedTestsDetectionEnabled = impactedTestsDetectionEnabled;
     this.earlyFlakeDetectionSettings = earlyFlakeDetectionSettings;
     this.itrCorrelationId = itrCorrelationId;
     this.skippableTests = skippableTests;
@@ -87,6 +91,10 @@ public boolean isFlakyTestRetriesEnabled() {
     return flakyTestRetriesEnabled;
   }
 
+  public boolean isImpactedTestsDetectionEnabled() {
+    return impactedTestsDetectionEnabled;
+  }
+
   @Nonnull
   public EarlyFlakeDetectionSettings getEarlyFlakeDetectionSettings() {
     return earlyFlakeDetectionSettings;
@@ -169,6 +177,7 @@ public static class ExecutionSettingsSerializer {
     private static final int CODE_COVERAGE_ENABLED_FLAG = 2;
     private static final int TEST_SKIPPING_ENABLED_FLAG = 4;
     private static final int FLAKY_TEST_RETRIES_ENABLED_FLAG = 8;
+    private static final int IMPACTED_TESTS_DETECTION_ENABLED_FLAG = 16;
 
     public static ByteBuffer serialize(ExecutionSettings settings) {
       Serializer s = new Serializer();
@@ -178,7 +187,10 @@ public static ByteBuffer serialize(ExecutionSettings settings) {
               ((settings.itrEnabled ? ITR_ENABLED_FLAG : 0)
                   | (settings.codeCoverageEnabled ? CODE_COVERAGE_ENABLED_FLAG : 0)
                   | (settings.testSkippingEnabled ? TEST_SKIPPING_ENABLED_FLAG : 0)
-                  | (settings.flakyTestRetriesEnabled ? FLAKY_TEST_RETRIES_ENABLED_FLAG : 0));
+                  | (settings.flakyTestRetriesEnabled ? FLAKY_TEST_RETRIES_ENABLED_FLAG : 0)
+                  | (settings.impactedTestsDetectionEnabled
+                      ? IMPACTED_TESTS_DETECTION_ENABLED_FLAG
+                      : 0));
       s.write(flags);
 
       EarlyFlakeDetectionSettingsSerializer.serialize(s, settings.earlyFlakeDetectionSettings);
@@ -204,6 +216,7 @@ public static ExecutionSettings deserialize(ByteBuffer buffer) {
       boolean codeCoverageEnabled = (flags & CODE_COVERAGE_ENABLED_FLAG) != 0;
       boolean testSkippingEnabled = (flags & TEST_SKIPPING_ENABLED_FLAG) != 0;
       boolean flakyTestRetriesEnabled = (flags & FLAKY_TEST_RETRIES_ENABLED_FLAG) != 0;
+      boolean impactedTestsDetectionEnabled = (flags & IMPACTED_TESTS_DETECTION_ENABLED_FLAG) != 0;
 
       EarlyFlakeDetectionSettings earlyFlakeDetectionSettings =
           EarlyFlakeDetectionSettingsSerializer.deserialize(buffer);
@@ -228,6 +241,7 @@ public static ExecutionSettings deserialize(ByteBuffer buffer) {
           codeCoverageEnabled,
           testSkippingEnabled,
           flakyTestRetriesEnabled,
+          impactedTestsDetectionEnabled,
           earlyFlakeDetectionSettings,
           itrCorrelationId,
           skippableTests,

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

@@ -114,6 +114,7 @@ private TracerEnvironment buildTracerEnvironment(
     boolean codeCoverageEnabled = isCodeCoverageEnabled(ciVisibilitySettings);
     boolean testSkippingEnabled = isTestSkippingEnabled(ciVisibilitySettings);
     boolean flakyTestRetriesEnabled = isFlakyTestRetriesEnabled(ciVisibilitySettings);
+    boolean impactedTestsDetectionEnabled = isImpactedTestsDetectionEnabled(ciVisibilitySettings);
     boolean earlyFlakeDetectionEnabled = isEarlyFlakeDetectionEnabled(ciVisibilitySettings);
 
     LOGGER.info(
@@ -122,6 +123,7 @@ private TracerEnvironment buildTracerEnvironment(
             + "Per-test code coverage - {},\n"
             + "Tests skipping - {},\n"
             + "Early flakiness detection - {},\n"
+            + "Impacted tests detection - {},\n"
             + "Auto test retries - {}",
         repositoryRoot,
         tracerEnvironment.getConfigurations().getRuntimeName(),
@@ -131,6 +133,7 @@ private TracerEnvironment buildTracerEnvironment(
         codeCoverageEnabled,
         testSkippingEnabled,
         earlyFlakeDetectionEnabled,
+        impactedTestsDetectionEnabled,
         flakyTestRetriesEnabled);
 
     String itrCorrelationId = null;
@@ -170,7 +173,7 @@ private TracerEnvironment buildTracerEnvironment(
       moduleNames.addAll(knownTestsByModule.keySet());
     }
 
-    Diff pullRequestDiff = getPullRequestDiff();
+    Diff pullRequestDiff = getPullRequestDiff(impactedTestsDetectionEnabled);
 
     Map<String, ExecutionSettings> settingsByModule = new HashMap<>();
     for (String moduleName : moduleNames) {
@@ -181,6 +184,7 @@ private TracerEnvironment buildTracerEnvironment(
               codeCoverageEnabled,
               testSkippingEnabled,
               flakyTestRetriesEnabled,
+              impactedTestsDetectionEnabled,
               earlyFlakeDetectionEnabled
                   ? ciVisibilitySettings.getEarlyFlakeDetectionSettings()
                   : EarlyFlakeDetectionSettings.DEFAULT,
@@ -235,6 +239,11 @@ private boolean isFlakyTestRetriesEnabled(CiVisibilitySettings ciVisibilitySetti
         && config.isCiVisibilityFlakyRetryEnabled();
   }
 
+  private boolean isImpactedTestsDetectionEnabled(CiVisibilitySettings ciVisibilitySettings) {
+    return ciVisibilitySettings.isImpactedTestsDetectionEnabled()
+        && config.isCiVisibilityImpactedTestsDetectionEnabled();
+  }
+
   private boolean isEarlyFlakeDetectionEnabled(CiVisibilitySettings ciVisibilitySettings) {
     return ciVisibilitySettings.getEarlyFlakeDetectionSettings().isEnabled()
         && config.isCiVisibilityEarlyFlakeDetectionEnabled();
@@ -291,13 +300,13 @@ private Map<String, Collection<TestIdentifier>> getKnownTestsByModule(
   }
 
   @NotNull
-  private Diff getPullRequestDiff() {
-    if (repositoryRoot == null) {
+  private Diff getPullRequestDiff(boolean impactedTestsDetectionEnabled) {
+    if (repositoryRoot == null || !impactedTestsDetectionEnabled) {
       return Diff.EMPTY;
     }
-    // FIXME nikita: return empty diff if impacted tests detection is disabled (killswitch)
     // FIXME nikita: add telemetry
     // FIXME nikita: add file-based granularity fallback if Git executable is not available?
+    // FIXME nikita: add integration/smoke tests
     try {
       GitClient gitClient = gitClientFactory.create(repositoryRoot);
       return gitClient.getGitDiff(

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

@@ -158,6 +158,11 @@ private Map<String, String> getPropertiesPropagatedToChildProcess(
             CiVisibilityConfig.CIVISIBILITY_FLAKY_RETRY_ENABLED),
         Boolean.toString(executionSettings.isFlakyTestRetriesEnabled()));
 
+    propagatedSystemProperties.put(
+        Strings.propertyNameToSystemPropertyName(
+            CiVisibilityConfig.CIVISIBILITY_IMPACTED_TESTS_DETECTION_ENABLED),
+        Boolean.toString(executionSettings.isImpactedTestsDetectionEnabled()));
+
     propagatedSystemProperties.put(
         Strings.propertyNameToSystemPropertyName(
             CiVisibilityConfig.CIVISIBILITY_EARLY_FLAKE_DETECTION_ENABLED),

dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/config/ConfigurationApiImplTest.groovy

@@ -76,6 +76,7 @@ class ConfigurationApiImplTest extends Specification {
             '      "tests_skipping": true,' +
             '      "require_git": true,' +
             '      "flaky_test_retries_enabled": true,' +
+            '      "impacted_tests_enabled": true,' +
             '      "early_flake_detection": {' +
             '        "enabled": true,' +
             '        "slow_test_retries": {' +
@@ -419,6 +420,7 @@ class ConfigurationApiImplTest extends Specification {
     settings.testsSkippingEnabled
     settings.gitUploadRequired
     settings.flakyTestRetriesEnabled
+    settings.impactedTestsDetectionEnabled
     settings.earlyFlakeDetectionSettings.enabled
     settings.earlyFlakeDetectionSettings.faultySessionThreshold == 30
     settings.earlyFlakeDetectionSettings.getExecutions(TimeUnit.SECONDS.toMillis(3)) == 10

dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/config/ExecutionSettingsTest.groovy

@@ -26,6 +26,7 @@ class ExecutionSettingsTest extends Specification {
       false,
       false,
       false,
+      false,
       EarlyFlakeDetectionSettings.DEFAULT,
       null,
       [:],
@@ -39,6 +40,7 @@ class ExecutionSettingsTest extends Specification {
       true,
       false,
       true,
+      true,
       new EarlyFlakeDetectionSettings(true, [], 10),
       "",
       [new TestIdentifier("bc", "def", "g"): new TestMetadata(true), new TestIdentifier("de", "f", null): new TestMetadata(false)],
@@ -53,6 +55,7 @@ class ExecutionSettingsTest extends Specification {
       false,
       true,
       false,
+      true,
       new EarlyFlakeDetectionSettings(true, [new EarlyFlakeDetectionSettings.ExecutionsByDuration(10, 20)], 10),
       "itrCorrelationId",
       [:],
@@ -71,6 +74,7 @@ class ExecutionSettingsTest extends Specification {
       true,
       true,
       true,
+      true,
       new EarlyFlakeDetectionSettings(true, [new EarlyFlakeDetectionSettings.ExecutionsByDuration(10, 20), new EarlyFlakeDetectionSettings.ExecutionsByDuration(30, 40)], 10),
       "itrCorrelationId",
       [new TestIdentifier("bc", "def", null): new TestMetadata(true), new TestIdentifier("de", "f", null): new TestMetadata(true)],

dd-java-agent/agent-ci-visibility/src/testFixtures/groovy/datadog/trace/civisibility/CiVisibilityInstrumentationTest.groovy

@@ -121,6 +121,7 @@ abstract class CiVisibilityInstrumentationTest extends AgentTestRunner {
         false,
         itrEnabled,
         flakyRetryEnabled,
+        false, // FIXME nikita: add instrumentation tests for impacted tests detection
         earlyFlakinessDetectionSettings,
         itrEnabled ? "itrCorrelationId" : null,
         skippableTestsWithMetadata,

dd-trace-api/src/main/java/datadog/trace/api/config/CiVisibilityConfig.java

@@ -51,6 +51,8 @@ public final class CiVisibilityConfig {
   public static final String CIVISIBILITY_RESOURCE_FOLDER_NAMES =
       "civisibility.resource.folder.names";
   public static final String CIVISIBILITY_FLAKY_RETRY_ENABLED = "civisibility.flaky.retry.enabled";
+  public static final String CIVISIBILITY_IMPACTED_TESTS_DETECTION_ENABLED =
+      "civisibility.impacted.tests.detection.enabled";
   public static final String CIVISIBILITY_FLAKY_RETRY_ONLY_KNOWN_FLAKES =
       "civisibility.flaky.retry.only.known.flakes";
   public static final String CIVISIBILITY_EARLY_FLAKE_DETECTION_ENABLED =

internal-api/src/main/java/datadog/trace/api/Config.java

@@ -356,6 +356,7 @@ public static String getHostName() {
   private final String ciVisibilityInjectedTracerVersion;
   private final List<String> ciVisibilityResourceFolderNames;
   private final boolean ciVisibilityFlakyRetryEnabled;
+  private final boolean ciVisibilityImpactedTestsDetectionEnabled;
   private final boolean ciVisibilityFlakyRetryOnlyKnownFlakes;
   private final int ciVisibilityFlakyRetryCount;
   private final int ciVisibilityTotalFlakyRetryCount;
@@ -1487,6 +1488,8 @@ PROFILING_DATADOG_PROFILER_ENABLED, isDatadogProfilerSafeInCurrentEnvironment())
             CIVISIBILITY_RESOURCE_FOLDER_NAMES, DEFAULT_CIVISIBILITY_RESOURCE_FOLDER_NAMES);
     ciVisibilityFlakyRetryEnabled =
         configProvider.getBoolean(CIVISIBILITY_FLAKY_RETRY_ENABLED, true);
+    ciVisibilityImpactedTestsDetectionEnabled =
+        configProvider.getBoolean(CIVISIBILITY_IMPACTED_TESTS_DETECTION_ENABLED, true);
     ciVisibilityFlakyRetryOnlyKnownFlakes =
         configProvider.getBoolean(CIVISIBILITY_FLAKY_RETRY_ONLY_KNOWN_FLAKES, false);
     ciVisibilityEarlyFlakeDetectionEnabled =
@@ -2894,6 +2897,10 @@ public boolean isCiVisibilityFlakyRetryEnabled() {
     return ciVisibilityFlakyRetryEnabled;
   }
 
+  public boolean isCiVisibilityImpactedTestsDetectionEnabled() {
+    return ciVisibilityImpactedTestsDetectionEnabled;
+  }
+
   public boolean isCiVisibilityFlakyRetryOnlyKnownFlakes() {
     return ciVisibilityFlakyRetryOnlyKnownFlakes;
   }