1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
"""Tests for the distributed tracing policy."""
import logging
from azure.core.pipeline import PipelineResponse, PipelineRequest, PipelineContext
from azure.core.pipeline.policies import DistributedTracingPolicy, UserAgentPolicy
from azure.core.settings import settings
from tracing_common import FakeSpan
import time
import pytest
from utils import HTTP_RESPONSES, create_http_response, request_and_responses_product
try:
from unittest import mock
except ImportError:
import mock
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_distributed_tracing_policy_solo(http_request, http_response):
"""Test policy with no other policy and happy path"""
settings.tracing_implementation.set_value(FakeSpan)
with FakeSpan(name="parent") as root_span:
policy = DistributedTracingPolicy()
request = http_request("GET", "http://localhost/temp?query=query")
request.headers["x-ms-client-request-id"] = "some client request id"
pipeline_request = PipelineRequest(request, PipelineContext(None))
policy.on_request(pipeline_request)
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
response.headers["x-ms-request-id"] = "some request id"
assert request.headers.get("traceparent") == '123456789'
policy.on_response(pipeline_request, PipelineResponse(request, response, PipelineContext(None)))
time.sleep(0.001)
policy.on_request(pipeline_request)
try:
raise ValueError("Transport trouble")
except:
policy.on_exception(pipeline_request)
# Check on_response
network_span = root_span.children[0]
assert network_span.name == "/temp"
assert network_span.attributes.get("http.method") == "GET"
assert network_span.attributes.get("component") == "http"
assert network_span.attributes.get("http.url") == "http://localhost/temp?query=query"
assert network_span.attributes.get("http.user_agent") is None
assert network_span.attributes.get("x-ms-request-id") == "some request id"
assert network_span.attributes.get("x-ms-client-request-id") == "some client request id"
assert network_span.attributes.get("http.status_code") == 202
# Check on_exception
network_span = root_span.children[1]
assert network_span.name == "/temp"
assert network_span.attributes.get("http.method") == "GET"
assert network_span.attributes.get("component") == "http"
assert network_span.attributes.get("http.url") == "http://localhost/temp?query=query"
assert network_span.attributes.get("x-ms-client-request-id") == "some client request id"
assert network_span.attributes.get("http.user_agent") is None
assert network_span.attributes.get("x-ms-request-id") == None
assert network_span.attributes.get("http.status_code") == 504
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_distributed_tracing_policy_attributes(http_request, http_response):
"""Test policy with no other policy and happy path"""
settings.tracing_implementation.set_value(FakeSpan)
with FakeSpan(name="parent") as root_span:
policy = DistributedTracingPolicy(tracing_attributes={
'myattr': 'myvalue'
})
request = http_request("GET", "http://localhost/temp?query=query")
pipeline_request = PipelineRequest(request, PipelineContext(None))
policy.on_request(pipeline_request)
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
policy.on_response(pipeline_request, PipelineResponse(request, response, PipelineContext(None)))
# Check on_response
network_span = root_span.children[0]
assert network_span.attributes.get("myattr") == "myvalue"
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_distributed_tracing_policy_badurl(caplog, http_request, http_response):
"""Test policy with a bad url that will throw, and be sure policy ignores it"""
settings.tracing_implementation.set_value(FakeSpan)
with FakeSpan(name="parent") as root_span:
policy = DistributedTracingPolicy()
request = http_request("GET", "http://[[[")
request.headers["x-ms-client-request-id"] = "some client request id"
pipeline_request = PipelineRequest(request, PipelineContext(None))
with caplog.at_level(logging.WARNING, logger="azure.core.pipeline.policies.distributed_tracing"):
policy.on_request(pipeline_request)
assert "Unable to start network span" in caplog.text
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
response.headers["x-ms-request-id"] = "some request id"
assert request.headers.get("traceparent") is None # Got not network trace
policy.on_response(pipeline_request, PipelineResponse(request, response, PipelineContext(None)))
time.sleep(0.001)
policy.on_request(pipeline_request)
try:
raise ValueError("Transport trouble")
except:
policy.on_exception(pipeline_request)
assert len(root_span.children) == 0
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_distributed_tracing_policy_with_user_agent(http_request, http_response):
"""Test policy working with user agent."""
settings.tracing_implementation.set_value(FakeSpan)
with mock.patch.dict('os.environ', {"AZURE_HTTP_USER_AGENT": "mytools"}):
with FakeSpan(name="parent") as root_span:
policy = DistributedTracingPolicy()
request = http_request("GET", "http://localhost")
request.headers["x-ms-client-request-id"] = "some client request id"
pipeline_request = PipelineRequest(request, PipelineContext(None))
user_agent = UserAgentPolicy()
user_agent.on_request(pipeline_request)
policy.on_request(pipeline_request)
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
response.headers["x-ms-request-id"] = "some request id"
pipeline_response = PipelineResponse(request, response, PipelineContext(None))
assert request.headers.get("traceparent") == '123456789'
policy.on_response(pipeline_request, pipeline_response)
time.sleep(0.001)
policy.on_request(pipeline_request)
try:
raise ValueError("Transport trouble")
except:
policy.on_exception(pipeline_request)
user_agent.on_response(pipeline_request, pipeline_response)
network_span = root_span.children[0]
assert network_span.name == "/"
assert network_span.attributes.get("http.method") == "GET"
assert network_span.attributes.get("component") == "http"
assert network_span.attributes.get("http.url") == "http://localhost"
assert network_span.attributes.get("http.user_agent").endswith("mytools")
assert network_span.attributes.get("x-ms-request-id") == "some request id"
assert network_span.attributes.get("x-ms-client-request-id") == "some client request id"
assert network_span.attributes.get("http.status_code") == 202
network_span = root_span.children[1]
assert network_span.name == "/"
assert network_span.attributes.get("http.method") == "GET"
assert network_span.attributes.get("component") == "http"
assert network_span.attributes.get("http.url") == "http://localhost"
assert network_span.attributes.get("http.user_agent").endswith("mytools")
assert network_span.attributes.get("x-ms-client-request-id") == "some client request id"
assert network_span.attributes.get("x-ms-request-id") is None
assert network_span.attributes.get("http.status_code") == 504
# Exception should propagate status for Opencensus
assert network_span.status == 'Transport trouble'
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_span_namer(http_request, http_response):
settings.tracing_implementation.set_value(FakeSpan)
with FakeSpan(name="parent") as root_span:
request = http_request("GET", "http://localhost/temp?query=query")
pipeline_request = PipelineRequest(request, PipelineContext(None))
def fixed_namer(http_request):
assert http_request is request
return "overriddenname"
policy = DistributedTracingPolicy(network_span_namer=fixed_namer)
policy.on_request(pipeline_request)
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
policy.on_response(pipeline_request, PipelineResponse(request, response, PipelineContext(None)))
def operation_namer(http_request):
assert http_request is request
return "operation level name"
pipeline_request.context.options['network_span_namer'] = operation_namer
policy.on_request(pipeline_request)
response = create_http_response(http_response, request, None)
response.headers = request.headers
response.status_code = 202
policy.on_response(pipeline_request, PipelineResponse(request, response, PipelineContext(None)))
# Check init kwargs
network_span = root_span.children[0]
assert network_span.name == "overriddenname"
# Check operation kwargs
network_span = root_span.children[1]
assert network_span.name == "operation level name"
|
