forked from instana/python-sensor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_wsgi.py
More file actions
344 lines (261 loc) · 11.7 KB
/
Copy pathtest_wsgi.py
File metadata and controls
344 lines (261 loc) · 11.7 KB
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# (c) Copyright IBM Corp. 2021
# (c) Copyright Instana Inc. 2020
import time
import urllib3
import pytest
from typing import Generator
from instana.util.ids import hex_id
from tests.apps import bottle_app
from tests.helpers import testenv
from instana.singletons import agent, tracer
from instana.span.span import get_current_span
class TestWSGI:
@pytest.fixture(autouse=True)
def _resource(self) -> Generator[None, None, None]:
""" Clear all spans before a test run """
self.http = urllib3.PoolManager()
self.recorder = tracer.span_processor
self.recorder.clear_spans()
time.sleep(0.1)
def test_vanilla_requests(self) -> None:
response = self.http.request('GET', testenv["wsgi_server"] + '/')
spans = self.recorder.queued_spans()
assert 1 == len(spans)
assert get_current_span().is_recording() is False
assert response.status == 200
def test_get_request(self) -> None:
with tracer.start_as_current_span("test"):
response = self.http.request('GET', testenv["wsgi_server"] + '/')
spans = self.recorder.queued_spans()
assert 3 == len(spans)
assert get_current_span().is_recording() is False
wsgi_span = spans[0]
urllib3_span = spans[1]
test_span = spans[2]
assert response
assert 200 == response.status
assert 'X-INSTANA-T' in response.headers
assert int(response.headers['X-INSTANA-T'], 16)
assert response.headers["X-INSTANA-T"] == hex_id(wsgi_span.t)
assert 'X-INSTANA-S' in response.headers
assert int(response.headers['X-INSTANA-S'], 16)
assert response.headers["X-INSTANA-S"] == hex_id(wsgi_span.s)
assert 'X-INSTANA-L' in response.headers
assert response.headers['X-INSTANA-L'] == '1'
assert 'Server-Timing' in response.headers
server_timing_value = f"intid;desc={hex_id(wsgi_span.t)}"
assert response.headers['Server-Timing'] == server_timing_value
# Same traceId
assert test_span.t == urllib3_span.t
assert urllib3_span.t == wsgi_span.t
# Parent relationships
assert urllib3_span.p == test_span.s
assert wsgi_span.p == urllib3_span.s
assert wsgi_span.sy is None
assert urllib3_span.sy is None
assert test_span.sy is None
# Error logging
assert test_span.ec is None
assert urllib3_span.ec is None
assert wsgi_span.ec is None
# wsgi
assert "wsgi" == wsgi_span.n
assert '127.0.0.1:' + str(testenv["wsgi_port"]) == wsgi_span.data["http"]["host"]
assert '/' == wsgi_span.data["http"]["path"]
assert 'GET' == wsgi_span.data["http"]["method"]
assert "200" == wsgi_span.data["http"]["status"]
assert wsgi_span.data["http"]["error"] is None
assert wsgi_span.stack is None
def test_synthetic_request(self) -> None:
headers = {
'X-INSTANA-SYNTHETIC': '1'
}
with tracer.start_as_current_span("test"):
response = self.http.request('GET', testenv["wsgi_server"] + '/', headers=headers)
spans = self.recorder.queued_spans()
assert 3 == len(spans)
assert get_current_span().is_recording() is False
wsgi_span = spans[0]
urllib3_span = spans[1]
test_span = spans[2]
assert wsgi_span.sy
assert urllib3_span.sy is None
assert test_span.sy is None
def test_secret_scrubbing(self) -> None:
with tracer.start_as_current_span("test"):
response = self.http.request('GET', testenv["wsgi_server"] + '/?secret=shhh')
spans = self.recorder.queued_spans()
assert 3 == len(spans)
assert get_current_span().is_recording() is False
wsgi_span = spans[0]
urllib3_span = spans[1]
test_span = spans[2]
assert response
assert 200 == response.status
assert 'X-INSTANA-T' in response.headers
assert int(response.headers['X-INSTANA-T'], 16)
assert response.headers["X-INSTANA-T"] == hex_id(wsgi_span.t)
assert 'X-INSTANA-S' in response.headers
assert int(response.headers['X-INSTANA-S'], 16)
assert response.headers["X-INSTANA-S"] == hex_id(wsgi_span.s)
assert 'X-INSTANA-L' in response.headers
assert response.headers['X-INSTANA-L'] == '1'
assert 'Server-Timing' in response.headers
server_timing_value = f"intid;desc={hex_id(wsgi_span.t)}"
assert response.headers['Server-Timing'] == server_timing_value
# Same traceId
assert test_span.t == urllib3_span.t
assert urllib3_span.t == wsgi_span.t
# Parent relationships
assert urllib3_span.p == test_span.s
assert wsgi_span.p == urllib3_span.s
# Error logging
assert test_span.ec is None
assert urllib3_span.ec is None
assert wsgi_span.ec is None
# wsgi
assert "wsgi" == wsgi_span.n
assert '127.0.0.1:' + str(testenv["wsgi_port"]) == wsgi_span.data["http"]["host"]
assert '/' == wsgi_span.data["http"]["path"]
assert 'secret=<redacted>' == wsgi_span.data["http"]["params"]
assert 'GET' == wsgi_span.data["http"]["method"]
assert "200" == wsgi_span.data["http"]["status"]
assert wsgi_span.data["http"]["error"] is None
assert wsgi_span.stack is None
def test_with_incoming_context(self) -> None:
request_headers = dict()
request_headers['X-INSTANA-T'] = '0000000000000001'
request_headers['X-INSTANA-S'] = '0000000000000001'
response = self.http.request('GET', testenv["wsgi_server"] + '/', headers=request_headers)
assert response
assert 200 == response.status
spans = self.recorder.queued_spans()
assert 1 == len(spans)
wsgi_span = spans[0]
# assert wsgi_span.t == '0000000000000001'
# assert wsgi_span.p == '0000000000000001'
assert wsgi_span.t == 1
assert wsgi_span.p == 1
assert 'X-INSTANA-T' in response.headers
assert int(response.headers['X-INSTANA-T'], 16)
assert response.headers["X-INSTANA-T"] == hex_id(wsgi_span.t)
assert 'X-INSTANA-S' in response.headers
assert int(response.headers['X-INSTANA-S'], 16)
assert response.headers["X-INSTANA-S"] == hex_id(wsgi_span.s)
assert 'X-INSTANA-L' in response.headers
assert response.headers['X-INSTANA-L'] == '1'
assert 'Server-Timing' in response.headers
server_timing_value = f"intid;desc={hex_id(wsgi_span.t)}"
assert response.headers['Server-Timing'] == server_timing_value
def test_with_incoming_mixed_case_context(self) -> None:
request_headers = dict()
request_headers['X-InSTANa-T'] = '0000000000000001'
request_headers['X-instana-S'] = '0000000000000001'
response = self.http.request('GET', testenv["wsgi_server"] + '/', headers=request_headers)
assert response
assert 200 == response.status
spans = self.recorder.queued_spans()
assert 1 == len(spans)
wsgi_span = spans[0]
# assert wsgi_span.t == '0000000000000001'
# assert wsgi_span.p == '0000000000000001'
assert wsgi_span.t == 1
assert wsgi_span.p == 1
assert 'X-INSTANA-T' in response.headers
assert int(response.headers['X-INSTANA-T'], 16)
assert response.headers["X-INSTANA-T"] == hex_id(wsgi_span.t)
assert 'X-INSTANA-S' in response.headers
assert int(response.headers['X-INSTANA-S'], 16)
assert response.headers["X-INSTANA-S"] == hex_id(wsgi_span.s)
assert 'X-INSTANA-L' in response.headers
assert response.headers['X-INSTANA-L'] == '1'
assert 'Server-Timing' in response.headers
server_timing_value = f"intid;desc={hex_id(wsgi_span.t)}"
assert response.headers['Server-Timing'] == server_timing_value
def test_response_header_capture(self) -> None:
# Hack together a manual custom headers list
original_extra_http_headers = agent.options.extra_http_headers
agent.options.extra_http_headers = ["X-Capture-This", "X-Capture-That"]
with tracer.start_as_current_span("test"):
response = self.http.request(
"GET", testenv["wsgi_server"] + "/response_headers"
)
spans = self.recorder.queued_spans()
assert len(spans) == 3
wsgi_span = spans[0]
urllib3_span = spans[1]
test_span = spans[2]
assert response
assert response.status == 200
# Same traceId
assert test_span.t == urllib3_span.t
assert urllib3_span.t == wsgi_span.t
# Parent relationships
assert urllib3_span.p == test_span.s
assert wsgi_span.p == urllib3_span.s
# Synthetic
assert not wsgi_span.sy
assert not urllib3_span.sy
assert not test_span.sy
# Error logging
assert not test_span.ec
assert not urllib3_span.ec
assert not wsgi_span.ec
# wsgi
assert wsgi_span.n == "wsgi"
assert wsgi_span.data["http"]["host"] == "127.0.0.1:" + str(testenv["wsgi_port"])
assert wsgi_span.data["http"]["path"] == "/response_headers"
assert wsgi_span.data["http"]["method"] == "GET"
assert wsgi_span.data["http"]["status"] == "200"
assert not wsgi_span.data["http"]["error"]
# custom headers
assert "X-Capture-This" in wsgi_span.data["http"]["header"]
assert wsgi_span.data["http"]["header"]["X-Capture-This"] == "this"
assert "X-Capture-That" in wsgi_span.data["http"]["header"]
assert wsgi_span.data["http"]["header"]["X-Capture-That"] == "that"
agent.options.extra_http_headers = original_extra_http_headers
def test_request_header_capture(self) -> None:
original_extra_http_headers = agent.options.extra_http_headers
agent.options.extra_http_headers = ["X-Capture-This-Too", "X-Capture-That-Too"]
request_headers = {
"X-Capture-This-Too": "this too",
"X-Capture-That-Too": "that too",
}
with tracer.start_as_current_span("test"):
response = self.http.request(
"GET", testenv["wsgi_server"] + "/", headers=request_headers
)
spans = self.recorder.queued_spans()
assert len(spans) == 3
wsgi_span = spans[0]
urllib3_span = spans[1]
test_span = spans[2]
assert response.status == 200
# Same traceId
assert test_span.t == urllib3_span.t
assert urllib3_span.t == wsgi_span.t
# Parent relationships
assert urllib3_span.p == test_span.s
assert wsgi_span.p == urllib3_span.s
# Synthetic
assert not wsgi_span.sy
assert not urllib3_span.sy
assert not test_span.sy
# Error logging
assert not test_span.ec
assert not urllib3_span.ec
assert not wsgi_span.ec
# wsgi
assert wsgi_span.n == "wsgi"
assert wsgi_span.data["http"]["host"] == "127.0.0.1:" + str(testenv["wsgi_port"])
assert wsgi_span.data["http"]["path"] == "/"
assert wsgi_span.data["http"]["method"] == "GET"
assert wsgi_span.data["http"]["status"] == "200"
assert not wsgi_span.data["http"]["error"]
assert not wsgi_span.stack
# custom headers
assert "X-Capture-This-Too" in wsgi_span.data["http"]["header"]
assert wsgi_span.data["http"]["header"]["X-Capture-This-Too"] == "this too"
assert "X-Capture-That-Too" in wsgi_span.data["http"]["header"]
assert wsgi_span.data["http"]["header"]["X-Capture-That-Too"] == "that too"
agent.options.extra_http_headers = original_extra_http_headers