forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_grpc_aio.py
More file actions
584 lines (475 loc) · 18.2 KB
/
Copy pathtest_grpc_aio.py
File metadata and controls
584 lines (475 loc) · 18.2 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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
import asyncio
from typing import Optional
from unittest import mock
import grpc
import pytest
import pytest_asyncio
import sentry_sdk
from sentry_sdk import start_span, start_transaction
from sentry_sdk.consts import OP
from sentry_sdk.integrations.grpc import GRPCIntegration
from sentry_sdk.tracing_utils import has_span_streaming_enabled
from tests.conftest import ApproxDict
from tests.integrations.grpc.grpc_test_service_pb2 import gRPCTestMessage
from tests.integrations.grpc.grpc_test_service_pb2_grpc import (
add_gRPCTestServiceServicer_to_server,
gRPCTestServiceServicer,
gRPCTestServiceStub,
)
@pytest_asyncio.fixture(scope="function")
async def grpc_server_and_channel(sentry_init):
"""
Creates an async gRPC server and a channel connected to it.
Returns both for use in tests, and cleans up afterward.
"""
channel: "Optional[grpc.aio.Channel]" = None
server: "Optional[grpc.aio.Server]" = None
async def inner(span_streaming: bool):
nonlocal server, channel
sentry_init(
traces_sample_rate=1.0,
integrations=[GRPCIntegration()],
_experiments={"trace_lifecycle": "stream" if span_streaming else "static"},
)
# Create server
server = grpc.aio.server()
# Let gRPC choose a free port instead of hardcoding it
port = server.add_insecure_port("[::]:0")
# Add service implementation
add_gRPCTestServiceServicer_to_server(TestService, server)
# Start the server
await asyncio.create_task(server.start())
# Create channel connected to our server
channel = grpc.aio.insecure_channel(f"localhost:{port}") # noqa: E231
return server, channel
try:
yield inner
finally:
if channel is not None:
await channel.close()
if server is not None:
await server.stop(None)
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_noop_for_unimplemented_method(
sentry_init,
capture_events,
capture_items,
span_streaming,
):
sentry_init(
traces_sample_rate=1.0,
integrations=[GRPCIntegration()],
_experiments={"trace_lifecycle": "stream" if span_streaming else "static"},
)
# Create empty server with no services
server = grpc.aio.server()
port = server.add_insecure_port("[::]:0") # Let gRPC choose a free port
await asyncio.create_task(server.start())
if span_streaming:
items = capture_items("span")
try:
async with grpc.aio.insecure_channel(
f"localhost:{port}" # noqa: E231
) as channel:
stub = gRPCTestServiceStub(channel)
with pytest.raises(grpc.RpcError) as exc:
await stub.TestServe(gRPCTestMessage(text="test"))
assert exc.value.details() == "Method not found!"
finally:
await server.stop(None)
sentry_sdk.flush()
spans = [item.payload for item in items]
assert len(spans) == 1 # Only client span present.
else:
events = capture_events()
try:
async with grpc.aio.insecure_channel(
f"localhost:{port}" # noqa: E231
) as channel:
stub = gRPCTestServiceStub(channel)
with pytest.raises(grpc.RpcError) as exc:
await stub.TestServe(gRPCTestMessage(text="test"))
assert exc.value.details() == "Method not found!"
finally:
await server.stop(None)
assert not events
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_grpc_server_starts_transaction(
grpc_server_and_channel,
capture_events,
capture_items,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items("span")
await stub.TestServe(gRPCTestMessage(text="test"))
sentry_sdk.flush()
spans = [item.payload for item in items]
span = spans[0]
assert spans[1]["attributes"]["sentry.span.source"] == "custom"
assert spans[1]["attributes"]["sentry.op"] == OP.GRPC_SERVER
assert span["attributes"]["sentry.op"] == "test"
else:
events = capture_events()
await stub.TestServe(gRPCTestMessage(text="test"))
(event,) = events
span = event["spans"][0]
assert event["type"] == "transaction"
assert event["transaction_info"] == {
"source": "custom",
}
assert event["contexts"]["trace"]["op"] == OP.GRPC_SERVER
assert span["op"] == "test"
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_grpc_server_continues_transaction(
grpc_server_and_channel,
capture_events,
capture_items,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items("span")
with sentry_sdk.traces.start_span(name="custom parent") as segment_span:
metadata = (
(
"baggage",
"sentry-trace_id={trace_id},sentry-environment=test,"
"sentry-transaction=test-transaction,sentry-sample_rate=1.0".format(
trace_id=segment_span.trace_id
),
),
(
"sentry-trace",
"{trace_id}-{parent_span_id}-{sampled}".format(
trace_id=segment_span.trace_id,
parent_span_id=segment_span.span_id,
sampled=1,
),
),
)
await stub.TestServe(gRPCTestMessage(text="test"), metadata=metadata)
sentry_sdk.flush()
spans = [item.payload for item in items]
span = spans[0]
assert spans[1]["attributes"]["sentry.span.source"] == "custom"
assert spans[1]["attributes"]["sentry.op"] == OP.GRPC_SERVER
assert spans[1]["trace_id"] == segment_span.trace_id
assert span["attributes"]["sentry.op"] == "test"
else:
events = capture_events()
with sentry_sdk.start_transaction() as transaction:
metadata = (
(
"baggage",
"sentry-trace_id={trace_id},sentry-environment=test,"
"sentry-transaction=test-transaction,sentry-sample_rate=1.0".format(
trace_id=transaction.trace_id
),
),
(
"sentry-trace",
"{trace_id}-{parent_span_id}-{sampled}".format(
trace_id=transaction.trace_id,
parent_span_id=transaction.span_id,
sampled=1,
),
),
)
await stub.TestServe(gRPCTestMessage(text="test"), metadata=metadata)
(event, _) = events
span = event["spans"][0]
assert event["type"] == "transaction"
assert event["transaction_info"] == {
"source": "custom",
}
assert event["contexts"]["trace"]["op"] == OP.GRPC_SERVER
assert event["contexts"]["trace"]["trace_id"] == transaction.trace_id
assert span["op"] == "test"
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_grpc_server_exception(
grpc_server_and_channel,
capture_events,
capture_items,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items("event")
try:
await stub.TestServe(gRPCTestMessage(text="exception"))
raise AssertionError()
except Exception:
pass
(event,) = (item.payload for item in items if item.type == "event")
else:
events = capture_events()
try:
await stub.TestServe(gRPCTestMessage(text="exception"))
raise AssertionError()
except Exception:
pass
(event, _) = events
assert event["exception"]["values"][0]["type"] == "TestService.TestException"
assert event["exception"]["values"][0]["value"] == "test"
assert event["exception"]["values"][0]["mechanism"]["handled"] is False
assert event["exception"]["values"][0]["mechanism"]["type"] == "grpc"
@pytest.mark.asyncio
async def test_grpc_server_abort(grpc_server_and_channel, capture_events):
_, channel = await grpc_server_and_channel(False)
events = capture_events()
# Use the provided channel
stub = gRPCTestServiceStub(channel)
try:
await stub.TestServe(gRPCTestMessage(text="abort"))
raise AssertionError()
except Exception:
pass
# Add a small delay to allow events to be collected
await asyncio.sleep(0.1)
assert len(events) == 1
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_grpc_client_starts_span(
grpc_server_and_channel,
capture_events_forksafe,
capture_items_forksafe,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items_forksafe("span")
with sentry_sdk.traces.start_span(name="custom parent") as span:
await stub.TestServe(gRPCTestMessage(text="test"))
sentry_sdk.flush()
items.write_file.close()
items = items.read_event()
spans = [item["payload"] for item in items if item["type"] == "span"]
span = spans[2]
assert len(spans) == 4
assert span["attributes"]["sentry.op"] == OP.GRPC_CLIENT
assert (
span["name"]
== "unary unary call to /grpc_test_server.gRPCTestService/TestServe"
)
assert span["attributes"] == ApproxDict(
{
"rpc.method": "/grpc_test_server.gRPCTestService/TestServe",
"sentry.environment": mock.ANY,
"sentry.op": "grpc.client",
"sentry.origin": "auto.grpc.grpc",
"sentry.release": mock.ANY,
"sentry.sdk.name": "sentry.python",
"sentry.sdk.version": mock.ANY,
"sentry.segment.id": mock.ANY,
"sentry.segment.name": "custom parent",
"server.address": mock.ANY,
"thread.id": mock.ANY,
"thread.name": mock.ANY,
"rpc.response.status_code": "OK",
}
)
else:
events = capture_events_forksafe()
with start_transaction():
await stub.TestServe(gRPCTestMessage(text="test"))
events.write_file.close()
events.read_event()
local_transaction = events.read_event()
span = local_transaction["spans"][0]
assert len(local_transaction["spans"]) == 1
assert span["op"] == OP.GRPC_CLIENT
assert (
span["description"]
== "unary unary call to /grpc_test_server.gRPCTestService/TestServe"
)
assert span["data"] == ApproxDict(
{
"type": "unary unary",
"method": "/grpc_test_server.gRPCTestService/TestServe",
"code": "OK",
}
)
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_grpc_client_unary_stream_starts_span(
grpc_server_and_channel,
capture_events_forksafe,
capture_items_forksafe,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items_forksafe("span")
with sentry_sdk.traces.start_span(name="custom parent"):
response = stub.TestUnaryStream(gRPCTestMessage(text="test"))
[_ async for _ in response]
sentry_sdk.flush()
items.write_file.close()
items = items.read_event()
spans = [item["payload"] for item in items if item["type"] == "span"]
span = spans[0]
assert len(spans) == 2
assert span["attributes"]["sentry.op"] == OP.GRPC_CLIENT
assert (
span["name"]
== "unary stream call to /grpc_test_server.gRPCTestService/TestUnaryStream"
)
assert span["attributes"] == ApproxDict(
{
"rpc.method": "/grpc_test_server.gRPCTestService/TestUnaryStream",
"sentry.environment": mock.ANY,
"sentry.op": "grpc.client",
"sentry.origin": "auto.grpc.grpc",
"sentry.release": mock.ANY,
"sentry.sdk.name": "sentry.python",
"sentry.sdk.version": mock.ANY,
"sentry.segment.id": mock.ANY,
"sentry.segment.name": "custom parent",
"server.address": mock.ANY,
"thread.id": mock.ANY,
"thread.name": mock.ANY,
}
)
else:
events = capture_events_forksafe()
with start_transaction():
response = stub.TestUnaryStream(gRPCTestMessage(text="test"))
[_ async for _ in response]
events.write_file.close()
local_transaction = events.read_event()
span = local_transaction["spans"][0]
assert len(local_transaction["spans"]) == 1
assert span["op"] == OP.GRPC_CLIENT
assert (
span["description"]
== "unary stream call to /grpc_test_server.gRPCTestService/TestUnaryStream"
)
assert span["data"] == ApproxDict(
{
"type": "unary stream",
"method": "/grpc_test_server.gRPCTestService/TestUnaryStream",
}
)
@pytest.mark.asyncio
async def test_stream_stream(grpc_server_and_channel):
"""
Test to verify stream-stream works.
Tracing not supported for it yet.
"""
_, channel = await grpc_server_and_channel(False)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
response = stub.TestStreamStream((gRPCTestMessage(text="test"),))
async for r in response:
assert r.text == "test"
@pytest.mark.asyncio
async def test_stream_unary(grpc_server_and_channel):
"""
Test to verify stream-stream works.
Tracing not supported for it yet.
"""
_, channel = await grpc_server_and_channel(False)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
response = await stub.TestStreamUnary((gRPCTestMessage(text="test"),))
assert response.text == "test"
@pytest.mark.asyncio
@pytest.mark.parametrize("span_streaming", [True, False])
async def test_span_origin(
grpc_server_and_channel,
capture_events_forksafe,
capture_items_forksafe,
span_streaming,
):
_, channel = await grpc_server_and_channel(span_streaming)
# Use the provided channel
stub = gRPCTestServiceStub(channel)
if span_streaming:
items = capture_items_forksafe("span")
with sentry_sdk.traces.start_span(name="custom parent"):
await stub.TestServe(gRPCTestMessage(text="test"))
sentry_sdk.flush()
items.write_file.close()
items = items.read_event()
spans = [item["payload"] for item in items if item["type"] == "span"]
assert spans[1]["attributes"]["sentry.origin"] == "auto.grpc.grpc"
assert (
spans[0]["attributes"]["sentry.origin"] == "auto.grpc.grpc.TestService.aio"
) # manually created in TestService, not the instrumentation
assert spans[3]["attributes"]["sentry.origin"] == "manual"
assert spans[2]["attributes"]["sentry.origin"] == "auto.grpc.grpc"
else:
events = capture_events_forksafe()
with start_transaction(name="custom_transaction"):
await stub.TestServe(gRPCTestMessage(text="test"))
events.write_file.close()
transaction_from_integration = events.read_event()
custom_transaction = events.read_event()
assert (
transaction_from_integration["contexts"]["trace"]["origin"]
== "auto.grpc.grpc"
)
assert (
transaction_from_integration["spans"][0]["origin"]
== "auto.grpc.grpc.TestService.aio"
) # manually created in TestService, not the instrumentation
assert custom_transaction["contexts"]["trace"]["origin"] == "manual"
assert custom_transaction["spans"][0]["origin"] == "auto.grpc.grpc"
class TestService(gRPCTestServiceServicer):
class TestException(Exception):
__test__ = False
def __init__(self):
super().__init__("test")
@classmethod
async def TestServe(cls, request, context): # noqa: N802
client = sentry_sdk.get_client()
span_streaming = has_span_streaming_enabled(client.options)
if span_streaming:
with sentry_sdk.traces.start_span(
name="test",
attributes={
"sentry.op": "test",
"sentry.origin": "auto.grpc.grpc.TestService.aio",
},
):
pass
else:
with start_span(
op="test",
name="test",
origin="auto.grpc.grpc.TestService.aio",
):
pass
if request.text == "exception":
raise cls.TestException()
if request.text == "abort":
await context.abort(grpc.StatusCode.ABORTED, "Aborted!")
return gRPCTestMessage(text=request.text)
@classmethod
async def TestUnaryStream(cls, request, context): # noqa: N802
for _ in range(3):
yield gRPCTestMessage(text=request.text)
@classmethod
async def TestStreamStream(cls, request, context): # noqa: N802
async for r in request:
yield r
@classmethod
async def TestStreamUnary(cls, request, context): # noqa: N802
requests = [r async for r in request]
return requests.pop()