fix: Makes the test agent report version 7.65.0 for client side stats

Author: bric3

tests/parametric/test_library_tracestats.py

@@ -22,7 +22,7 @@ def _human_stats(stats: V06StatsAggr) -> str:
     return str(filtered_copy)
 
 
-def enable_tracestats(sample_rate: float | None = None) -> pytest.MarkDecorator:
+def enable_tracestats(sample_rate: float | None = None) -> tuple[pytest.MarkDecorator, pytest.MarkDecorator]:
     env = {
         "DD_TRACE_STATS_COMPUTATION_ENABLED": "1",  # reference, dotnet, python, golang
         "DD_TRACE_TRACER_METRICS_ENABLED": "true",  # java
@@ -32,7 +32,11 @@ def enable_tracestats(sample_rate: float | None = None) -> pytest.MarkDecorator:
     if sample_rate is not None:
         assert 0 <= sample_rate <= 1.0
         env.update({"DD_TRACE_SAMPLE_RATE": str(sample_rate)})
-    return parametrize("library_env", [env])
+
+    # Java tracer requires agent version >= 7.65.0 for client-side stats
+    agent_env_config = {"TEST_AGENT_VERSION": "7.65.0"}
+
+    return (parametrize("library_env", [env]), parametrize("agent_env", [agent_env_config]))
 
 
 @scenarios.parametric
@@ -45,7 +49,7 @@ class Test_Library_Tracestats:
     @missing_feature(context.library == "ruby", reason="ruby has not implemented stats computation yet")
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
     def test_metrics_msgpack_serialization_TS001(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When spans are finished
         Each trace has stats metrics computed for it serialized properly in msgpack format with required fields
@@ -101,7 +105,7 @@ def test_metrics_msgpack_serialization_TS001(
     @missing_feature(context.library == "ruby", reason="ruby has not implemented stats computation yet")
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
     def test_distinct_aggregationkeys_TS003(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When spans are created with a unique set of dimensions
         Each span has stats computed for it and is in its own bucket
@@ -189,7 +193,7 @@ def test_distinct_aggregationkeys_TS003(
     @enable_tracestats()
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
     def test_measured_spans_TS004(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When spans are marked as measured
         Each has stats computed for it
@@ -233,7 +237,7 @@ def test_measured_spans_TS004(
     @missing_feature(context.library == "ruby", reason="ruby has not implemented stats computation yet")
     @enable_tracestats()
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
-    def test_top_level_TS005(self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary):
+    def test_top_level_TS005(self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary):
         """When top level (service entry) spans are created
         Each top level span has trace stats computed for it.
         """
@@ -286,7 +290,7 @@ def test_top_level_TS005(self, library_env: dict[str, str], test_agent: TestAgen
     @enable_tracestats()
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
     def test_successes_errors_recorded_separately_TS006(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When spans are marked as errors
         The errors count is incremented appropriately and the stats are aggregated into the ErrorSummary
@@ -343,7 +347,7 @@ def test_successes_errors_recorded_separately_TS006(
     @missing_feature(context.library == "ruby", reason="ruby has not implemented stats computation yet")
     @enable_tracestats(sample_rate=0.0)
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
-    def test_sample_rate_0_TS007(self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary):
+    def test_sample_rate_0_TS007(self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary):
         """When the sample rate is 0 and trace stats is enabled
         non-P0 traces should be dropped
         trace stats should be produced
@@ -366,7 +370,7 @@ def test_sample_rate_0_TS007(self, library_env: dict[str, str], test_agent: Test
     @missing_feature(reason="relative error test is broken")
     @enable_tracestats()
     def test_relative_error_TS008(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When trace stats are computed for traces
             The stats should be accurate to within 1% of the real values
@@ -417,7 +421,7 @@ def test_relative_error_TS008(
     @enable_tracestats()
     @bug(context.library >= "[email protected]", reason="APMSP-2074")
     def test_metrics_computed_after_span_finsh_TS009(
-        self, library_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """When trace stats are computed for traces
         Metrics must be computed after spans are finished, otherwise components of the aggregation key may change after

tests/parametric/test_span_sampling.py

@@ -695,8 +695,9 @@ def test_child_span_selected_by_sss015(self, test_agent: TestAgentAPI, test_libr
             }
         ],
     )
+    @pytest.mark.parametrize("agent_env", [{"TEST_AGENT_VERSION": "7.65.0"}])
     def test_root_span_selected_and_child_dropped_by_sss_when_dropping_policy_is_active016(
-        self, test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """Single spans selected by SSS must be kept and other spans expected to be dropped on the tracer side when
         dropping policy is active when tracer metrics enabled.
@@ -768,8 +769,9 @@ def test_root_span_selected_and_child_dropped_by_sss_when_dropping_policy_is_act
             }
         ],
     )
+    @pytest.mark.parametrize("agent_env", [{"TEST_AGENT_VERSION": "7.65.0"}])
     def test_child_span_selected_and_root_dropped_by_sss_when_dropping_policy_is_active017(
-        self, test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """Single spans selected by SSS must be kept and other spans expected to be dropped on the tracer side when
         dropping policy is active when tracer metrics enabled.
@@ -835,8 +837,9 @@ def test_child_span_selected_and_root_dropped_by_sss_when_dropping_policy_is_act
             }
         ],
     )
+    @pytest.mark.parametrize("agent_env", [{"TEST_AGENT_VERSION": "7.65.0"}])
     def test_entire_trace_dropped_when_dropping_policy_is_active018(
-        self, test_agent: TestAgentAPI, test_library: APMLibrary
+        self, library_env: dict[str, str], agent_env: dict[str, str], test_agent: TestAgentAPI, test_library: APMLibrary
     ):
         """The entire dropped span expected to be dropped on the tracer side when
         dropping policy is active, which is the case when tracer metrics enabled.

utils/_context/_scenarios/__init__.py

@@ -81,6 +81,9 @@ class _Scenarios:
             "DD_TRACE_FEATURES": "discovery",
             "DD_TRACE_TRACER_METRICS_ENABLED": "true",  # java
         },
+        agent_env={
+            "TEST_AGENT_VERSION": "7.65.0",  # Required for Java tracer >= 1.54.0 client-side stats
+        },
         doc=(
             "End to end testing with DD_TRACE_COMPUTE_STATS=1. This feature compute stats at tracer level, and"
             "may drop some of them"