fix(ci-visibility): revert ITR to using DD_CIVISIBILITY_ITR_ENABLED env var [backport 1.18] (#6699)

Backport 9d651f0 from #6684 to 1.18.

Reverts the Intelligent Test Runner to use
`DD_CIVISIBILITY_ITR_ENABLED`. This makes it conform with tracers in
other languages that already use this environment variable.

Also in this PR (for some reason): a bunch of formatting checks.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

---------

Co-authored-by: Romain Komorn <[email protected]>
Co-authored-by: Romain Komorn <[email protected]>

Author: github-actions[bot]

ddtrace/internal/ci_visibility/recorder.py

@@ -92,7 +92,6 @@ class CIVisibility(Service):
     enabled = False
     _test_suites_to_skip = None  # type: Optional[List[str]]
     _tests_to_skip = defaultdict(list)  # type: DefaultDict[str, List[str]]
-    _itr_test_skipping_is_enabled = False
 
     def __init__(self, tracer=None, config=None, service=None):
         # type: (Optional[Tracer], Optional[IntegrationConfig], Optional[str]) -> None
@@ -137,15 +136,25 @@ def __init__(self, tracer=None, config=None, service=None):
             self._requests_mode = REQUESTS_MODE.AGENTLESS_EVENTS
         elif self._agent_evp_proxy_is_available():
             self._requests_mode = REQUESTS_MODE.EVP_PROXY_EVENTS
+
         self._code_coverage_enabled_by_api, self._test_skipping_enabled_by_api = self._check_enabled_features()
 
         self._collect_coverage_enabled = self._should_collect_coverage(self._code_coverage_enabled_by_api)
 
         self._configure_writer(coverage_enabled=self._collect_coverage_enabled)
-        self._git_client = None  # type: Optional[CIVisibilityGitClient]
-
-        self._configure_itr(self._api_key, self._app_key, self._requests_mode)
+        self._git_client = None
 
+        if ddconfig._ci_visibility_intelligent_testrunner_enabled:
+            if self._app_key is None:
+                log.warning("Environment variable DD_APP_KEY not set, so no git metadata will be uploaded.")
+            elif self._requests_mode == REQUESTS_MODE.TRACES:
+                log.warning("Cannot start git client if mode is not agentless or evp proxy")
+            else:
+                if not self._test_skipping_enabled_by_api:
+                    log.warning("Intelligent Test Runner test skipping disabled by API")
+                self._git_client = CIVisibilityGitClient(
+                    api_key=self._api_key or "", app_key=self._app_key, requests_mode=self._requests_mode
+                )
         try:
             from ddtrace.internal.codeowners import Codeowners
 
@@ -232,29 +241,6 @@ def _check_enabled_features(self):
         attributes = parsed["data"]["attributes"]
         return attributes["code_coverage"], attributes["tests_skipping"]
 
-    def _configure_itr(self, api_key, app_key, requests_mode):
-        # type: (Optional[str], Optional[str], REQUESTS_MODE) -> None
-        if not self._test_skipping_enabled_by_api:
-            log.debug("Test skipping is not enabled by API")
-            return
-        if not app_key:
-            log.debug("Test skipping disabled: required environment variable DD_APPLICATION_KEY is not set.")
-            return
-        if ddconfig._ci_visibility_intelligent_testrunner_disabled:
-            log.warning(
-                "Test skipping disabled: Intelligent Test Runner is enabled for this service, but "
-                "disabled by DD_CIVISIBILITY_ITR_DISABLED environment variable or tracer configuration."
-            )
-            return
-
-        if requests_mode == REQUESTS_MODE.TRACES:
-            log.warning("Test skipping disabled: cannot start git client if mode is not agentless or evp proxy.")
-            return
-
-        log.info("Datadog Intelligent Test Runner is enabled.")
-        self._itr_test_skipping_is_enabled = True
-        self._git_client = CIVisibilityGitClient(api_key=api_key or "", app_key=app_key, requests_mode=requests_mode)
-
     def _configure_writer(self, coverage_enabled=False, requests_mode=None):
         writer = None
         if requests_mode is None:
@@ -295,7 +281,7 @@ def _agent_evp_proxy_is_available(self):
     def test_skipping_enabled(cls):
         if not cls.enabled:
             return False
-        return cls._instance and cls._instance._itr_test_skipping_is_enabled
+        return cls._instance and cls._instance._test_skipping_enabled_by_api
 
     def _fetch_tests_to_skip(self, skipping_mode):
         # Make sure git uploading has finished

ddtrace/settings/config.py

@@ -329,8 +329,8 @@ def __init__(self):
 
         self._ci_visibility_agentless_enabled = asbool(os.getenv("DD_CIVISIBILITY_AGENTLESS_ENABLED", default=False))
         self._ci_visibility_agentless_url = os.getenv("DD_CIVISIBILITY_AGENTLESS_URL", default="")
-        self._ci_visibility_intelligent_testrunner_disabled = asbool(
-            os.getenv("DD_CIVISIBILITY_ITR_DISABLED", default=False)
+        self._ci_visibility_intelligent_testrunner_enabled = asbool(
+            os.getenv("DD_CIVISIBILITY_ITR_ENABLED", default=False)
         )
         self._otel_enabled = asbool(os.getenv("DD_TRACE_OTEL_ENABLED", False))
         if self._otel_enabled:

docs/configuration.rst

@@ -501,14 +501,14 @@ The following environment variables for the tracer are supported:
      version_added:
         v1.13.0:
 
-   DD_CIVISIBILITY_ITR_DISABLED:
+   DD_CIVISIBILITY_ITR_ENABLED:
      type: Boolean
      default: False
      description: |
-        Prevents the Intelligent Test Runner from skipping tests, and disables configuring the ``CIVisibility`` service
-        to generate and upload git packfiles in support of the Intelligent Test Runner.
+        Configures the ``CIVisibility`` service to generate and upload git packfiles in support
+        of the Datadog Intelligent Test Runner. This configuration has no effect if ``DD_CIVISIBILITY_AGENTLESS_ENABLED`` is false.
      version_added:
-        v1.18.0:
+        v1.13.0:
 
    DD_APPSEC_AUTOMATED_USER_EVENTS_TRACKING:
       type: String

releasenotes/notes/fix-itr-use-enabled-env-var-ef043a640843baff.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    CI Visibility: revert to using DD_CIVISIBILITY_ITR_ENABLED (instead of _DISABLED) to conform with other tracers.