/
ServerCallImplTest.java
506 lines (420 loc) · 16.3 KB
/
ServerCallImplTest.java
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
/*
* Copyright 2015 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.grpc.internal;
import static com.google.common.base.Charsets.UTF_8;
import static io.grpc.internal.GrpcUtil.CONTENT_LENGTH_KEY;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import com.google.common.io.CharStreams;
import io.grpc.Attributes;
import io.grpc.CompressorRegistry;
import io.grpc.Context;
import io.grpc.DecompressorRegistry;
import io.grpc.InternalChannelz.ServerStats;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.MethodDescriptor.Marshaller;
import io.grpc.MethodDescriptor.MethodType;
import io.grpc.SecurityLevel;
import io.grpc.ServerCall;
import io.grpc.Status;
import io.grpc.internal.ServerCallImpl.ServerStreamListenerImpl;
import io.grpc.internal.testing.SingleMessageProducer;
import io.perfmark.PerfMark;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
@RunWith(JUnit4.class)
public class ServerCallImplTest {
@SuppressWarnings("deprecation") // https://github.com/grpc/grpc-java/issues/7467
@Rule public final ExpectedException thrown = ExpectedException.none();
@Mock private ServerStream stream;
@Mock private ServerCall.Listener<Long> callListener;
private final CallTracer serverCallTracer = CallTracer.getDefaultFactory().create();
private ServerCallImpl<Long, Long> call;
private Context.CancellableContext context;
private static final MethodDescriptor<Long, Long> UNARY_METHOD =
MethodDescriptor.<Long, Long>newBuilder()
.setType(MethodType.UNARY)
.setFullMethodName("service/method")
.setRequestMarshaller(new LongMarshaller())
.setResponseMarshaller(new LongMarshaller())
.build();
private static final MethodDescriptor<Long, Long> CLIENT_STREAMING_METHOD =
MethodDescriptor.<Long, Long>newBuilder()
.setType(MethodType.UNARY)
.setFullMethodName("service/method")
.setRequestMarshaller(new LongMarshaller())
.setResponseMarshaller(new LongMarshaller())
.build();
private final Metadata requestHeaders = new Metadata();
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
context = Context.ROOT.withCancellation();
call = new ServerCallImpl<>(stream, UNARY_METHOD, requestHeaders, context,
DecompressorRegistry.getDefaultInstance(), CompressorRegistry.getDefaultInstance(),
serverCallTracer, PerfMark.createTag());
}
@Test
public void callTracer_success() {
callTracer0(Status.OK);
}
@Test
public void callTracer_failure() {
callTracer0(Status.UNKNOWN);
}
private void callTracer0(Status status) {
CallTracer tracer = CallTracer.getDefaultFactory().create();
ServerStats.Builder beforeBuilder = new ServerStats.Builder();
tracer.updateBuilder(beforeBuilder);
ServerStats before = beforeBuilder.build();
assertEquals(0, before.callsStarted);
assertEquals(0, before.lastCallStartedNanos);
call = new ServerCallImpl<>(stream, UNARY_METHOD, requestHeaders, context,
DecompressorRegistry.getDefaultInstance(), CompressorRegistry.getDefaultInstance(),
tracer, PerfMark.createTag());
// required boilerplate
call.sendHeaders(new Metadata());
call.sendMessage(123L);
// end: required boilerplate
call.close(status, new Metadata());
ServerStats.Builder afterBuilder = new ServerStats.Builder();
tracer.updateBuilder(afterBuilder);
ServerStats after = afterBuilder.build();
assertEquals(1, after.callsStarted);
if (status.isOk()) {
assertEquals(1, after.callsSucceeded);
} else {
assertEquals(1, after.callsFailed);
}
}
@Test
public void request() {
call.request(10);
verify(stream).request(10);
}
@Test
public void sendHeader_firstCall() {
Metadata headers = new Metadata();
call.sendHeaders(headers);
verify(stream).writeHeaders(headers);
}
@Test
public void sendHeader_contentLengthDiscarded() {
Metadata headers = new Metadata();
headers.put(CONTENT_LENGTH_KEY, "123");
call.sendHeaders(headers);
verify(stream).writeHeaders(headers);
assertNull(headers.get(CONTENT_LENGTH_KEY));
}
@Test
public void sendHeader_failsOnSecondCall() {
call.sendHeaders(new Metadata());
thrown.expect(IllegalStateException.class);
thrown.expectMessage("sendHeaders has already been called");
call.sendHeaders(new Metadata());
}
@Test
public void sendHeader_failsOnClosed() {
call.close(Status.CANCELLED, new Metadata());
thrown.expect(IllegalStateException.class);
thrown.expectMessage("call is closed");
call.sendHeaders(new Metadata());
}
@Test
public void sendMessage() {
call.sendHeaders(new Metadata());
call.sendMessage(1234L);
verify(stream).writeMessage(isA(InputStream.class));
verify(stream).flush();
}
@Test
public void sendMessage_failsOnClosed() {
call.sendHeaders(new Metadata());
call.close(Status.CANCELLED, new Metadata());
thrown.expect(IllegalStateException.class);
thrown.expectMessage("call is closed");
call.sendMessage(1234L);
}
@Test
public void sendMessage_failsIfheadersUnsent() {
thrown.expect(IllegalStateException.class);
thrown.expectMessage("sendHeaders has not been called");
call.sendMessage(1234L);
}
@Test
public void sendMessage_closesOnFailure() {
call.sendHeaders(new Metadata());
doThrow(new RuntimeException("bad")).when(stream).writeMessage(isA(InputStream.class));
call.sendMessage(1234L);
verify(stream).close(isA(Status.class), isA(Metadata.class));
}
@Test
public void sendMessage_serverSendsOne_closeOnSecondCall_unary() {
sendMessage_serverSendsOne_closeOnSecondCall(UNARY_METHOD);
}
@Test
public void sendMessage_serverSendsOne_closeOnSecondCall_clientStreaming() {
sendMessage_serverSendsOne_closeOnSecondCall(CLIENT_STREAMING_METHOD);
}
private void sendMessage_serverSendsOne_closeOnSecondCall(
MethodDescriptor<Long, Long> method) {
ServerCallImpl<Long, Long> serverCall = new ServerCallImpl<>(
stream,
method,
requestHeaders,
context,
DecompressorRegistry.getDefaultInstance(),
CompressorRegistry.getDefaultInstance(),
serverCallTracer,
PerfMark.createTag());
serverCall.sendHeaders(new Metadata());
serverCall.sendMessage(1L);
verify(stream, times(1)).writeMessage(any(InputStream.class));
verify(stream, never()).close(any(Status.class), any(Metadata.class));
// trying to send a second message causes gRPC to close the underlying stream
serverCall.sendMessage(1L);
verify(stream, times(1)).writeMessage(any(InputStream.class));
ArgumentCaptor<Status> statusCaptor = ArgumentCaptor.forClass(Status.class);
verify(stream, times(1)).cancel(statusCaptor.capture());
assertEquals(Status.Code.INTERNAL, statusCaptor.getValue().getCode());
assertEquals(ServerCallImpl.TOO_MANY_RESPONSES, statusCaptor.getValue().getDescription());
}
@Test
public void sendMessage_serverSendsOne_closeOnSecondCall_appRunToCompletion_unary() {
sendMessage_serverSendsOne_closeOnSecondCall_appRunToCompletion(UNARY_METHOD);
}
@Test
public void sendMessage_serverSendsOne_closeOnSecondCall_appRunToCompletion_clientStreaming() {
sendMessage_serverSendsOne_closeOnSecondCall_appRunToCompletion(CLIENT_STREAMING_METHOD);
}
private void sendMessage_serverSendsOne_closeOnSecondCall_appRunToCompletion(
MethodDescriptor<Long, Long> method) {
ServerCallImpl<Long, Long> serverCall = new ServerCallImpl<>(
stream,
method,
requestHeaders,
context,
DecompressorRegistry.getDefaultInstance(),
CompressorRegistry.getDefaultInstance(),
serverCallTracer,
PerfMark.createTag());
serverCall.sendHeaders(new Metadata());
serverCall.sendMessage(1L);
serverCall.sendMessage(1L);
verify(stream, times(1)).writeMessage(any(InputStream.class));
verify(stream, times(1)).cancel(any(Status.class));
// App runs to completion but everything is ignored
serverCall.sendMessage(1L);
serverCall.close(Status.OK, new Metadata());
try {
serverCall.close(Status.OK, new Metadata());
fail("calling a second time should still cause an error");
} catch (IllegalStateException expected) {
// noop
}
}
@Test
public void serverSendsOne_okFailsOnMissingResponse_unary() {
serverSendsOne_okFailsOnMissingResponse(UNARY_METHOD);
}
@Test
public void serverSendsOne_okFailsOnMissingResponse_clientStreaming() {
serverSendsOne_okFailsOnMissingResponse(CLIENT_STREAMING_METHOD);
}
private void serverSendsOne_okFailsOnMissingResponse(
MethodDescriptor<Long, Long> method) {
ServerCallImpl<Long, Long> serverCall = new ServerCallImpl<>(
stream,
method,
requestHeaders,
context,
DecompressorRegistry.getDefaultInstance(),
CompressorRegistry.getDefaultInstance(),
serverCallTracer,
PerfMark.createTag());
serverCall.close(Status.OK, new Metadata());
ArgumentCaptor<Status> statusCaptor = ArgumentCaptor.forClass(Status.class);
verify(stream, times(1)).cancel(statusCaptor.capture());
assertEquals(Status.Code.INTERNAL, statusCaptor.getValue().getCode());
assertEquals(ServerCallImpl.MISSING_RESPONSE, statusCaptor.getValue().getDescription());
}
@Test
public void serverSendsOne_canErrorWithoutResponse() {
final String description = "test description";
final Status status = Status.RESOURCE_EXHAUSTED.withDescription(description);
final Metadata metadata = new Metadata();
call.close(status, metadata);
verify(stream, times(1)).close(same(status), same(metadata));
}
@Test
public void isReady() {
when(stream.isReady()).thenReturn(true);
assertTrue(call.isReady());
call.close(Status.OK, new Metadata());
assertFalse(call.isReady());
}
@Test
public void getAuthority() {
when(stream.getAuthority()).thenReturn("fooapi.googleapis.com");
assertEquals("fooapi.googleapis.com", call.getAuthority());
verify(stream).getAuthority();
}
@Test
public void getNullAuthority() {
when(stream.getAuthority()).thenReturn(null);
assertNull(call.getAuthority());
verify(stream).getAuthority();
}
@Test
public void getSecurityLevel() {
Attributes attributes = Attributes.newBuilder()
.set(GrpcAttributes.ATTR_SECURITY_LEVEL, SecurityLevel.INTEGRITY).build();
when(stream.getAttributes()).thenReturn(attributes);
assertEquals(SecurityLevel.INTEGRITY, call.getSecurityLevel());
verify(stream).getAttributes();
}
@Test
public void getNullSecurityLevel() {
when(stream.getAttributes()).thenReturn(null);
assertEquals(SecurityLevel.NONE, call.getSecurityLevel());
verify(stream).getAttributes();
}
@Test
public void setMessageCompression() {
call.setMessageCompression(true);
verify(stream).setMessageCompression(true);
}
@Test
public void streamListener_halfClosed() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.halfClosed();
verify(callListener).onHalfClose();
}
@Test
public void streamListener_halfClosed_onlyOnce() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.halfClosed();
// canceling the call should short circuit future halfClosed() calls.
streamListener.closed(Status.CANCELLED);
streamListener.halfClosed();
verify(callListener).onHalfClose();
}
@Test
public void streamListener_closedOk() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.closed(Status.OK);
verify(callListener).onComplete();
assertTrue(context.isCancelled());
assertNull(context.cancellationCause());
// The call considers cancellation to be an exceptional situation so it should
// not be cancelled with an OK status.
assertFalse(call.isCancelled());
}
@Test
public void streamListener_closedCancelled() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.closed(Status.CANCELLED);
verify(callListener).onCancel();
assertTrue(context.isCancelled());
assertNull(context.cancellationCause());
}
@Test
public void streamListener_onReady() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.onReady();
verify(callListener).onReady();
}
@Test
public void streamListener_onReady_onlyOnce() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.onReady();
// canceling the call should short circuit future halfClosed() calls.
streamListener.closed(Status.CANCELLED);
streamListener.onReady();
verify(callListener).onReady();
}
@Test
public void streamListener_messageRead() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.messagesAvailable(new SingleMessageProducer(UNARY_METHOD.streamRequest(1234L)));
verify(callListener).onMessage(1234L);
}
@Test
public void streamListener_messageRead_onlyOnce() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
streamListener.messagesAvailable(new SingleMessageProducer(UNARY_METHOD.streamRequest(1234L)));
// canceling the call should short circuit future halfClosed() calls.
streamListener.closed(Status.CANCELLED);
streamListener.messagesAvailable(new SingleMessageProducer(UNARY_METHOD.streamRequest(1234L)));
verify(callListener).onMessage(1234L);
}
@Test
public void streamListener_unexpectedRuntimeException() {
ServerStreamListenerImpl<Long> streamListener =
new ServerCallImpl.ServerStreamListenerImpl<>(call, callListener, context);
doThrow(new RuntimeException("unexpected exception"))
.when(callListener)
.onMessage(any(Long.class));
InputStream inputStream = UNARY_METHOD.streamRequest(1234L);
thrown.expect(RuntimeException.class);
thrown.expectMessage("unexpected exception");
streamListener.messagesAvailable(new SingleMessageProducer(inputStream));
}
private static class LongMarshaller implements Marshaller<Long> {
@Override
public InputStream stream(Long value) {
return new ByteArrayInputStream(value.toString().getBytes(UTF_8));
}
@Override
public Long parse(InputStream stream) {
try {
return Long.parseLong(CharStreams.toString(new InputStreamReader(stream, UTF_8)));
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
}