chore(civis): move configurations to envier

.github/CODEOWNERS

@@ -169,3 +169,4 @@ tests/opentelemetry/                               @DataDog/apm-sdk-api-python
 tests/tracer/                                      @DataDog/apm-sdk-api-python
 # Override because order matters
 tests/tracer/test_ci.py                            @DataDog/ci-app-libraries
+ddtrace/settings/civis.py                          @DataDog/ci-app-libraries

ddtrace/internal/ci_visibility/recorder.py

@@ -78,6 +78,7 @@
 from ddtrace.internal.utils.formats import asbool
 from ddtrace.internal.utils.http import verify_url
 from ddtrace.internal.writer.writer import Response
+from ddtrace.settings import civis
 
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -217,7 +218,7 @@ def __init__(self, tracer=None, config=None, service=None):
 
         self._git_data: GitData = get_git_data_from_tags(self._tags)
 
-        if ddconfig._ci_visibility_agentless_enabled:
+        if civis.ci_config._agentless_enabled:
             if not self._api_key:
                 raise EnvironmentError(
                     "DD_CIVISIBILITY_AGENTLESS_ENABLED is set, but DD_API_KEY is not set, so ddtrace "
@@ -231,7 +232,7 @@ def __init__(self, tracer=None, config=None, service=None):
                 self._configurations,
                 self._api_key,
                 self._dd_site,
-                ddconfig._ci_visibility_agentless_url if ddconfig._ci_visibility_agentless_url else None,
+                civis.ci_config._agentless_url if civis.ci_config._agentless_url else None,
                 self._service,
                 ddconfig.env,
             )
@@ -304,7 +305,7 @@ def _check_enabled_features(self):
         # DEV: Remove this ``if`` once ITR is in GA
         _error_return_value = TestVisibilityAPISettings()
 
-        if not ddconfig._ci_visibility_intelligent_testrunner_enabled:
+        if not civis.ci_config._itr_enabled:
             return _error_return_value
 
         if not self._api_client:
@@ -402,10 +403,7 @@ def test_skipping_enabled(cls):
     def is_efd_enabled(cls):
         if cls._instance is None:
             return False
-        return (
-            cls._instance._api_settings.early_flake_detection.enabled
-            and ddconfig._test_visibility_early_flake_detection_enabled
-        )
+        return cls._instance._api_settings.early_flake_detection.enabled and civis.ci_config.early_flake_detection
 
     @classmethod
     def should_collect_coverage(cls):
@@ -476,7 +474,7 @@ def _should_skip_path(self, path, name, test_skipping_mode=None):
     def enable(cls, tracer=None, config=None, service=None):
         # type: (Optional[Tracer], Optional[Any], Optional[str]) -> None
         log.debug("Enabling %s", cls.__name__)
-        if ddconfig._ci_visibility_agentless_enabled:
+        if civis.ci_config._agentless_enabled:
             if not os.getenv("_CI_DD_API_KEY", os.getenv("DD_API_KEY")):
                 log.critical(
                     "%s disabled: environment variable DD_CIVISIBILITY_AGENTLESS_ENABLED is true but"
@@ -551,10 +549,7 @@ def _start_service(self):
                 self._unique_test_ids = unique_test_ids
                 log.info("Unique tests fetched for Early Flake Detection: %s", len(self._unique_test_ids))
         else:
-            if (
-                self._api_settings.early_flake_detection.enabled
-                and not ddconfig._test_visibility_early_flake_detection_enabled
-            ):
+            if self._api_settings.early_flake_detection.enabled and not civis.ci_config.early_flake_detection:
                 log.warning(
                     "Early Flake Detection is enabled by API but disabled by "
                     "DD_TEST_VISIBILITY_EARLY_FLAKE_DETECTION_ENABLED environment variable"
@@ -783,8 +778,8 @@ def set_test_session_name(cls, test_command: str) -> None:
             log.debug("Not setting test session name because no CIVisibilityEventClient is active")
             return
 
-        if ddconfig.test_session_name:
-            test_session_name = ddconfig.test_session_name
+        if civis.test_config.session_name:
+            test_session_name = civis.test_config.session_name
         else:
             job_name = instance._tags.get(ci.JOB_NAME)
             test_session_name = f"{job_name}-{test_command}" if job_name else test_command

ddtrace/internal/ci_visibility/utils.py

@@ -10,6 +10,7 @@
 from ddtrace.ext import test
 from ddtrace.internal.ci_visibility.constants import CIVISIBILITY_LOG_FILTER_RE
 from ddtrace.internal.logger import get_logger
+from ddtrace.settings import civis
 
 
 log = get_logger(__name__)
@@ -105,7 +106,7 @@ def take_over_logger_stream_handler(remove_ddtrace_stream_handlers=True):
         log.debug("CIVisibility not taking over ddtrace logger handler because debug mode is enabled")
         return
 
-    level = ddconfig.ci_visibility_log_level
+    level = civis.ci_config.log_level
 
     if level.upper() == "NONE":
         log.debug("CIVisibility not taking over ddtrace logger because level is set to: %s", level)

ddtrace/internal/ci_visibility/writer.py

@@ -12,6 +12,7 @@
 from ddtrace.internal.ci_visibility.constants import SESSION_TYPE
 from ddtrace.internal.ci_visibility.constants import SUITE_TYPE
 from ddtrace.internal.utils.time import StopWatch
+from ddtrace.settings import civis
 from ddtrace.vendor.dogstatsd import DogStatsd  # noqa:F401
 
 from .. import agent
@@ -119,8 +120,8 @@ def __init__(
         if use_evp:
             intake_url = intake_url if intake_url else agent.get_trace_url()
             intake_cov_url = intake_url
-        elif config._ci_visibility_agentless_url:
-            intake_url = intake_url if intake_url else config._ci_visibility_agentless_url
+        elif civis.ci_config._agentless_url:
+            intake_url = intake_url if intake_url else civis.ci_config._agentless_url
             intake_cov_url = intake_url
         if not intake_url:
             intake_url = "%s.%s" % (AGENTLESS_BASE_URL, os.getenv("DD_SITE", AGENTLESS_DEFAULT_SITE))

ddtrace/internal/telemetry/writer.py

@@ -12,6 +12,8 @@
 from typing import Tuple  # noqa:F401
 from typing import Union  # noqa:F401
 
+from ddtrace.settings import civis
+
 from ...internal import atexit
 from ...internal import forksafe
 from ...internal.compat import parse
@@ -243,7 +245,7 @@ def __init__(self, is_periodic=True, agentless=None):
         self._enabled = config._telemetry_enabled
 
         if agentless is None:
-            agentless = config._ci_visibility_agentless_enabled or config._dd_api_key is not None
+            agentless = civis.ci_config._agentless_enabled or config._dd_api_key is not None
 
         if agentless and not config._dd_api_key:
             log.debug("Disabling telemetry: no Datadog API key found in agentless mode")

ddtrace/settings/civis.py

@@ -0,0 +1,63 @@
+import typing as t
+
+from envier import En
+
+
+class CIVisConfig(En):
+    __prefix__ = "dd.civisibility"
+
+    _itr_enabled = En.v(
+        bool,
+        "itr.enabled",
+        default=False,
+        help_type="Boolean",
+        help="Enable ....",
+    )
+
+    _agentless_enabled = En.v(
+        bool,
+        "agentless.enabled",
+        default=False,
+        help_type="Boolean",
+        help="Enable ....",
+    )
+
+    _agentless_url = En.v(
+        str,
+        "agentless.url",
+        default="",
+        help_type="String",
+        help="Enable ....",
+    )
+
+    log_level = En.v(
+        str,
+        "log.level",
+        default="info",
+        help_type="String",
+        help="Enable ....",
+    )
+
+    early_flake_detection = En.v(
+        bool,
+        "early.flake.detection",
+        default=True,
+        help_type="Boolean",
+        help="Enable ....",
+    )
+
+
+class CITestConfig(En):
+    __prefix__ = "dd.test"
+
+    session_name = En.v(
+        t.Optional[str],
+        "session.name",
+        default=None,
+        help_type="String",
+        help="....",
+    )
+
+
+ci_config = CIVisConfig()
+test_config = CITestConfig()

ddtrace/settings/config.py

@@ -580,18 +580,6 @@ def __init__(self):
                 log.warning("Invalid obfuscation pattern, disabling query string tracing", exc_info=True)
                 self.http_tag_query_string = False  # Disable query string tagging if malformed obfuscation pattern
 
-        # Test Visibility config items
-        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_enabled = asbool(
-            os.getenv("DD_CIVISIBILITY_ITR_ENABLED", default=True)
-        )
-        self.ci_visibility_log_level = os.getenv("DD_CIVISIBILITY_LOG_LEVEL", default="info")
-        self.test_session_name = os.getenv("DD_TEST_SESSION_NAME")
-        self._test_visibility_early_flake_detection_enabled = asbool(
-            os.getenv("DD_CIVISIBILITY_EARLY_FLAKE_DETECTION_ENABLED", default=True)
-        )
-
         self._otel_enabled = asbool(os.getenv("DD_TRACE_OTEL_ENABLED", False))
         if self._otel_enabled:
             # Replaces the default otel api runtime context with DDRuntimeContext

tests/ci_visibility/api_client/test_ci_visibility_api_client.py

@@ -48,7 +48,7 @@ def _patch_env_for_testing():
         "ddtrace.internal.ci_visibility.recorder.CIVisibility._check_enabled_features",
         return_value=TestVisibilityAPISettings(),
     ), mock.patch(
-        "ddtrace.config._ci_visibility_agentless_enabled", True
+        "ddtrace.settings.civis.ci_config._agentless_enabled", True
     ):
         # Rebuild the config (yes, this is horrible)
         new_ddconfig = Config()

tests/ci_visibility/test_ci_visibility.py

@@ -41,7 +41,6 @@
 from tests.utils import DummyCIVisibilityWriter
 from tests.utils import DummyTracer
 from tests.utils import TracerTestCase
-from tests.utils import override_global_config
 
 
 TEST_SHA_1 = "b3672ea5cbc584124728c48a443825d2940e0ddd"
@@ -567,14 +566,11 @@ def tearDown(self):
 
     def test_civisibilitywriter_agentless_url(self):
         with _ci_override_env(dict(DD_API_KEY="foobar.baz")):
-            with override_global_config({"_ci_visibility_agentless_url": "https://foo.bar"}), mock.patch(
-                "ddtrace.internal.ci_visibility.writer.config._ci_visibility_agentless_url", "https://foo.bar"
-            ):
+            with mock.patch("ddtrace.settings.civis.ci_config._agentless_url", "https://foo.bar"):
                 dummy_writer = DummyCIVisibilityWriter()
                 assert dummy_writer.intake_url == "https://foo.bar"
 
     def test_civisibilitywriter_coverage_agentless_url(self):
-        ddtrace.internal.ci_visibility.writer.config._ci_visibility_agentless_url = ""
         with _ci_override_env(
             dict(
                 DD_API_KEY="foobar.baz",
@@ -593,7 +589,6 @@ def test_civisibilitywriter_coverage_agentless_url(self):
                 _get_connection.assert_called_once_with("https://citestcov-intake.datadoghq.com", 2.0)
 
     def test_civisibilitywriter_coverage_agentless_with_intake_url_param(self):
-        ddtrace.internal.ci_visibility.writer.config._ci_visibility_agentless_url = ""
         with _ci_override_env(
             dict(
                 DD_API_KEY="foobar.baz",

tests/ci_visibility/util.py

@@ -13,6 +13,8 @@
 from ddtrace.internal.ci_visibility.git_client import CIVisibilityGitClient
 from ddtrace.internal.ci_visibility.recorder import CIVisibility
 from ddtrace.internal.test_visibility._internal_item_ids import InternalTestId
+from ddtrace.settings.civis import CITestConfig
+from ddtrace.settings.civis import CIVisConfig
 from tests.utils import DummyCIVisibilityWriter
 from tests.utils import override_env
 
@@ -206,5 +208,10 @@ def _ci_override_env(
     new_vars: t.Optional[t.Dict[str, str]] = None, mock_ci_env=False, replace_os_env=True, full_clear=False
 ):
     env_vars = _get_default_ci_env_vars(new_vars, mock_ci_env, full_clear)
-    with override_env(env_vars, replace_os_env=replace_os_env), mock.patch("ddtrace.tracer", ddtrace.Tracer()):
-        yield
+    with override_env(env_vars, replace_os_env=replace_os_env):
+        ci_config = CIVisConfig()
+        test_config = CITestConfig()
+        with mock.patch("ddtrace.settings.civis.ci_config", ci_config), mock.patch(
+            "ddtrace.settings.civis.test_config", test_config
+        ), mock.patch("ddtrace.tracer", ddtrace.Tracer()):
+            yield

tests/telemetry/test_writer.py

@@ -604,8 +604,8 @@ def _get_request_body(payload, payload_type, seq_id=1):
 
 
 def test_telemetry_writer_agent_setup():
-    with override_global_config(
-        {"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey", "_ci_visibility_agentless_enabled": False}
+    with override_global_config({"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey"}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", False
     ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter(agentless=False)
         assert new_telemetry_writer._enabled
@@ -625,17 +625,17 @@ def test_telemetry_writer_agent_setup():
     ],
 )
 def test_telemetry_writer_agent_setup_agentless_arg_overrides_env(env_agentless, arg_agentless, expected_endpoint):
-    with override_global_config(
-        {"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey", "_ci_visibility_agentless_enabled": env_agentless}
+    with override_global_config({"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey"}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", env_agentless
     ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter(agentless=arg_agentless)
         # Note: other tests are checking whether values bet set properly, so we're only looking at agentlessness here
         assert new_telemetry_writer._client._endpoint == expected_endpoint
 
 
 def test_telemetry_writer_agentless_setup():
-    with override_global_config(
-        {"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey", "_ci_visibility_agentless_enabled": True}
+    with override_global_config({"_dd_site": "datad0g.com", "_dd_api_key": "foobarkey"}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", True
     ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter()
         assert new_telemetry_writer._enabled
@@ -645,8 +645,8 @@ def test_telemetry_writer_agentless_setup():
 
 
 def test_telemetry_writer_agentless_setup_eu():
-    with override_global_config(
-        {"_dd_site": "datadoghq.eu", "_dd_api_key": "foobarkey", "_ci_visibility_agentless_enabled": True}
+    with override_global_config({"_dd_site": "datadoghq.eu", "_dd_api_key": "foobarkey"}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", True
     ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter()
         assert new_telemetry_writer._enabled
@@ -656,8 +656,8 @@ def test_telemetry_writer_agentless_setup_eu():
 
 
 def test_telemetry_writer_agentless_disabled_without_api_key():
-    with override_global_config(
-        {"_dd_site": "datad0g.com", "_dd_api_key": None, "_ci_visibility_agentless_enabled": True}
+    with override_global_config({"_dd_site": "datad0g.com", "_dd_api_key": None}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", True
     ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter()
         assert not new_telemetry_writer._enabled
@@ -676,7 +676,9 @@ def test_telemetry_writer_is_using_agentless_by_default_if_api_key_is_available(
 
 
 def test_telemetry_writer_is_using_agent_by_default_if_api_key_is_not_available():
-    with override_global_config({"_dd_api_key": None, "_ci_visibility_agentless_enabled": False}):
+    with override_global_config({"_dd_api_key": None}), mock.patch(
+        "ddtrace.settings.civis.ci_config._agentless_enabled", False
+    ):
         new_telemetry_writer = ddtrace.internal.telemetry.TelemetryWriter()
         assert new_telemetry_writer._enabled
         assert new_telemetry_writer._client._endpoint == "telemetry/proxy/api/v2/apmtelemetry"

tests/utils.py

@@ -130,8 +130,6 @@ def override_global_config(values):
         "_trace_compute_stats",
         "_obfuscation_query_string_pattern",
         "global_query_string_obfuscation_disabled",
-        "_ci_visibility_agentless_url",
-        "_ci_visibility_agentless_enabled",
         "_subexec_sensitive_user_wildcards",
         "_remote_config_enabled",
         "_remote_config_poll_interval",