|
| 1 | +"""Tests for PropagatedAttributesSpanProcessor.""" |
| 2 | + |
| 3 | +import threading |
| 4 | +from unittest.mock import MagicMock |
| 5 | + |
| 6 | +import pytest |
| 7 | + |
| 8 | +from sap_cloud_sdk.core.telemetry.propagated_attributes_processor import ( |
| 9 | + PropagatedAttributesSpanProcessor, |
| 10 | +) |
| 11 | +from sap_cloud_sdk.core.telemetry.telemetry import _propagated_attrs_var |
| 12 | + |
| 13 | + |
| 14 | +@pytest.fixture(autouse=True) |
| 15 | +def reset_propagated_attrs(): |
| 16 | + """Ensure _propagated_attrs_var is empty before and after each test.""" |
| 17 | + token = _propagated_attrs_var.set({}) |
| 18 | + yield |
| 19 | + _propagated_attrs_var.reset(token) |
| 20 | + |
| 21 | + |
| 22 | +def _make_recording_span(existing_attrs=None): |
| 23 | + span = MagicMock() |
| 24 | + span.is_recording.return_value = True |
| 25 | + span.attributes = existing_attrs or {} |
| 26 | + span.name = "test-span" |
| 27 | + return span |
| 28 | + |
| 29 | + |
| 30 | +class TestPropagatedAttributesSpanProcessor: |
| 31 | + def setup_method(self): |
| 32 | + self.processor = PropagatedAttributesSpanProcessor() |
| 33 | + |
| 34 | + def test_injects_propagated_attrs_into_span_with_no_existing_attrs(self): |
| 35 | + _propagated_attrs_var.set({"user.id": "u1", "session.id": "s1"}) |
| 36 | + span = _make_recording_span() |
| 37 | + |
| 38 | + self.processor.on_start(span, None) |
| 39 | + |
| 40 | + span.set_attribute.assert_any_call("user.id", "u1") |
| 41 | + span.set_attribute.assert_any_call("session.id", "s1") |
| 42 | + assert span.set_attribute.call_count == 2 |
| 43 | + |
| 44 | + def test_does_not_override_attrs_already_present_on_span(self): |
| 45 | + _propagated_attrs_var.set( |
| 46 | + {"gen_ai.request.model": "override", "custom.key": "val"} |
| 47 | + ) |
| 48 | + span = _make_recording_span(existing_attrs={"gen_ai.request.model": "gpt-4"}) |
| 49 | + |
| 50 | + self.processor.on_start(span, None) |
| 51 | + |
| 52 | + span.set_attribute.assert_called_once_with("custom.key", "val") |
| 53 | + |
| 54 | + def test_does_nothing_when_no_propagated_attrs(self): |
| 55 | + # _propagated_attrs_var is {} by default (from autouse fixture) |
| 56 | + span = _make_recording_span() |
| 57 | + |
| 58 | + self.processor.on_start(span, None) |
| 59 | + |
| 60 | + span.set_attribute.assert_not_called() |
| 61 | + |
| 62 | + def test_does_nothing_for_non_recording_span(self): |
| 63 | + _propagated_attrs_var.set({"key": "val"}) |
| 64 | + span = MagicMock() |
| 65 | + span.is_recording.return_value = False |
| 66 | + |
| 67 | + self.processor.on_start(span, None) |
| 68 | + |
| 69 | + span.set_attribute.assert_not_called() |
| 70 | + |
| 71 | + def test_swallows_exception_from_set_attribute(self): |
| 72 | + _propagated_attrs_var.set({"key": "val"}) |
| 73 | + span = _make_recording_span() |
| 74 | + span.set_attribute.side_effect = RuntimeError("boom") |
| 75 | + |
| 76 | + # Must not raise |
| 77 | + self.processor.on_start(span, None) |
| 78 | + |
| 79 | + def test_injects_all_attrs_when_all_absent(self): |
| 80 | + _propagated_attrs_var.set({"a": 1, "b": 2, "c": 3}) |
| 81 | + span = _make_recording_span() |
| 82 | + |
| 83 | + self.processor.on_start(span, None) |
| 84 | + |
| 85 | + assert span.set_attribute.call_count == 3 |
| 86 | + span.set_attribute.assert_any_call("a", 1) |
| 87 | + span.set_attribute.assert_any_call("b", 2) |
| 88 | + span.set_attribute.assert_any_call("c", 3) |
| 89 | + |
| 90 | + def test_partial_override_only_missing_keys_added(self): |
| 91 | + _propagated_attrs_var.set({"existing": "old", "new_key": "new_val"}) |
| 92 | + span = _make_recording_span(existing_attrs={"existing": "current"}) |
| 93 | + |
| 94 | + self.processor.on_start(span, None) |
| 95 | + |
| 96 | + span.set_attribute.assert_called_once_with("new_key", "new_val") |
| 97 | + |
| 98 | + def test_on_end_is_noop(self): |
| 99 | + readable_span = MagicMock() |
| 100 | + # Must not raise and must not interact with span |
| 101 | + self.processor.on_end(readable_span) |
| 102 | + readable_span.assert_not_called() |
| 103 | + |
| 104 | + def test_context_var_isolation_across_contexts(self): |
| 105 | + """Propagated attrs in one context don't bleed into a separate context.""" |
| 106 | + _propagated_attrs_var.set({"main": "yes"}) |
| 107 | + |
| 108 | + results = [] |
| 109 | + |
| 110 | + def run_in_fresh_context(): |
| 111 | + # This thread starts with a copy of the parent context, |
| 112 | + # but we reset the ContextVar to empty to simulate isolation. |
| 113 | + token = _propagated_attrs_var.set({}) |
| 114 | + try: |
| 115 | + span = _make_recording_span() |
| 116 | + self.processor.on_start(span, None) |
| 117 | + results.append(span.set_attribute.call_count) |
| 118 | + finally: |
| 119 | + _propagated_attrs_var.reset(token) |
| 120 | + |
| 121 | + t = threading.Thread(target=run_in_fresh_context) |
| 122 | + t.start() |
| 123 | + t.join() |
| 124 | + |
| 125 | + assert results == [0], ( |
| 126 | + "No attrs should be injected in the isolated thread context" |
| 127 | + ) |
0 commit comments