/
NettyClientTransportTest.java
974 lines (838 loc) · 36.2 KB
/
NettyClientTransportTest.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
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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
/*
* Copyright 2014 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.netty;
import static com.google.common.base.Charsets.UTF_8;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.TruthJUnit.assume;
import static io.grpc.internal.GrpcUtil.DEFAULT_MAX_MESSAGE_SIZE;
import static io.grpc.internal.GrpcUtil.DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS;
import static io.grpc.internal.GrpcUtil.DEFAULT_SERVER_KEEPALIVE_TIME_NANOS;
import static io.grpc.internal.GrpcUtil.KEEPALIVE_TIME_NANOS_DISABLED;
import static io.grpc.internal.GrpcUtil.USER_AGENT_KEY;
import static io.grpc.netty.NettyServerBuilder.MAX_CONNECTION_AGE_GRACE_NANOS_INFINITE;
import static io.grpc.netty.NettyServerBuilder.MAX_CONNECTION_AGE_NANOS_DISABLED;
import static io.grpc.netty.NettyServerBuilder.MAX_CONNECTION_IDLE_NANOS_DISABLED;
import static io.netty.handler.codec.http2.Http2CodecUtil.DEFAULT_WINDOW_SIZE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import com.google.common.io.ByteStreams;
import com.google.common.util.concurrent.SettableFuture;
import io.grpc.Attributes;
import io.grpc.CallOptions;
import io.grpc.ChannelLogger;
import io.grpc.Grpc;
import io.grpc.InternalChannelz;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.MethodDescriptor.Marshaller;
import io.grpc.ServerStreamTracer;
import io.grpc.Status;
import io.grpc.Status.Code;
import io.grpc.StatusException;
import io.grpc.internal.ClientStream;
import io.grpc.internal.ClientStreamListener;
import io.grpc.internal.ClientTransport;
import io.grpc.internal.FakeClock;
import io.grpc.internal.FixedObjectPool;
import io.grpc.internal.GrpcUtil;
import io.grpc.internal.ManagedClientTransport;
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 io.grpc.internal.TransportTracer;
import io.grpc.internal.testing.TestUtils;
import io.grpc.netty.NettyChannelBuilder.LocalSocketPicker;
import io.netty.channel.Channel;
import io.netty.channel.ChannelConfig;
import io.netty.channel.ChannelDuplexHandler;
import io.netty.channel.ChannelFactory;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelOption;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.ReflectiveChannelFactory;
import io.netty.channel.local.LocalChannel;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannelConfig;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.http2.StreamBufferingEncoder;
import io.netty.handler.ssl.ClientAuth;
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.SupportedCipherSuiteFilter;
import io.netty.util.AsciiString;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import javax.annotation.Nullable;
import javax.net.ssl.SSLHandshakeException;
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.Mock;
import org.mockito.MockitoAnnotations;
/**
* Tests for {@link NettyClientTransport}.
*/
@RunWith(JUnit4.class)
public class NettyClientTransportTest {
private static final SslContext SSL_CONTEXT = createSslContext();
@Mock
private ManagedClientTransport.Listener clientTransportListener;
private final List<NettyClientTransport> transports = new ArrayList<>();
private final LinkedBlockingQueue<Attributes> serverTransportAttributesList =
new LinkedBlockingQueue<>();
private final NioEventLoopGroup group = new NioEventLoopGroup(1);
private final EchoServerListener serverListener = new EchoServerListener();
private final InternalChannelz channelz = new InternalChannelz();
private Runnable tooManyPingsRunnable = new Runnable() {
// Throwing is useless in this method, because Netty doesn't propagate the exception
@Override public void run() {}
};
private Attributes eagAttributes = Attributes.EMPTY;
private ProtocolNegotiator negotiator = ProtocolNegotiators.serverTls(SSL_CONTEXT);
private InetSocketAddress address;
private String authority;
private NettyServer server;
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
}
@After
public void teardown() throws Exception {
for (NettyClientTransport transport : transports) {
transport.shutdown(Status.UNAVAILABLE);
}
if (server != null) {
server.shutdown();
}
group.shutdownGracefully(0, 10, TimeUnit.SECONDS);
}
@Test
public void testToString() throws Exception {
address = TestUtils.testServerAddress(new InetSocketAddress(12345));
authority = GrpcUtil.authorityFromHostAndPort(address.getHostString(), address.getPort());
String s = newTransport(newNegotiator()).toString();
transports.clear();
assertTrue("Unexpected: " + s, s.contains("NettyClientTransport"));
assertTrue("Unexpected: " + s, s.contains(address.toString()));
}
@Test
public void addDefaultUserAgent() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator());
callMeMaybe(transport.start(clientTransportListener));
// Send a single RPC and wait for the response.
new Rpc(transport).halfClose().waitForResponse();
// Verify that the received headers contained the User-Agent.
assertEquals(1, serverListener.streamListeners.size());
Metadata headers = serverListener.streamListeners.get(0).headers;
assertEquals(GrpcUtil.getGrpcUserAgent("netty", null), headers.get(USER_AGENT_KEY));
}
@Test
public void setSoLingerChannelOption() throws IOException {
startServer();
Map<ChannelOption<?>, Object> channelOptions = new HashMap<>();
// set SO_LINGER option
int soLinger = 123;
channelOptions.put(ChannelOption.SO_LINGER, soLinger);
NettyClientTransport transport = new NettyClientTransport(
address, new ReflectiveChannelFactory<>(NioSocketChannel.class), channelOptions, group,
newNegotiator(), DEFAULT_WINDOW_SIZE, DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, KEEPALIVE_TIME_NANOS_DISABLED, 1L, false, authority,
null /* user agent */, tooManyPingsRunnable, new TransportTracer(), Attributes.EMPTY,
new SocketPicker(), new FakeChannelLogger());
transports.add(transport);
callMeMaybe(transport.start(clientTransportListener));
// verify SO_LINGER has been set
ChannelConfig config = transport.channel().config();
assertTrue(config instanceof SocketChannelConfig);
assertEquals(soLinger, ((SocketChannelConfig) config).getSoLinger());
}
@Test
public void overrideDefaultUserAgent() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator(),
DEFAULT_MAX_MESSAGE_SIZE, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, "testUserAgent", true);
callMeMaybe(transport.start(clientTransportListener));
new Rpc(transport, new Metadata()).halfClose().waitForResponse();
// Verify that the received headers contained the User-Agent.
assertEquals(1, serverListener.streamListeners.size());
Metadata receivedHeaders = serverListener.streamListeners.get(0).headers;
assertEquals(GrpcUtil.getGrpcUserAgent("netty", "testUserAgent"),
receivedHeaders.get(USER_AGENT_KEY));
}
@Test
public void maxMessageSizeShouldBeEnforced() throws Throwable {
startServer();
// Allow the response payloads of up to 1 byte.
NettyClientTransport transport = newTransport(newNegotiator(),
1, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, null, true);
callMeMaybe(transport.start(clientTransportListener));
try {
// Send a single RPC and wait for the response.
new Rpc(transport).halfClose().waitForResponse();
fail("Expected the stream to fail.");
} catch (ExecutionException e) {
Status status = Status.fromThrowable(e);
assertEquals(Code.RESOURCE_EXHAUSTED, status.getCode());
assertTrue("Missing exceeds maximum from: " + status.getDescription(),
status.getDescription().contains("exceeds maximum"));
}
}
/**
* Verifies that we can create multiple TLS client transports from the same builder.
*/
@Test
public void creatingMultipleTlsTransportsShouldSucceed() throws Exception {
startServer();
// Create a couple client transports.
ProtocolNegotiator negotiator = newNegotiator();
for (int index = 0; index < 2; ++index) {
NettyClientTransport transport = newTransport(negotiator);
callMeMaybe(transport.start(clientTransportListener));
}
// Send a single RPC on each transport.
final List<Rpc> rpcs = new ArrayList<>(transports.size());
for (NettyClientTransport transport : transports) {
rpcs.add(new Rpc(transport).halfClose());
}
// Wait for the RPCs to complete.
for (Rpc rpc : rpcs) {
rpc.waitForResponse();
}
}
@Test
public void negotiationFailurePropagatesToStatus() throws Exception {
negotiator = ProtocolNegotiators.serverPlaintext();
startServer();
final NoopProtocolNegotiator negotiator = new NoopProtocolNegotiator();
final NettyClientTransport transport = newTransport(negotiator);
callMeMaybe(transport.start(clientTransportListener));
final Status failureStatus = Status.UNAVAILABLE.withDescription("oh noes!");
transport.channel().eventLoop().execute(new Runnable() {
@Override
public void run() {
negotiator.handler.fail(transport.channel().pipeline().context(negotiator.handler),
failureStatus.asRuntimeException());
}
});
Rpc rpc = new Rpc(transport).halfClose();
try {
rpc.waitForClose();
fail("expected exception");
} catch (ExecutionException ex) {
Status actual = ((StatusException) ex.getCause()).getStatus();
assertSame(failureStatus.getCode(), actual.getCode());
assertThat(actual.getDescription()).contains(failureStatus.getDescription());
}
}
@Test
public void tlsNegotiationFailurePropagatesToStatus() throws Exception {
File serverCert = TestUtils.loadCert("server1.pem");
File serverKey = TestUtils.loadCert("server1.key");
// Don't trust ca.pem, so that client auth fails
SslContext sslContext = GrpcSslContexts.forServer(serverCert, serverKey)
.ciphers(TestUtils.preferredTestCiphers(), SupportedCipherSuiteFilter.INSTANCE)
.clientAuth(ClientAuth.REQUIRE)
.build();
negotiator = ProtocolNegotiators.serverTls(sslContext);
startServer();
File caCert = TestUtils.loadCert("ca.pem");
File clientCert = TestUtils.loadCert("client.pem");
File clientKey = TestUtils.loadCert("client.key");
SslContext clientContext = GrpcSslContexts.forClient()
.trustManager(caCert)
.ciphers(TestUtils.preferredTestCiphers(), SupportedCipherSuiteFilter.INSTANCE)
.keyManager(clientCert, clientKey)
.build();
ProtocolNegotiator negotiator = ProtocolNegotiators.tls(clientContext);
final NettyClientTransport transport = newTransport(negotiator);
callMeMaybe(transport.start(clientTransportListener));
Rpc rpc = new Rpc(transport).halfClose();
try {
rpc.waitForClose();
fail("expected exception");
} catch (ExecutionException ex) {
StatusException sre = (StatusException) ex.getCause();
assertEquals(Status.Code.UNAVAILABLE, sre.getStatus().getCode());
assertThat(sre.getCause()).isInstanceOf(SSLHandshakeException.class);
assertThat(sre.getCause().getMessage()).contains("SSLV3_ALERT_HANDSHAKE_FAILURE");
}
}
@Test
public void channelExceptionDuringNegotiatonPropagatesToStatus() throws Exception {
negotiator = ProtocolNegotiators.serverPlaintext();
startServer();
NoopProtocolNegotiator negotiator = new NoopProtocolNegotiator();
NettyClientTransport transport = newTransport(negotiator);
callMeMaybe(transport.start(clientTransportListener));
final Status failureStatus = Status.UNAVAILABLE.withDescription("oh noes!");
transport.channel().pipeline().fireExceptionCaught(failureStatus.asRuntimeException());
Rpc rpc = new Rpc(transport).halfClose();
try {
rpc.waitForClose();
fail("expected exception");
} catch (ExecutionException ex) {
assertSame(failureStatus, ((StatusException) ex.getCause()).getStatus());
}
}
@Test
public void handlerExceptionDuringNegotiatonPropagatesToStatus() throws Exception {
negotiator = ProtocolNegotiators.serverPlaintext();
startServer();
final NoopProtocolNegotiator negotiator = new NoopProtocolNegotiator();
final NettyClientTransport transport = newTransport(negotiator);
callMeMaybe(transport.start(clientTransportListener));
final Status failureStatus = Status.UNAVAILABLE.withDescription("oh noes!");
transport.channel().eventLoop().execute(new Runnable() {
@Override
public void run() {
try {
negotiator.handler.exceptionCaught(
transport.channel().pipeline().context(negotiator.handler),
failureStatus.asRuntimeException());
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
});
Rpc rpc = new Rpc(transport).halfClose();
try {
rpc.waitForClose();
fail("expected exception");
} catch (ExecutionException ex) {
Status actual = ((StatusException) ex.getCause()).getStatus();
assertSame(failureStatus.getCode(), actual.getCode());
assertThat(actual.getDescription()).contains(failureStatus.getDescription());
}
}
@Test
public void bufferedStreamsShouldBeClosedWhenConnectionTerminates() throws Exception {
// Only allow a single stream active at a time.
startServer(1, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE);
NettyClientTransport transport = newTransport(newNegotiator());
callMeMaybe(transport.start(clientTransportListener));
// Send a dummy RPC in order to ensure that the updated SETTINGS_MAX_CONCURRENT_STREAMS
// has been received by the remote endpoint.
new Rpc(transport).halfClose().waitForResponse();
// Create 3 streams, but don't half-close. The transport will buffer the second and third.
Rpc[] rpcs = new Rpc[] { new Rpc(transport), new Rpc(transport), new Rpc(transport) };
// Wait for the response for the stream that was actually created.
rpcs[0].waitForResponse();
// Now forcibly terminate the connection from the server side.
serverListener.transports.get(0).channel().pipeline().firstContext().close();
// Now wait for both listeners to be closed.
for (int i = 1; i < rpcs.length; i++) {
try {
rpcs[i].waitForClose();
fail("Expected the RPC to fail");
} catch (ExecutionException e) {
// Expected.
Throwable t = getRootCause(e);
// Make sure that the Http2ChannelClosedException got replaced with the real cause of
// the shutdown.
assertFalse(t instanceof StreamBufferingEncoder.Http2ChannelClosedException);
}
}
}
public static class CantConstructChannel extends NioSocketChannel {
/** Constructor. It doesn't work. Feel free to try. But it doesn't work. */
public CantConstructChannel() {
// Use an Error because we've seen cases of channels failing to construct due to classloading
// problems (like mixing different versions of Netty), and those involve Errors.
throw new CantConstructChannelError();
}
}
private static class CantConstructChannelError extends Error {}
@Test
public void failingToConstructChannelShouldFailGracefully() throws Exception {
address = TestUtils.testServerAddress(new InetSocketAddress(12345));
authority = GrpcUtil.authorityFromHostAndPort(address.getHostString(), address.getPort());
NettyClientTransport transport = new NettyClientTransport(
address, new ReflectiveChannelFactory<>(CantConstructChannel.class),
new HashMap<ChannelOption<?>, Object>(), group,
newNegotiator(), DEFAULT_WINDOW_SIZE, DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, KEEPALIVE_TIME_NANOS_DISABLED, 1, false, authority,
null, tooManyPingsRunnable, new TransportTracer(), Attributes.EMPTY, new SocketPicker(),
new FakeChannelLogger());
transports.add(transport);
// Should not throw
callMeMaybe(transport.start(clientTransportListener));
// And RPCs and PINGs should fail cleanly, reporting the failure
Rpc rpc = new Rpc(transport);
try {
rpc.waitForResponse();
fail("Expected exception");
} catch (Exception ex) {
if (!(getRootCause(ex) instanceof CantConstructChannelError)) {
throw new AssertionError("Could not find expected error", ex);
}
}
final SettableFuture<Object> pingResult = SettableFuture.create();
FakeClock clock = new FakeClock();
ClientTransport.PingCallback pingCallback = new ClientTransport.PingCallback() {
@Override
public void onSuccess(long roundTripTimeNanos) {
pingResult.set(roundTripTimeNanos);
}
@Override
public void onFailure(Throwable cause) {
pingResult.setException(cause);
}
};
transport.ping(pingCallback, clock.getScheduledExecutorService());
assertFalse(pingResult.isDone());
clock.runDueTasks();
assertTrue(pingResult.isDone());
try {
pingResult.get();
fail("Expected exception");
} catch (Exception ex) {
if (!(getRootCause(ex) instanceof CantConstructChannelError)) {
throw new AssertionError("Could not find expected error", ex);
}
}
}
@Test
public void channelFactoryShouldSetSocketOptionKeepAlive() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator(),
DEFAULT_MAX_MESSAGE_SIZE, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, "testUserAgent", true,
TimeUnit.SECONDS.toNanos(10L), TimeUnit.SECONDS.toNanos(1L),
new ReflectiveChannelFactory<>(NioSocketChannel.class), group);
callMeMaybe(transport.start(clientTransportListener));
assertThat(transport.channel().config().getOption(ChannelOption.SO_KEEPALIVE))
.isTrue();
}
@Test
public void channelFactoryShouldNNotSetSocketOptionKeepAlive() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator(),
DEFAULT_MAX_MESSAGE_SIZE, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, "testUserAgent", true,
TimeUnit.SECONDS.toNanos(10L), TimeUnit.SECONDS.toNanos(1L),
new ReflectiveChannelFactory<>(LocalChannel.class), group);
callMeMaybe(transport.start(clientTransportListener));
assertThat(transport.channel().config().getOption(ChannelOption.SO_KEEPALIVE))
.isNull();
}
@Test
public void maxHeaderListSizeShouldBeEnforcedOnClient() throws Exception {
startServer();
NettyClientTransport transport =
newTransport(newNegotiator(), DEFAULT_MAX_MESSAGE_SIZE, 1, null, true);
callMeMaybe(transport.start(clientTransportListener));
try {
// Send a single RPC and wait for the response.
new Rpc(transport, new Metadata()).halfClose().waitForResponse();
fail("The stream should have been failed due to client received header exceeds header list"
+ " size limit!");
} catch (Exception e) {
Throwable rootCause = getRootCause(e);
Status status = ((StatusException) rootCause).getStatus();
assertEquals(Status.Code.INTERNAL, status.getCode());
assertEquals("HTTP/2 error code: PROTOCOL_ERROR\nReceived Rst Stream",
status.getDescription());
}
}
@Test
public void maxHeaderListSizeShouldBeEnforcedOnServer() throws Exception {
startServer(100, 1);
NettyClientTransport transport = newTransport(newNegotiator());
callMeMaybe(transport.start(clientTransportListener));
try {
// Send a single RPC and wait for the response.
new Rpc(transport, new Metadata()).halfClose().waitForResponse();
fail("The stream should have been failed due to server received header exceeds header list"
+ " size limit!");
} catch (Exception e) {
Status status = Status.fromThrowable(e);
assertEquals(status.toString(), Status.Code.INTERNAL, status.getCode());
}
}
@Test
public void getAttributes_negotiatorHandler() throws Exception {
address = TestUtils.testServerAddress(new InetSocketAddress(12345));
authority = GrpcUtil.authorityFromHostAndPort(address.getHostString(), address.getPort());
NettyClientTransport transport = newTransport(new NoopProtocolNegotiator());
callMeMaybe(transport.start(clientTransportListener));
assertNotNull(transport.getAttributes());
}
@Test
public void getEagAttributes_negotiatorHandler() throws Exception {
address = TestUtils.testServerAddress(new InetSocketAddress(12345));
authority = GrpcUtil.authorityFromHostAndPort(address.getHostString(), address.getPort());
NoopProtocolNegotiator npn = new NoopProtocolNegotiator();
eagAttributes = Attributes.newBuilder()
.set(Attributes.Key.create("trash"), "value")
.build();
NettyClientTransport transport = newTransport(npn);
callMeMaybe(transport.start(clientTransportListener));
// EAG Attributes are available before the negotiation is complete
assertSame(eagAttributes, npn.grpcHandler.getEagAttributes());
}
@Test
public void clientStreamGetsAttributes() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator());
callMeMaybe(transport.start(clientTransportListener));
Rpc rpc = new Rpc(transport).halfClose();
rpc.waitForResponse();
assertNotNull(rpc.stream.getAttributes().get(Grpc.TRANSPORT_ATTR_SSL_SESSION));
assertEquals(address, rpc.stream.getAttributes().get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR));
Attributes serverTransportAttrs = serverTransportAttributesList.poll(1, TimeUnit.SECONDS);
assertNotNull(serverTransportAttrs);
SocketAddress clientAddr = serverTransportAttrs.get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR);
assertNotNull(clientAddr);
assertEquals(clientAddr, rpc.stream.getAttributes().get(Grpc.TRANSPORT_ATTR_LOCAL_ADDR));
}
@Test
public void keepAliveEnabled() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator(), DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, null /* user agent */, true /* keep alive */);
callMeMaybe(transport.start(clientTransportListener));
Rpc rpc = new Rpc(transport).halfClose();
rpc.waitForResponse();
assertNotNull(transport.keepAliveManager());
}
@Test
public void keepAliveDisabled() throws Exception {
startServer();
NettyClientTransport transport = newTransport(newNegotiator(), DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, null /* user agent */, false /* keep alive */);
callMeMaybe(transport.start(clientTransportListener));
Rpc rpc = new Rpc(transport).halfClose();
rpc.waitForResponse();
assertNull(transport.keepAliveManager());
}
@Test
public void keepAliveEnabled_shouldSetTcpUserTimeout() throws Exception {
assume().that(Utils.isEpollAvailable()).isTrue();
startServer();
EventLoopGroup epollGroup = Utils.DEFAULT_WORKER_EVENT_LOOP_GROUP.create();
int keepAliveTimeMillis = 12345670;
int keepAliveTimeoutMillis = 1234567;
try {
NettyClientTransport transport = newTransport(newNegotiator(), DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, null /* user agent */, true /* keep alive */,
TimeUnit.MILLISECONDS.toNanos(keepAliveTimeMillis),
TimeUnit.MILLISECONDS.toNanos(keepAliveTimeoutMillis),
new ReflectiveChannelFactory<>(Utils.DEFAULT_CLIENT_CHANNEL_TYPE), epollGroup);
callMeMaybe(transport.start(clientTransportListener));
ChannelOption<Integer> tcpUserTimeoutOption = Utils.maybeGetTcpUserTimeoutOption();
assertThat(tcpUserTimeoutOption).isNotNull();
// on some linux based system, the integer value may have error (usually +-1)
assertThat((double) transport.channel().config().getOption(tcpUserTimeoutOption))
.isWithin(5.0).of((double) keepAliveTimeoutMillis);
} finally {
epollGroup.shutdownGracefully();
}
}
@Test
public void keepAliveDisabled_shouldNotSetTcpUserTimeout() throws Exception {
assume().that(Utils.isEpollAvailable()).isTrue();
startServer();
EventLoopGroup epollGroup = Utils.DEFAULT_WORKER_EVENT_LOOP_GROUP.create();
int keepAliveTimeMillis = 12345670;
try {
long keepAliveTimeNanos = TimeUnit.MILLISECONDS.toNanos(keepAliveTimeMillis);
NettyClientTransport transport = newTransport(newNegotiator(), DEFAULT_MAX_MESSAGE_SIZE,
GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE, null /* user agent */, false /* keep alive */,
keepAliveTimeNanos, keepAliveTimeNanos,
new ReflectiveChannelFactory<>(Utils.DEFAULT_CLIENT_CHANNEL_TYPE), epollGroup);
callMeMaybe(transport.start(clientTransportListener));
ChannelOption<Integer> tcpUserTimeoutOption = Utils.maybeGetTcpUserTimeoutOption();
assertThat(tcpUserTimeoutOption).isNotNull();
// default TCP_USER_TIMEOUT=0 (use the system default)
assertThat(transport.channel().config().getOption(tcpUserTimeoutOption)).isEqualTo(0);
} finally {
epollGroup.shutdownGracefully();
}
}
private Throwable getRootCause(Throwable t) {
if (t.getCause() == null) {
return t;
}
return getRootCause(t.getCause());
}
private ProtocolNegotiator newNegotiator() throws IOException {
File caCert = TestUtils.loadCert("ca.pem");
SslContext clientContext = GrpcSslContexts.forClient().trustManager(caCert)
.ciphers(TestUtils.preferredTestCiphers(), SupportedCipherSuiteFilter.INSTANCE).build();
return ProtocolNegotiators.tls(clientContext);
}
private NettyClientTransport newTransport(ProtocolNegotiator negotiator) {
return newTransport(negotiator, DEFAULT_MAX_MESSAGE_SIZE, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE,
null /* user agent */, true /* keep alive */);
}
private NettyClientTransport newTransport(ProtocolNegotiator negotiator, int maxMsgSize,
int maxHeaderListSize, String userAgent, boolean enableKeepAlive) {
return newTransport(negotiator, maxMsgSize, maxHeaderListSize, userAgent, enableKeepAlive,
TimeUnit.SECONDS.toNanos(10L), TimeUnit.SECONDS.toNanos(1L),
new ReflectiveChannelFactory<>(NioSocketChannel.class), group);
}
private NettyClientTransport newTransport(ProtocolNegotiator negotiator, int maxMsgSize,
int maxHeaderListSize, String userAgent, boolean enableKeepAlive, long keepAliveTimeNano,
long keepAliveTimeoutNano, ChannelFactory<? extends Channel> channelFactory,
EventLoopGroup group) {
if (!enableKeepAlive) {
keepAliveTimeNano = KEEPALIVE_TIME_NANOS_DISABLED;
}
NettyClientTransport transport = new NettyClientTransport(
address, channelFactory, new HashMap<ChannelOption<?>, Object>(), group,
negotiator, DEFAULT_WINDOW_SIZE, maxMsgSize, maxHeaderListSize,
keepAliveTimeNano, keepAliveTimeoutNano,
false, authority, userAgent, tooManyPingsRunnable,
new TransportTracer(), eagAttributes, new SocketPicker(), new FakeChannelLogger());
transports.add(transport);
return transport;
}
private void startServer() throws IOException {
startServer(100, GrpcUtil.DEFAULT_MAX_HEADER_LIST_SIZE);
}
private void startServer(int maxStreamsPerConnection, int maxHeaderListSize) throws IOException {
server = new NettyServer(
TestUtils.testServerAddress(new InetSocketAddress(0)),
new ReflectiveChannelFactory<>(NioServerSocketChannel.class),
new HashMap<ChannelOption<?>, Object>(),
new FixedObjectPool<>(group), new FixedObjectPool<>(group), negotiator,
Collections.<ServerStreamTracer.Factory>emptyList(),
TransportTracer.getDefaultFactory(),
maxStreamsPerConnection,
DEFAULT_WINDOW_SIZE, DEFAULT_MAX_MESSAGE_SIZE, maxHeaderListSize,
DEFAULT_SERVER_KEEPALIVE_TIME_NANOS, DEFAULT_SERVER_KEEPALIVE_TIMEOUT_NANOS,
MAX_CONNECTION_IDLE_NANOS_DISABLED,
MAX_CONNECTION_AGE_NANOS_DISABLED, MAX_CONNECTION_AGE_GRACE_NANOS_INFINITE, true, 0,
channelz);
server.start(serverListener);
address = TestUtils.testServerAddress((InetSocketAddress) server.getListenSocketAddress());
authority = GrpcUtil.authorityFromHostAndPort(address.getHostString(), address.getPort());
}
private void callMeMaybe(Runnable r) {
if (r != null) {
r.run();
}
}
private static SslContext createSslContext() {
try {
File serverCert = TestUtils.loadCert("server1.pem");
File key = TestUtils.loadCert("server1.key");
return GrpcSslContexts.forServer(serverCert, key)
.ciphers(TestUtils.preferredTestCiphers(), SupportedCipherSuiteFilter.INSTANCE).build();
} catch (IOException ex) {
throw new RuntimeException(ex);
}
}
private static class Rpc {
static final String MESSAGE = "hello";
static final MethodDescriptor<String, String> METHOD =
MethodDescriptor.<String, String>newBuilder()
.setType(MethodDescriptor.MethodType.UNARY)
.setFullMethodName("testService/test")
.setRequestMarshaller(StringMarshaller.INSTANCE)
.setResponseMarshaller(StringMarshaller.INSTANCE)
.build();
final ClientStream stream;
final TestClientStreamListener listener = new TestClientStreamListener();
Rpc(NettyClientTransport transport) {
this(transport, new Metadata());
}
Rpc(NettyClientTransport transport, Metadata headers) {
stream = transport.newStream(METHOD, headers, CallOptions.DEFAULT);
stream.start(listener);
stream.request(1);
stream.writeMessage(new ByteArrayInputStream(MESSAGE.getBytes(UTF_8)));
stream.flush();
}
Rpc halfClose() {
stream.halfClose();
return this;
}
void waitForResponse() throws InterruptedException, ExecutionException, TimeoutException {
listener.responseFuture.get(10, TimeUnit.SECONDS);
}
void waitForClose() throws InterruptedException, ExecutionException, TimeoutException {
listener.closedFuture.get(10, TimeUnit.SECONDS);
}
}
private static final class TestClientStreamListener implements ClientStreamListener {
final SettableFuture<Void> closedFuture = SettableFuture.create();
final SettableFuture<Void> responseFuture = SettableFuture.create();
@Override
public void headersRead(Metadata headers) {
}
@Override
public void closed(Status status, Metadata trailers) {
closed(status, RpcProgress.PROCESSED, trailers);
}
@Override
public void closed(Status status, RpcProgress rpcProgress, Metadata trailers) {
if (status.isOk()) {
closedFuture.set(null);
} else {
StatusException e = status.asException();
closedFuture.setException(e);
responseFuture.setException(e);
}
}
@Override
public void messagesAvailable(MessageProducer producer) {
if (producer.next() != null) {
responseFuture.set(null);
}
}
@Override
public void onReady() {
}
}
private static final class EchoServerStreamListener implements ServerStreamListener {
final ServerStream stream;
final String method;
final Metadata headers;
EchoServerStreamListener(ServerStream stream, String method, Metadata headers) {
this.stream = stream;
this.method = method;
this.headers = headers;
}
@Override
public void messagesAvailable(MessageProducer producer) {
InputStream message;
while ((message = producer.next()) != null) {
// Just echo back the message.
stream.writeMessage(message);
stream.flush();
}
}
@Override
public void onReady() {
}
@Override
public void halfClosed() {
// Just close when the client closes.
stream.close(Status.OK, new Metadata());
}
@Override
public void closed(Status status) {
}
}
private final class EchoServerListener implements ServerListener {
final List<NettyServerTransport> transports = new ArrayList<>();
final List<EchoServerStreamListener> streamListeners =
Collections.synchronizedList(new ArrayList<EchoServerStreamListener>());
@Override
public ServerTransportListener transportCreated(final ServerTransport transport) {
transports.add((NettyServerTransport) transport);
return new ServerTransportListener() {
@Override
public void streamCreated(ServerStream stream, String method, Metadata headers) {
EchoServerStreamListener listener = new EchoServerStreamListener(stream, method, headers);
stream.setListener(listener);
stream.writeHeaders(new Metadata());
stream.request(1);
streamListeners.add(listener);
}
@Override
public Attributes transportReady(Attributes transportAttrs) {
serverTransportAttributesList.add(transportAttrs);
return transportAttrs;
}
@Override
public void transportTerminated() {}
};
}
@Override
public void serverShutdown() {
}
}
private static final class StringMarshaller implements Marshaller<String> {
static final StringMarshaller INSTANCE = new StringMarshaller();
@Override
public InputStream stream(String value) {
return new ByteArrayInputStream(value.getBytes(UTF_8));
}
@Override
public String parse(InputStream stream) {
try {
return new String(ByteStreams.toByteArray(stream), UTF_8);
} catch (IOException ex) {
throw new RuntimeException(ex);
}
}
}
private static class NoopHandler extends ChannelDuplexHandler {
private final GrpcHttp2ConnectionHandler grpcHandler;
public NoopHandler(GrpcHttp2ConnectionHandler grpcHandler) {
this.grpcHandler = grpcHandler;
}
@Override
public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
ctx.pipeline().addBefore(ctx.name(), null, grpcHandler);
}
public void fail(ChannelHandlerContext ctx, Throwable cause) {
ctx.fireExceptionCaught(cause);
}
}
private static class NoopProtocolNegotiator implements ProtocolNegotiator {
GrpcHttp2ConnectionHandler grpcHandler;
NoopHandler handler;
@Override
public ChannelHandler newHandler(final GrpcHttp2ConnectionHandler grpcHandler) {
this.grpcHandler = grpcHandler;
return handler = new NoopHandler(grpcHandler);
}
@Override
public AsciiString scheme() {
return Utils.HTTP;
}
@Override
public void close() {}
}
private static final class SocketPicker extends LocalSocketPicker {
@Nullable
@Override
public SocketAddress createSocketAddress(SocketAddress remoteAddress, Attributes attrs) {
return null;
}
}
private static final class FakeChannelLogger extends ChannelLogger {
@Override
public void log(ChannelLogLevel level, String message) {}
@Override
public void log(ChannelLogLevel level, String messageFormat, Object... args) {}
}
}