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
|
import struct
from asyncio import Queue
from collections import namedtuple
from unittest.mock import Mock
import pytest
from h2.errors import ErrorCodes
from multidict import MultiDict
from grpclib.const import Status, Cardinality
from grpclib.events import _DispatchServerEvents
from grpclib.stream import send_message
from grpclib.server import Stream, GRPCError
from grpclib.protocol import Connection, EventsProcessor
from grpclib.metadata import decode_metadata
from grpclib.exceptions import ProtocolError
from grpclib.encoding.proto import ProtoCodec
from stubs import TransportStub, DummyHandler
from dummy_pb2 import DummyRequest, DummyReply
from test_protocol import create_connections, create_headers
SendHeaders = namedtuple('SendHeaders', 'headers, end_stream')
SendData = namedtuple('SendData', 'data, end_stream')
End = namedtuple('End', '')
Reset = namedtuple('Reset', 'error_code')
class ServerError(Exception):
pass
class WriteError(Exception):
pass
class H2TransportStub:
def is_closing(self):
return False
class H2StreamStub:
_transport = H2TransportStub()
def __init__(self):
self.connection = Mock()
self.connection.messages_sent = 0
self.__headers__ = Queue()
self.__data__ = Queue()
self.__events__ = []
async def recv_headers(self):
return await self.__headers__.get()
async def recv_data(self, size):
data = await self.__data__.get()
assert len(data) == size
return data
async def send_headers(self, headers, end_stream=False):
self.__events__.append(SendHeaders(headers, end_stream))
async def send_data(self, data, end_stream=False):
self.__events__.append(SendData(data, end_stream))
async def end(self):
self.__events__.append(End())
async def reset(self, error_code=ErrorCodes.NO_ERROR):
self.__events__.append(Reset(error_code))
@property
def closable(self):
return True
def reset_nowait(self, error_code=ErrorCodes.NO_ERROR):
self.__events__.append(Reset(error_code))
@pytest.fixture(name='stub')
def _stub():
return H2StreamStub()
@pytest.fixture(name='stream')
def _stream(stub):
stream = Stream(stub, '/svc/Method', Cardinality.UNARY_UNARY,
DummyRequest, DummyReply,
codec=ProtoCodec(), status_details_codec=None,
dispatch=_DispatchServerEvents())
stream.metadata = MultiDict()
return stream
@pytest.fixture(name='stream_streaming')
def _stream_streaming(stub):
stream = Stream(stub, '/svc/Method', Cardinality.UNARY_STREAM,
DummyRequest, DummyReply,
codec=ProtoCodec(), status_details_codec=None,
dispatch=_DispatchServerEvents())
stream.metadata = MultiDict()
return stream
def encode_message(message):
message_bin = message.SerializeToString()
return (struct.pack('?', False)
+ struct.pack('>I', len(message_bin))
+ message_bin)
@pytest.mark.asyncio
async def test_send_custom_metadata(stream, stub):
async with stream:
await stream.send_initial_metadata(metadata={
'foo': 'foo-value',
})
await stream.send_message(DummyReply(value='pong'))
await stream.send_trailing_metadata(metadata={
'bar': 'bar-value',
})
assert stub.__events__ == [
SendHeaders(
[
(':status', '200'),
('content-type', 'application/grpc+proto'),
('foo', 'foo-value'),
],
end_stream=False,
),
SendData(
encode_message(DummyReply(value='pong')),
end_stream=False,
),
SendHeaders(
[
('grpc-status', str(Status.OK.value)),
('bar', 'bar-value'),
],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_send_initial_metadata_twice(stream):
async with stream:
await stream.send_initial_metadata()
with pytest.raises(ProtocolError) as err:
await stream.send_initial_metadata()
await stream.send_trailing_metadata(status=Status.UNKNOWN)
err.match('Initial metadata was already sent')
@pytest.mark.asyncio
async def test_send_message_twice(stream):
async with stream:
await stream.send_message(DummyReply(value='pong1'))
with pytest.raises(ProtocolError) as err:
await stream.send_message(DummyReply(value='pong2'))
err.match('Message was already sent')
@pytest.mark.asyncio
async def test_send_message_twice_ok(stream_streaming, stub):
async with stream_streaming:
await stream_streaming.send_message(DummyReply(value='pong1'))
await stream_streaming.send_message(DummyReply(value='pong2'))
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto')],
end_stream=False,
),
SendData(
encode_message(DummyReply(value='pong1')),
end_stream=False,
),
SendData(
encode_message(DummyReply(value='pong2')),
end_stream=False,
),
SendHeaders(
[('grpc-status', str(Status.OK.value))],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_send_trailing_metadata_twice(stream):
async with stream:
await stream.send_trailing_metadata(status=Status.UNKNOWN)
with pytest.raises(ProtocolError) as err:
await stream.send_trailing_metadata(status=Status.UNKNOWN)
err.match('Trailing metadata was already sent')
@pytest.mark.asyncio
async def test_no_response(stream, stub):
with pytest.raises(ProtocolError, match='requires a single message'):
async with stream:
pass
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto'),
('grpc-status', str(Status.UNKNOWN.value)),
('grpc-message', 'Internal Server Error')],
end_stream=True,
),
Reset(ErrorCodes.NO_ERROR),
]
@pytest.mark.asyncio
async def test_no_messages_for_unary(stream):
async with stream:
with pytest.raises(ProtocolError) as err:
await stream.send_trailing_metadata()
raise err.value
err.match('OK status requires a single message to be sent')
@pytest.mark.asyncio
async def test_no_messages_for_stream(stream_streaming, stub):
async with stream_streaming:
await stream_streaming.send_initial_metadata()
await stream_streaming.send_trailing_metadata()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto')],
end_stream=False,
),
SendHeaders(
[('grpc-status', str(Status.OK.value))],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_successful_trailers_only_explicit(stream_streaming, stub):
async with stream_streaming:
await stream_streaming.send_trailing_metadata()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto'),
('grpc-status', str(Status.OK.value))],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_successful_trailers_only_implicit(stream_streaming, stub):
async with stream_streaming:
pass
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto'),
('grpc-status', str(Status.OK.value))],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_cancel_twice(stream):
async with stream:
await stream.cancel()
with pytest.raises(ProtocolError) as err:
await stream.cancel()
err.match('Stream was already cancelled')
@pytest.mark.asyncio
async def test_error_before_send_initial_metadata(stream, stub):
async with stream:
raise Exception()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto'),
('grpc-status', str(Status.UNKNOWN.value)),
('grpc-message', 'Internal Server Error')],
end_stream=True,
),
Reset(ErrorCodes.NO_ERROR),
]
@pytest.mark.asyncio
async def test_error_after_send_initial_metadata(stream, stub):
async with stream:
await stream.send_initial_metadata()
raise Exception()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto')],
end_stream=False,
),
SendHeaders(
[('grpc-status', str(Status.UNKNOWN.value)),
('grpc-message', 'Internal Server Error')],
end_stream=True,
),
Reset(ErrorCodes.NO_ERROR),
]
@pytest.mark.asyncio
async def test_error_after_send_message(stream, stub):
async with stream:
await stream.send_message(DummyReply(value='pong'))
raise Exception()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto')],
end_stream=False,
),
SendData(
encode_message(DummyReply(value='pong')),
end_stream=False,
),
SendHeaders(
[('grpc-status', str(Status.UNKNOWN.value)),
('grpc-message', 'Internal Server Error')],
end_stream=True,
),
Reset(ErrorCodes.NO_ERROR),
]
@pytest.mark.asyncio
async def test_error_after_send_trailing_metadata(stream, stub):
async with stream:
await stream.send_message(DummyReply(value='pong'))
await stream.send_trailing_metadata()
raise Exception()
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto')],
end_stream=False,
),
SendData(
encode_message(DummyReply(value='pong')),
end_stream=False,
),
SendHeaders(
[('grpc-status', str(Status.OK.value))],
end_stream=True,
),
]
@pytest.mark.asyncio
async def test_grpc_error(stream, stub):
async with stream:
raise GRPCError(Status.DEADLINE_EXCEEDED)
assert stub.__events__ == [
SendHeaders(
[(':status', '200'),
('content-type', 'application/grpc+proto'),
('grpc-status', str(Status.DEADLINE_EXCEEDED.value))],
end_stream=True,
),
Reset(ErrorCodes.NO_ERROR),
]
def mk_stream(h2_stream, metadata):
stream = Stream(h2_stream, '/svc/Method', Cardinality.UNARY_UNARY,
DummyRequest, DummyReply, codec=ProtoCodec(),
status_details_codec=None,
dispatch=_DispatchServerEvents())
stream.metadata = metadata
return stream
@pytest.mark.asyncio
async def test_exit_and_stream_was_closed(loop, config):
client_h2c, server_h2c = create_connections()
to_client_transport = TransportStub(client_h2c)
to_server_transport = TransportStub(server_h2c)
client_conn = Connection(client_h2c, to_server_transport, config=config)
server_conn = Connection(server_h2c, to_client_transport, config=config)
server_proc = EventsProcessor(DummyHandler(), server_conn)
client_proc = EventsProcessor(DummyHandler(), client_conn)
client_h2_stream = client_conn.create_stream()
await client_h2_stream.send_request(create_headers(),
_processor=client_proc)
request = DummyRequest(value='ping')
await send_message(client_h2_stream, ProtoCodec(), request, DummyRequest,
end=True)
to_server_transport.process(server_proc)
server_h2_stream = server_proc.handler.stream
request_metadata = decode_metadata(server_proc.handler.headers)
async with mk_stream(server_h2_stream, request_metadata) as server_stream:
await server_stream.recv_message()
# simulating client closing stream
await client_h2_stream.reset()
to_server_transport.process(server_proc)
# we should fail here on this attempt to send something
await server_stream.send_message(DummyReply(value='pong'))
@pytest.mark.asyncio
async def test_exit_and_connection_was_closed(loop, config):
client_h2c, server_h2c = create_connections()
to_client_transport = TransportStub(client_h2c)
to_server_transport = TransportStub(server_h2c)
client_conn = Connection(client_h2c, to_server_transport, config=config)
server_conn = Connection(server_h2c, to_client_transport, config=config)
server_proc = EventsProcessor(DummyHandler(), server_conn)
client_proc = EventsProcessor(DummyHandler(), client_conn)
client_h2_stream = client_conn.create_stream()
await client_h2_stream.send_request(create_headers(),
_processor=client_proc)
request = DummyRequest(value='ping')
await send_message(client_h2_stream, ProtoCodec(), request, DummyRequest,
end=True)
to_server_transport.process(server_proc)
server_h2_stream = server_proc.handler.stream
request_metadata = decode_metadata(server_proc.handler.headers)
async with mk_stream(server_h2_stream, request_metadata) as server_stream:
await server_stream.recv_message()
client_h2c.close_connection()
to_server_transport.process(server_proc)
raise ServerError() # should be suppressed
@pytest.mark.asyncio
async def test_exit_and_connection_was_broken(loop, config):
client_h2c, server_h2c = create_connections()
to_client_transport = TransportStub(client_h2c)
to_server_transport = TransportStub(server_h2c)
client_conn = Connection(client_h2c, to_server_transport, config=config)
server_conn = Connection(server_h2c, to_client_transport, config=config)
server_proc = EventsProcessor(DummyHandler(), server_conn)
client_proc = EventsProcessor(DummyHandler(), client_conn)
client_h2_stream = client_conn.create_stream()
await client_h2_stream.send_request(create_headers(),
_processor=client_proc)
request = DummyRequest(value='ping')
await send_message(client_h2_stream, ProtoCodec(), request, DummyRequest,
end=True)
to_server_transport.process(server_proc)
server_h2_stream = server_proc.handler.stream
request_metadata = decode_metadata(server_proc.handler.headers)
with pytest.raises(WriteError):
async with mk_stream(server_h2_stream,
request_metadata) as server_stream:
server_stream.metadata = request_metadata
await server_stream.recv_message()
# simulate broken connection
to_client_transport.__raise_on_write__(WriteError)
@pytest.mark.asyncio
async def test_send_trailing_metadata_on_closed_stream(loop, config):
client_h2c, server_h2c = create_connections()
to_client_transport = TransportStub(client_h2c)
to_server_transport = TransportStub(server_h2c)
client_conn = Connection(client_h2c, to_server_transport, config=config)
server_conn = Connection(server_h2c, to_client_transport, config=config)
server_proc = EventsProcessor(DummyHandler(), server_conn)
client_proc = EventsProcessor(DummyHandler(), client_conn)
client_h2_stream = client_conn.create_stream()
await client_h2_stream.send_request(create_headers(),
_processor=client_proc)
request = DummyRequest(value='ping')
await send_message(client_h2_stream, ProtoCodec(), request, DummyRequest,
end=True)
to_server_transport.process(server_proc)
server_h2_stream = server_proc.handler.stream
request_metadata = decode_metadata(server_proc.handler.headers)
send_trailing_metadata_done = False
async with mk_stream(server_h2_stream, request_metadata) as server_stream:
await server_stream.send_trailing_metadata(status=Status.UNKNOWN)
send_trailing_metadata_done = True
assert send_trailing_metadata_done
|
