|
| 1 | +"""Unit tests for W3C trace context propagation in the hosted agent server.""" |
| 2 | + |
| 3 | +import pytest |
| 4 | +from opentelemetry import trace, context |
| 5 | +from opentelemetry.sdk.trace import TracerProvider |
| 6 | +from opentelemetry.sdk.trace.export import SimpleSpanProcessor, SpanExporter, SpanExportResult |
| 7 | +from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator |
| 8 | + |
| 9 | + |
| 10 | +class ListSpanExporter(SpanExporter): |
| 11 | + """A minimal span exporter that collects finished spans into a list.""" |
| 12 | + |
| 13 | + def __init__(self): |
| 14 | + self.spans = [] |
| 15 | + |
| 16 | + def export(self, spans): |
| 17 | + self.spans.extend(spans) |
| 18 | + return SpanExportResult.SUCCESS |
| 19 | + |
| 20 | + def shutdown(self): |
| 21 | + pass |
| 22 | + |
| 23 | + def clear(self): |
| 24 | + self.spans.clear() |
| 25 | + |
| 26 | + |
| 27 | +# Module-level provider (OTel only allows setting the global provider once) |
| 28 | +_exporter = ListSpanExporter() |
| 29 | +_provider = TracerProvider() |
| 30 | +_provider.add_span_processor(SimpleSpanProcessor(_exporter)) |
| 31 | +trace.set_tracer_provider(_provider) |
| 32 | + |
| 33 | + |
| 34 | +@pytest.fixture(autouse=True) |
| 35 | +def _clear_spans(): |
| 36 | + """Clear collected spans before each test.""" |
| 37 | + _exporter.clear() |
| 38 | + yield |
| 39 | + |
| 40 | + |
| 41 | +class TestTraceContextPropagation: |
| 42 | + """Tests for W3C traceparent header extraction in runs_endpoint.""" |
| 43 | + |
| 44 | + def _make_traceparent(self): |
| 45 | + """Create a traceparent header from a fresh span context.""" |
| 46 | + tracer = trace.get_tracer("test-client") |
| 47 | + with tracer.start_as_current_span("client-call") as span: |
| 48 | + ctx = span.get_span_context() |
| 49 | + carrier = {} |
| 50 | + TraceContextTextMapPropagator().inject(carrier) |
| 51 | + return carrier["traceparent"], ctx.trace_id, ctx.span_id |
| 52 | + |
| 53 | + def test_server_span_parents_to_incoming_traceparent(self): |
| 54 | + """When a request carries a traceparent header, the server span must |
| 55 | + become a child of that trace (same trace_id, parent_span_id matches).""" |
| 56 | + traceparent, parent_trace_id, parent_span_id = self._make_traceparent() |
| 57 | + |
| 58 | + # Simulate what the server does: extract and start span with parent context |
| 59 | + server_tracer = trace.get_tracer("azure.ai.agentserver") |
| 60 | + incoming_headers = {"traceparent": traceparent} |
| 61 | + extracted_ctx = TraceContextTextMapPropagator().extract(carrier=incoming_headers) |
| 62 | + |
| 63 | + with server_tracer.start_as_current_span( |
| 64 | + name="HostedAgents-test", |
| 65 | + kind=trace.SpanKind.SERVER, |
| 66 | + context=extracted_ctx, |
| 67 | + ) as server_span: |
| 68 | + server_ctx = server_span.get_span_context() |
| 69 | + |
| 70 | + assert server_ctx.trace_id == parent_trace_id, ( |
| 71 | + f"Server span trace_id {server_ctx.trace_id:#034x} should match " |
| 72 | + f"parent trace_id {parent_trace_id:#034x}" |
| 73 | + ) |
| 74 | + |
| 75 | + server_spans = [s for s in _exporter.spans if s.name == "HostedAgents-test"] |
| 76 | + assert len(server_spans) == 1 |
| 77 | + assert server_spans[0].parent.span_id == parent_span_id |
| 78 | + |
| 79 | + def test_server_span_is_root_without_traceparent(self): |
| 80 | + """When no traceparent header is present, the server span must be a |
| 81 | + root span (no parent, new trace_id).""" |
| 82 | + server_tracer = trace.get_tracer("azure.ai.agentserver") |
| 83 | + incoming_headers = {} |
| 84 | + extracted_ctx = TraceContextTextMapPropagator().extract(carrier=incoming_headers) |
| 85 | + |
| 86 | + with server_tracer.start_as_current_span( |
| 87 | + name="HostedAgents-no-parent", |
| 88 | + kind=trace.SpanKind.SERVER, |
| 89 | + context=extracted_ctx, |
| 90 | + ): |
| 91 | + pass |
| 92 | + |
| 93 | + server_spans = [s for s in _exporter.spans if s.name == "HostedAgents-no-parent"] |
| 94 | + assert len(server_spans) == 1 |
| 95 | + assert server_spans[0].parent is None, "Server span should be root when no traceparent is sent" |
| 96 | + |
| 97 | + def test_traceparent_header_case_insensitive(self): |
| 98 | + """Starlette's request.headers is a case-insensitive mapping, so |
| 99 | + mixed-case header keys are handled by the framework, not by our code. |
| 100 | + This test verifies the propagator works with the lowercase key that |
| 101 | + Starlette normalizes headers to.""" |
| 102 | + traceparent, parent_trace_id, _ = self._make_traceparent() |
| 103 | + |
| 104 | + # Starlette normalizes all header keys to lowercase |
| 105 | + server_tracer = trace.get_tracer("azure.ai.agentserver") |
| 106 | + incoming_headers = {"traceparent": traceparent} |
| 107 | + extracted_ctx = TraceContextTextMapPropagator().extract(carrier=incoming_headers) |
| 108 | + |
| 109 | + with server_tracer.start_as_current_span( |
| 110 | + name="HostedAgents-case-test", |
| 111 | + kind=trace.SpanKind.SERVER, |
| 112 | + context=extracted_ctx, |
| 113 | + ) as server_span: |
| 114 | + server_ctx = server_span.get_span_context() |
| 115 | + |
| 116 | + assert server_ctx.trace_id == parent_trace_id |
0 commit comments