ci: move DI exploration tests to GitLab

We extract the exploration tests from the rest of the framework tests
and move them to GitLab.

Author: P403n1x87

.gitlab-ci.yml

@@ -37,6 +37,7 @@ include:
   - local: ".gitlab/testrunner.yml"
   - local: ".gitlab/benchmarks/serverless.yml"
   - local: ".gitlab/native.yml"
+  - local: ".gitlab/debugging/exploration.yml"
 
 tests-gen:
   stage: tests

.gitlab/debugging/exploration.yml

@@ -0,0 +1,22 @@
+"debugging::exploration-testing::boto3":
+  stage: tests
+  extends: .testrunner
+  variables:
+    DD_DEBUGGER_EXPL_STATUS_MESSAGES: 1
+    DD_DEBUGGER_EXPL_INCLUDE: "boto3"
+  parallel:
+    matrix:
+      - PYTHON_VERSION: "3.8"
+        BOTO3_TAG: 1.37.38
+      - PYTHON_VERSION: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        BOTO3_TAG: 1.38.44
+  script: |
+    python${PYTHON_VERSION} -m pip install -e .
+    git clone --depth 1 --branch ${BOTO3_TAG} https://github.com/boto/boto3.git
+    cd boto3
+    python${PYTHON_VERSION} scripts/ci/install
+    PYTHONPATH=../tests/debugging/exploration/ python${PYTHON_VERSION} scripts/ci/run-tests
+  needs: []
+  artifacts:
+    paths:
+      - debugger-expl.txt

tests/debugging/exploration/_config.py

@@ -29,7 +29,7 @@ class ExplorationConfig(DDConfig):
     encode = DDConfig.v(
         bool,
         "dd.debugger.expl.encode",
-        default=True,
+        default=False,
         help="Whether to encode the snapshots",
     )
 
@@ -40,7 +40,7 @@ class ExplorationConfig(DDConfig):
         help="Whether to print exploration debugger status messages",
     )
 
-    include = DDConfig.v(
+    includes = DDConfig.v(
         list,
         "dd.debugger.expl.include",
         parser=lambda v: [path.split(".") for path in v.split(",")],
@@ -58,7 +58,7 @@ class ExplorationConfig(DDConfig):
     conservative = DDConfig.v(
         bool,
         "dd.debugger.expl.conservative",
-        default=False,
+        default=True,
         help="Use extremely low capture limits to reduce overhead",
     )
 

tests/debugging/exploration/_coverage.py

@@ -1,6 +1,5 @@
 from collections import defaultdict
 from pathlib import Path
-import sys
 from types import ModuleType
 import typing as t
 
@@ -22,27 +21,38 @@
 
 
 # Track all the covered modules and its lines. Indexed by module origin.
-_tracked_modules: t.Dict[str, t.Tuple[ModuleType, t.Set[int]]] = {}
+_tracked_modules: t.Dict[Path, t.Tuple[ModuleType, t.Set[int]]] = {}
 
 
 class LineCollector(ModuleCollector):
     def on_collect(self, discovery: FunctionDiscovery) -> None:
         o = origin(discovery._module)
+        if o is None:
+            status("[coverage] cannot collect lines from %s, no origin found" % discovery._module.__name__)
+            return
+
         status("[coverage] collecting lines from %s" % o)
         _tracked_modules[o] = (discovery._module, {_ for _ in discovery.keys()})
-        LineCoverage.add_probes(
-            [
-                create_snapshot_line_probe(
-                    probe_id="@".join([str(hash(f)), str(line)]),
-                    source_file=origin(sys.modules[f.__module__]),
-                    line=line,
-                    rate=0.0,
-                    limits=expl_config.limits,
+        probes = []
+        for line, fcps in discovery.items():
+            for fcp in fcps:
+                try:
+                    f = fcp.resolve()
+                except ValueError:
+                    # This function-code pair is not from a function, e.g. a
+                    # class.
+                    continue
+                probe_id = "@".join([str(hash(f)), str(line)])
+                probes.append(
+                    create_snapshot_line_probe(
+                        probe_id=probe_id,
+                        source_file=o,
+                        line=line,
+                        rate=0.0,
+                        limits=expl_config.limits,
+                    )
                 )
-                for line, functions in discovery.items()
-                for f in functions
-            ]
-        )
+        LineCoverage.add_probes(probes)
 
 
 class LineCoverage(ExplorationDebugger):
@@ -72,7 +82,7 @@ def report_coverage(cls) -> None:
             total_covered += len(seen_lines)
             log(
                 ("{:<%d} {:>5} {: 6.0f}%%" % w).format(
-                    str(o.relative_to(CWD)),
+                    str(o),
                     len(lines),
                     len(seen_lines) * 100.0 / len(lines) if lines else 0,
                 )

tests/debugging/exploration/_profiler.py

@@ -25,7 +25,12 @@ class FunctionCollector(ModuleCollector):
     def on_collect(self, discovery: FunctionDiscovery) -> None:
         module = discovery._module
         status("[profiler] Collecting functions from %s" % module.__name__)
-        for fname, f in discovery._fullname_index.items():
+        for fname, fcp in discovery._fullname_index.items():
+            try:
+                f = fcp.resolve()
+            except ValueError:
+                # This function-code pair is not from a function, e.g. a class.
+                continue
             if origin(module) != Path(f.__code__.co_filename).resolve():
                 # Do not wrap functions that do not belong to the module. We
                 # will have a chance to wrap them when we discover the module

tests/debugging/exploration/debugger.py

@@ -45,7 +45,7 @@ def on_collect(self, discovery: FunctionDiscovery) -> None:
     def _on_new_module(self, module):
         try:
             if not is_ddtrace(module):
-                if config.include:
+                if config.includes:
                     if not is_included(module, config):
                         return
                 elif not from_editable_install(module, config):
@@ -55,7 +55,7 @@ def _on_new_module(self, module):
                     return
 
                 try:
-                    return self.on_collect(FunctionDiscovery(module))
+                    return self.on_collect(FunctionDiscovery.from_module(module))
                 except Exception as e:
                     status("Error collecting functions from %s: %s" % (module.__name__, e))
                     raise e
@@ -203,6 +203,8 @@ def enable(cls) -> None:
         # not being managed by the product manager.
         atexit.register(cls.disable)
 
+        cls.__watchdog__.install()
+
     @classmethod
     def disable(cls, join: bool = True) -> None:
         registry = cls._instance._probe_registry
@@ -218,12 +220,7 @@ def disable(cls, join: bool = True) -> None:
 
         cls.on_disable()
 
-        snapshots = cls.get_snapshots()
-        if snapshots and snapshots[-1] is not None:
-            import json
-            from pprint import pprint
-
-            pprint(json.loads(snapshots[-1].decode()), stream=config.output_stream)
+        cls.__watchdog__.uninstall()
 
         super(ExplorationDebugger, cls).disable(join=join)
 

tests/debugging/exploration/utils.py

@@ -1,6 +1,8 @@
 import os
 from types import ModuleType
 
+from _config import ExplorationConfig
+
 from ddtrace.internal.compat import Path
 from ddtrace.internal.module import origin
 
@@ -33,9 +35,9 @@ def from_editable_install(module: ModuleType, config) -> bool:
     )
 
 
-def is_included(module: ModuleType, config) -> bool:
+def is_included(module: ModuleType, config: ExplorationConfig) -> bool:
     segments = module.__name__.split(".")
-    for i in config.include:
+    for i in config.includes:
         if i == segments[: len(i)]:
             return True
     return False