forked from grpc/grpc-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathServerImplTest.java
More file actions
402 lines (359 loc) · 13.7 KB
/
ServerImplTest.java
File metadata and controls
402 lines (359 loc) · 13.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
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
/*
* Copyright 2014, Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package io.grpc;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.notNull;
import static org.mockito.Matchers.same;
import static org.mockito.Mockito.timeout;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import io.grpc.MethodDescriptor.MethodType;
import io.grpc.internal.ServerListener;
import io.grpc.internal.ServerStream;
import io.grpc.internal.ServerStreamListener;
import io.grpc.internal.ServerTransport;
import io.grpc.internal.ServerTransportListener;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import java.io.IOException;
import java.io.InputStream;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.atomic.AtomicReference;
/** Unit tests for {@link ServerImpl}. */
@RunWith(JUnit4.class)
public class ServerImplTest {
private static final IntegerMarshaller INTEGER_MARSHALLER = IntegerMarshaller.INSTANCE;
private static final StringMarshaller STRING_MARSHALLER = StringMarshaller.INSTANCE;
private ExecutorService executor = Executors.newSingleThreadExecutor();
private MutableHandlerRegistry registry = new MutableHandlerRegistryImpl();
private SimpleServer transportServer = new SimpleServer();
private ServerImpl server = new ServerImpl(executor, registry, transportServer);
@Mock
private ServerStream stream;
@Mock
private ServerCall.Listener<String> callListener;
/** Set up for test. */
@Before
public void startUp() throws IOException {
MockitoAnnotations.initMocks(this);
server.start();
}
/** Tear down after test. */
@After
public void tearDown() {
executor.shutdownNow();
}
@Test
public void startStopImmediate() throws IOException {
transportServer = new SimpleServer() {
@Override
public void shutdown() {}
};
ServerImpl server = new ServerImpl(executor, registry, transportServer);
server.start();
server.shutdown();
assertTrue(server.isShutdown());
assertFalse(server.isTerminated());
transportServer.listener.serverShutdown();
assertTrue(server.isTerminated());
}
@Test
public void stopImmediate() {
transportServer = new SimpleServer() {
@Override
public void shutdown() {
throw new AssertionError("Should not be called, because wasn't started");
}
};
ServerImpl server = new ServerImpl(executor, registry, transportServer);
server.shutdown();
assertTrue(server.isShutdown());
assertTrue(server.isTerminated());
}
@Test
public void startStopImmediateWithChildTransport() throws IOException {
ServerImpl server = new ServerImpl(executor, registry, transportServer);
server.start();
class DelayedShutdownServerTransport extends SimpleServerTransport {
boolean shutdown;
@Override
public void shutdown() {
shutdown = true;
}
}
DelayedShutdownServerTransport serverTransport = new DelayedShutdownServerTransport();
transportServer.registerNewServerTransport(serverTransport);
server.shutdown();
assertTrue(server.isShutdown());
assertFalse(server.isTerminated());
assertTrue(serverTransport.shutdown);
serverTransport.listener.transportTerminated();
assertTrue(server.isTerminated());
}
@Test
public void transportServerFailsStartup() {
final IOException ex = new IOException();
class FailingStartupServer extends SimpleServer {
@Override
public void start(ServerListener listener) throws IOException {
throw ex;
}
}
ServerImpl server = new ServerImpl(executor, registry, new FailingStartupServer());
try {
server.start();
fail("expected exception");
} catch (IOException e) {
assertSame(ex, e);
}
}
@Test
public void basicExchangeSuccessful() throws Exception {
final Metadata.Key<Integer> metadataKey
= Metadata.Key.of("inception", Metadata.INTEGER_MARSHALLER);
final AtomicReference<ServerCall<Integer>> callReference
= new AtomicReference<ServerCall<Integer>>();
registry.addService(ServerServiceDefinition.builder("Waiter")
.addMethod(
MethodDescriptor.create(
MethodType.UNKNOWN, "Waiter", "serve", STRING_MARSHALLER, INTEGER_MARSHALLER),
new ServerCallHandler<String, Integer>() {
@Override
public ServerCall.Listener<String> startCall(
MethodDescriptor<String, Integer> method,
ServerCall<Integer> call,
Metadata.Headers headers) {
assertEquals("Waiter/serve", method.getFullMethodName());
assertNotNull(call);
assertNotNull(headers);
assertEquals(0, headers.get(metadataKey).intValue());
callReference.set(call);
return callListener;
}
}).build());
ServerTransportListener transportListener
= transportServer.registerNewServerTransport(new SimpleServerTransport());
Metadata.Headers headers = new Metadata.Headers();
headers.put(metadataKey, 0);
ServerStreamListener streamListener
= transportListener.streamCreated(stream, "Waiter/serve", headers);
assertNotNull(streamListener);
executeBarrier(executor).await();
ServerCall<Integer> call = callReference.get();
assertNotNull(call);
String order = "Lots of pizza, please";
streamListener.messageRead(STRING_MARSHALLER.stream(order));
verify(callListener, timeout(2000)).onMessage(order);
call.sendMessage(314);
ArgumentCaptor<InputStream> inputCaptor = ArgumentCaptor.forClass(InputStream.class);
verify(stream).writeMessage(inputCaptor.capture());
verify(stream).flush();
assertEquals(314, INTEGER_MARSHALLER.parse(inputCaptor.getValue()).intValue());
streamListener.halfClosed(); // All full; no dessert.
executeBarrier(executor).await();
verify(callListener).onHalfClose();
call.sendMessage(50);
verify(stream, times(2)).writeMessage(inputCaptor.capture());
verify(stream, times(2)).flush();
assertEquals(50, INTEGER_MARSHALLER.parse(inputCaptor.getValue()).intValue());
Metadata trailers = new Metadata();
trailers.put(metadataKey, 3);
Status status = Status.OK.withDescription("A okay");
call.close(status, trailers);
verify(stream).close(status, trailers);
streamListener.closed(Status.OK);
executeBarrier(executor).await();
verify(callListener).onComplete();
verifyNoMoreInteractions(stream);
verifyNoMoreInteractions(callListener);
}
@Test
public void exceptionInStartCallPropagatesToStream() throws Exception {
CyclicBarrier barrier = executeBarrier(executor);
final Status status = Status.ABORTED.withDescription("Oh, no!");
registry.addService(ServerServiceDefinition.builder("Waiter")
.addMethod(
MethodDescriptor.create(MethodType.UNKNOWN, "Waiter", "serve",
STRING_MARSHALLER, INTEGER_MARSHALLER),
new ServerCallHandler<String, Integer>() {
@Override
public ServerCall.Listener<String> startCall(
MethodDescriptor<String, Integer> method,
ServerCall<Integer> call,
Metadata.Headers headers) {
throw status.asRuntimeException();
}
}).build());
ServerTransportListener transportListener
= transportServer.registerNewServerTransport(new SimpleServerTransport());
ServerStreamListener streamListener
= transportListener.streamCreated(stream, "Waiter/serve", new Metadata.Headers());
assertNotNull(streamListener);
verifyNoMoreInteractions(stream);
barrier.await();
executeBarrier(executor).await();
verify(stream).close(same(status), notNull(Metadata.class));
verifyNoMoreInteractions(stream);
}
@Test
public void testNoDeadlockOnShutdown() throws Exception {
final Object lock = new Object();
final CyclicBarrier barrier = new CyclicBarrier(2);
class MaybeDeadlockingServer extends SimpleServer {
@Override
public void shutdown() {
// To deadlock, a lock would need to be held while this method is in progress.
try {
barrier.await();
} catch (Exception ex) {
throw new AssertionError(ex);
}
// If deadlock is possible with this setup, this sychronization completes the loop because
// the serverShutdown needs a lock that Server is holding while calling this method.
synchronized (lock) {
}
}
}
transportServer = new MaybeDeadlockingServer();
ServerImpl server = new ServerImpl(executor, registry, transportServer);
server.start();
new Thread() {
@Override
public void run() {
synchronized (lock) {
try {
barrier.await();
} catch (Exception ex) {
throw new AssertionError(ex);
}
// To deadlock, a lock would be needed for this call to proceed.
transportServer.listener.serverShutdown();
}
}
}.start();
server.shutdown();
}
@Test
public void testNoDeadlockOnTransportShutdown() throws Exception {
final Object lock = new Object();
final CyclicBarrier barrier = new CyclicBarrier(2);
class MaybeDeadlockingServerTransport extends SimpleServerTransport {
@Override
public void shutdown() {
// To deadlock, a lock would need to be held while this method is in progress.
try {
barrier.await();
} catch (Exception ex) {
throw new AssertionError(ex);
}
// If deadlock is possible with this setup, this sychronization completes the loop
// because the transportTerminated needs a lock that Server is holding while calling this
// method.
synchronized (lock) {
}
}
}
final ServerTransportListener transportListener
= transportServer.registerNewServerTransport(new MaybeDeadlockingServerTransport());
new Thread() {
@Override
public void run() {
synchronized (lock) {
try {
barrier.await();
} catch (Exception ex) {
throw new AssertionError(ex);
}
// To deadlock, a lock would be needed for this call to proceed.
transportListener.transportTerminated();
}
}
}.start();
server.shutdown();
}
/**
* Useful for plugging a single-threaded executor from processing tasks, or for waiting until a
* single-threaded executor has processed queued tasks.
*/
private static CyclicBarrier executeBarrier(Executor executor) {
final CyclicBarrier barrier = new CyclicBarrier(2);
executor.execute(new Runnable() {
@Override
public void run() {
try {
barrier.await();
} catch (InterruptedException ex) {
throw new RuntimeException(ex);
} catch (BrokenBarrierException ex) {
throw new RuntimeException(ex);
}
}
});
return barrier;
}
private static class SimpleServer implements io.grpc.internal.Server {
ServerListener listener;
@Override
public void start(ServerListener listener) throws IOException {
this.listener = listener;
}
@Override
public void shutdown() {
listener.serverShutdown();
}
public ServerTransportListener registerNewServerTransport(SimpleServerTransport transport) {
return transport.listener = listener.transportCreated(transport);
}
}
private static class SimpleServerTransport implements ServerTransport {
ServerTransportListener listener;
@Override
public void shutdown() {
listener.transportTerminated();
}
}
}