add: tests for probe budgets

tests/debugger/probes/probe_snapshot_log_line_budgets.json

@@ -0,0 +1,20 @@
+[
+    {
+        "language": "",
+        "type": "",
+        "id": "log170aa-acda-4453-9111-1478a697line",
+        "version": 0,
+        "where": {
+            "typeName": null,
+            "sourceFile": "ACTUAL_SOURCE_FILE",
+            "lines": [
+                "141"
+            ]
+        },
+        "captureSnapshot": true,
+        "capture": {
+            "maxFieldCount": 200
+        },
+        "tags": []
+    }
+]

tests/debugger/probes/probe_snapshot_log_line_trigger_budgets.json

@@ -0,0 +1,22 @@
+[
+    {
+        "language": "",
+        "type": "",
+        "id": "log170aa-acda-4453-9111-1478a697line",
+        "version": 0,
+        "where": {
+            "typeName": null,
+            "sourceFile": "ACTUAL_SOURCE_FILE",
+            "lines": [
+                "141"
+            ]
+        },
+        "captureSnapshot": true,
+        "capture": {
+            "maxFieldCount": 200
+        },
+        "tags": [
+            "session_id: r3z0v"
+        ]
+    }
+]

tests/debugger/test_debugger_expression_language.py

@@ -92,7 +92,7 @@ def setup_expression_language_access_variables(self):
                     Dsl("index", [Dsl("getmember", [Dsl("ref", "testStruct"), "Dictionary"]), "two"]),
                 ],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -124,7 +124,7 @@ def setup_expression_language_access_exception(self):
         message_map, probes = self._create_expression_probes(
             methodName=method,
             expressions=[["Accessing exception", ".*Hello from exception", Dsl("ref", "@exception")]],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -187,7 +187,7 @@ def setup_expression_language_comparison_operators(self):
                 ["strValue le a", False, Dsl("le", [Dsl("ref", "strValue"), "a"])],
                 ["strValue ge z", False, Dsl("ge", [Dsl("ref", "strValue"), "z"])],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -240,7 +240,7 @@ def setup_expression_language_instance_of(self):
                 ],
                 ["pii instanceof string", False, Dsl("instanceof", [Dsl("ref", "pii"), self._get_type("string")])],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -279,7 +279,7 @@ def setup_expression_language_logical_operators(self):
                 ],
                 ["not intValue eq 10", False, Dsl("not", Dsl("eq", [Dsl("ref", "intValue"), 5]))],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -327,7 +327,7 @@ def setup_expression_language_string_operations(self):
                 ["emptyString matches empty", True, Dsl("matches", [Dsl("ref", "emptyString"), ""])],
                 ["emptyString matches some", False, Dsl("matches", [Dsl("ref", "emptyString"), "foo"])],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -403,7 +403,7 @@ def setup_expression_language_collection_operations(self):
                     Dsl("len", Dsl("filter", [Dsl("ref", "l5"), Dsl("lt", [Dsl("ref", "@it"), 2])])),
                 ],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -548,7 +548,7 @@ def setup_expression_language_hash_operations(self):
                     ),
                 ],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -569,7 +569,7 @@ def setup_expression_language_nulls_true(self):
                 ["strValue eq null", True, Dsl("eq", [Dsl("ref", "strValue"), None])],
                 ["pii eq null", True, Dsl("eq", [Dsl("ref", "pii"), None])],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -588,7 +588,7 @@ def setup_expression_language_nulls_false(self):
                 ["strValue eq null", False, Dsl("eq", [Dsl("ref", "strValue"), None])],
                 ["pii eq null", False, Dsl("eq", [Dsl("ref", "pii"), None])],
             ],
-            lines=self._method_and_language_to_line_number(method, language),
+            lines=self.method_and_language_to_line_number(method, language),
         )
 
         self.message_map = message_map
@@ -650,18 +650,6 @@ def _get_hash_value_property_name(self):
         else:
             return "value"
 
-    def _method_and_language_to_line_number(self, method, language):
-        """_method_and_language_to_line_number returns the respective line number given the method and language"""
-        return {
-            "Expression": {"java": [71], "dotnet": [74], "python": [72]},
-            # The `@exception` variable is not available in the context of line probes.
-            "ExpressionException": {},
-            "ExpressionOperators": {"java": [82], "dotnet": [90], "python": [87]},
-            "StringOperations": {"java": [87], "dotnet": [97], "python": [96]},
-            "CollectionOperations": {"java": [114], "dotnet": [114], "python": [123]},
-            "Nulls": {"java": [130], "dotnet": [127], "python": [136]},
-        }.get(method, {}).get(language, [])
-
     def _create_expression_probes(self, methodName, expressions, lines=[]):
         probes = []
         expected_message_map = {}

tests/debugger/test_debugger_probe_snapshot.py

@@ -11,11 +11,19 @@
 @scenarios.debugger_probes_snapshot
 class Test_Debugger_Probe_Snaphots(debugger._Base_Debugger_Test):
     ############ setup ############
-    def _setup(self, probes_name: str, request_path: str):
+    def _setup(self, probes_name: str, request_path: str, lines=None):
         self.initialize_weblog_remote_config()
 
         ### prepare probes
         probes = debugger.read_probes(probes_name)
+        if lines is not None:
+            for probe in probes:
+                if "methodName" in probe["where"]:
+                    del probe["where"]["methodName"]
+                probe["where"]["lines"] = lines
+                probe["where"]["sourceFile"] = "ACTUAL_SOURCE_FILE"
+                probe["where"]["typeName"] = None
+
         self.set_probes(probes)
 
         ### send requests
@@ -132,3 +140,60 @@ def test_code_origin_entry_present(self):
                 code_origins_entry_found = code_origin_type == "entry"
 
         assert code_origins_entry_found
+
+    def setup_log_line_probe_snaphots_budgets(self):
+        self._setup(
+            "probe_snapshot_log_line_budgets",
+            "/debugger/budgets/20",
+            lines=self.method_and_language_to_line_number("Budgets", self.get_tracer()["language"]),
+        )
+
+    @missing_feature(
+        context.library == "java" and context.weblog_variant != "spring-boot", reason="Budget endpoint not implemented"
+    )
+    @missing_feature(context.library == "dotnet", reason="Probe snapshot budgets are not yet implemented")
+    @missing_feature(context.library == "nodejs", reason="Probe snapshot budgets are not yet implemented")
+    @missing_feature(context.library == "ruby", reason="Probe snapshot budgets are not yet implemented")
+    def test_log_line_probe_snaphots_budgets(self):
+        self._assert()
+        self._validate_snapshots()
+
+        snapshots = 0
+        for _id in self.probe_ids:
+            for span in self.probe_snapshots[_id]:
+                snapshot = span.get("debugger", {}).get("snapshot", None)
+                if snapshot is None:
+                    continue
+
+                snapshots += 1
+
+            assert snapshots == 1, f"Expected 1 snapshots, got {snapshots}"
+
+    def setup_log_line_trigger_probe_snaphots_budgets(self):
+        self._setup(
+            "probe_snapshot_log_line_trigger_budgets",
+            "/debugger/budgets/20",
+            lines=self.method_and_language_to_line_number("Budgets", self.get_tracer()["language"]),
+        )
+
+    @missing_feature(
+        context.library == "java" and context.weblog_variant != "spring-boot", reason="Budget endpoint not implemented"
+    )
+    @missing_feature(context.library == "python", reason="Trigger probe snapshot waiting for next release")
+    @missing_feature(context.library == "dotnet", reason="Trigger probe snapshot budgets are not yet implemented")
+    @missing_feature(context.library == "nodejs", reason="Trigger probe snapshot budgets are not yet implemented")
+    @missing_feature(context.library == "ruby", reason="Trigger probe snapshot budgets are not yet implemented")
+    def test_log_line_trigger_probe_snaphots_budgets(self):
+        self._assert()
+        self._validate_snapshots()
+
+        snapshots = 0
+        for _id in self.probe_ids:
+            for span in self.probe_snapshots[_id]:
+                snapshot = span.get("debugger", {}).get("snapshot", None)
+                if snapshot is None:
+                    continue
+
+                snapshots += 1
+
+            assert snapshots == 10, f"Expected 10 snapshots, got {snapshots}"

tests/debugger/utils.py

@@ -89,6 +89,19 @@ def initialize_weblog_remote_config(self):
                     % (response.status_code)
                 )
 
+    def method_and_language_to_line_number(self, method, language):
+        """method_and_language_to_line_number returns the respective line number given the method and language"""
+        return {
+            "Budgets": {"python": [142], "java": [138]},
+            "Expression": {"java": [71], "dotnet": [74], "python": [72]},
+            # The `@exception` variable is not available in the context of line probes.
+            "ExpressionException": {},
+            "ExpressionOperators": {"java": [82], "dotnet": [90], "python": [87]},
+            "StringOperations": {"java": [87], "dotnet": [97], "python": [96]},
+            "CollectionOperations": {"java": [114], "dotnet": [114], "python": [123]},
+            "Nulls": {"java": [130], "dotnet": [127], "python": [136]},
+        }.get(method, {}).get(language, [])
+
     ###### set #####
     def set_probes(self, probes):
         def _enrich_probes(probes):

utils/build/docker/java/spring-boot/src/main/java/com/datadoghq/system_tests/springboot/debugger/DebuggerController.java

@@ -131,4 +131,12 @@ public String nulls(
             ". intValue is null: " + (intValue == null) +
             ". strValue is null: " + (strValue == null) + ".";
     }
+
+    @GetMapping("/budgets/{loops}")
+    public String budgets(@PathVariable int loops) {
+        for (int i = 0; i < loops; i++) {
+            int noOp = 0; // Line probe is instrumented here.
+        }
+        return "Budgets";
+    }
 }

utils/build/docker/python/flask/debugger_controller.py

@@ -134,3 +134,10 @@ def nulls():
         pii = Pii()
 
     return f"Pii is null {pii is None}. intValue is null {intValue is None}. strValue is null {strValue is None}."
+
+
+@debugger_blueprint.route("/budgets/<int:loops>", methods=["GET"])
+def budgets(loops):
+    for _ in range(loops):
+        pass
+    return "Budgets", 200