/
InternalSubchannelTest.java
1319 lines (1158 loc) · 53 KB
/
InternalSubchannelTest.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
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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.truth.Truth.assertThat;
import static io.grpc.ConnectivityState.CONNECTING;
import static io.grpc.ConnectivityState.IDLE;
import static io.grpc.ConnectivityState.READY;
import static io.grpc.ConnectivityState.SHUTDOWN;
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
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.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import com.google.common.collect.Iterables;
import io.grpc.Attributes;
import io.grpc.ConnectivityStateInfo;
import io.grpc.EquivalentAddressGroup;
import io.grpc.InternalChannelz;
import io.grpc.InternalLogId;
import io.grpc.InternalWithLogId;
import io.grpc.Status;
import io.grpc.SynchronizationContext;
import io.grpc.internal.InternalSubchannel.CallTracingTransport;
import io.grpc.internal.InternalSubchannel.Index;
import io.grpc.internal.InternalSubchannel.TransportLogger;
import io.grpc.internal.TestUtils.MockClientTransportInfo;
import java.net.SocketAddress;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.After;
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.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
/**
* Unit tests for {@link InternalSubchannel}.
*/
@RunWith(JUnit4.class)
public class InternalSubchannelTest {
@Rule
public final MockitoRule mocks = MockitoJUnit.rule();
@Rule
public final ExpectedException thrown = ExpectedException.none();
private static final String AUTHORITY = "fakeauthority";
private static final String USER_AGENT = "mosaic";
private static final ConnectivityStateInfo UNAVAILABLE_STATE =
ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE);
private static final ConnectivityStateInfo RESOURCE_EXHAUSTED_STATE =
ConnectivityStateInfo.forTransientFailure(Status.RESOURCE_EXHAUSTED);
private static final Status SHUTDOWN_REASON = Status.UNAVAILABLE.withDescription("for test");
// For scheduled executor
private final FakeClock fakeClock = new FakeClock();
// For syncContext
private final FakeClock fakeExecutor = new FakeClock();
private final SynchronizationContext syncContext = new SynchronizationContext(
new Thread.UncaughtExceptionHandler() {
@Override
public void uncaughtException(Thread t, Throwable e) {
throw new AssertionError(e);
}
});
private final InternalChannelz channelz = new InternalChannelz();
@Mock private BackoffPolicy mockBackoffPolicy1;
@Mock private BackoffPolicy mockBackoffPolicy2;
@Mock private BackoffPolicy mockBackoffPolicy3;
@Mock private BackoffPolicy.Provider mockBackoffPolicyProvider;
@Mock private ClientTransportFactory mockTransportFactory;
private final LinkedList<String> callbackInvokes = new LinkedList<>();
private final InternalSubchannel.Callback mockInternalSubchannelCallback =
new InternalSubchannel.Callback() {
@Override
protected void onTerminated(InternalSubchannel is) {
assertSame(internalSubchannel, is);
callbackInvokes.add("onTerminated");
}
@Override
protected void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) {
assertSame(internalSubchannel, is);
callbackInvokes.add("onStateChange:" + newState);
}
@Override
protected void onInUse(InternalSubchannel is) {
assertSame(internalSubchannel, is);
callbackInvokes.add("onInUse");
}
@Override
protected void onNotInUse(InternalSubchannel is) {
assertSame(internalSubchannel, is);
callbackInvokes.add("onNotInUse");
}
};
private InternalSubchannel internalSubchannel;
private BlockingQueue<MockClientTransportInfo> transports;
@Before public void setUp() {
when(mockBackoffPolicyProvider.get())
.thenReturn(mockBackoffPolicy1, mockBackoffPolicy2, mockBackoffPolicy3);
when(mockBackoffPolicy1.nextBackoffNanos()).thenReturn(10L, 100L);
when(mockBackoffPolicy2.nextBackoffNanos()).thenReturn(10L, 100L);
when(mockBackoffPolicy3.nextBackoffNanos()).thenReturn(10L, 100L);
transports = TestUtils.captureTransports(mockTransportFactory);
}
@After public void noMorePendingTasks() {
assertEquals(0, fakeClock.numPendingTasks());
assertEquals(0, fakeExecutor.numPendingTasks());
}
@Test(expected = IllegalArgumentException.class)
public void constructor_emptyEagList_throws() {
createInternalSubchannel(new EquivalentAddressGroup[0]);
}
@Test(expected = NullPointerException.class)
public void constructor_eagListWithNull_throws() {
createInternalSubchannel(new EquivalentAddressGroup[] {null});
}
@Test public void eagAttribute_propagatesToTransport() {
SocketAddress addr = new SocketAddress() {};
Attributes attr = Attributes.newBuilder().set(Attributes.Key.create("some-key"), "1").build();
createInternalSubchannel(new EquivalentAddressGroup(Arrays.asList(addr), attr));
// First attempt
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory).newClientTransport(
eq(addr),
eq(createClientTransportOptions().setEagAttributes(attr)),
isA(TransportLogger.class));
}
@Test public void eagAuthorityOverride_propagatesToTransport() {
SocketAddress addr = new SocketAddress() {};
String overriddenAuthority = "authority-override";
Attributes attr = Attributes.newBuilder()
.set(EquivalentAddressGroup.ATTR_AUTHORITY_OVERRIDE, overriddenAuthority).build();
createInternalSubchannel(new EquivalentAddressGroup(Arrays.asList(addr), attr));
// First attempt
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory).newClientTransport(
eq(addr),
eq(createClientTransportOptions().setAuthority(overriddenAuthority).setEagAttributes(attr)),
isA(TransportLogger.class));
}
@Test public void singleAddressReconnect() {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
assertEquals(IDLE, internalSubchannel.getState());
// Invocation counters
int transportsCreated = 0;
int backoff1Consulted = 0;
int backoff2Consulted = 0;
int backoffReset = 0;
// First attempt
assertEquals(IDLE, internalSubchannel.getState());
assertNoCallbackInvoke();
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one. Because there is only one address to try, enter TRANSIENT_FAILURE.
assertNoCallbackInvoke();
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
// Backoff reset and using first back-off value interval
verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicyProvider, times(++backoffReset)).get();
// Second attempt
// Transport creation doesn't happen until time is due
fakeClock.forwardNanos(9);
assertNull(internalSubchannel.obtainActiveTransport());
verify(mockTransportFactory, times(transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertNoCallbackInvoke();
fakeClock.forwardNanos(1);
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one too
assertNoCallbackInvoke();
// Here we use a different status from the first failure, and verify that it's passed to
// the callback.
transports.poll().listener.transportShutdown(Status.RESOURCE_EXHAUSTED);
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:" + RESOURCE_EXHAUSTED_STATE);
// Second back-off interval
verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
// Third attempt
// Transport creation doesn't happen until time is due
fakeClock.forwardNanos(99);
assertNull(internalSubchannel.obtainActiveTransport());
verify(mockTransportFactory, times(transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertNoCallbackInvoke();
fakeClock.forwardNanos(1);
assertEquals(CONNECTING, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertNull(internalSubchannel.obtainActiveTransport());
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Let this one succeed, will enter READY state.
assertNoCallbackInvoke();
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
assertEquals(READY, internalSubchannel.getState());
assertSame(
transports.peek().transport,
((CallTracingTransport) internalSubchannel.obtainActiveTransport()).delegate());
// Close the READY transport, will enter IDLE state.
assertNoCallbackInvoke();
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(IDLE, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:IDLE");
// Back-off is reset, and the next attempt will happen immediately
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(CONNECTING, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Final checks for consultations on back-off policies
verify(mockBackoffPolicy1, times(backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicy2, times(backoff2Consulted)).nextBackoffNanos();
}
@Test public void twoAddressesReconnect() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
createInternalSubchannel(addr1, addr2);
assertEquals(IDLE, internalSubchannel.getState());
// Invocation counters
int transportsAddr1 = 0;
int transportsAddr2 = 0;
int backoff1Consulted = 0;
int backoff2Consulted = 0;
int backoff3Consulted = 0;
int backoffReset = 0;
// First attempt
assertNoCallbackInvoke();
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Let this one fail without success
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
// Still in CONNECTING
assertNull(internalSubchannel.obtainActiveTransport());
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
// Second attempt will start immediately. Still no back-off policy.
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
verify(mockTransportFactory, times(++transportsAddr2))
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertNull(internalSubchannel.obtainActiveTransport());
// Fail this one too
assertNoCallbackInvoke();
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
// All addresses have failed. Delayed transport will be in back-off interval.
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
// Backoff reset and first back-off interval begins
verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicyProvider, times(++backoffReset)).get();
// No reconnect during TRANSIENT_FAILURE even when requested.
assertNull(internalSubchannel.obtainActiveTransport());
assertNoCallbackInvoke();
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
// Third attempt is the first address, thus controlled by the first back-off interval.
fakeClock.forwardNanos(9);
verify(mockTransportFactory, times(transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertNoCallbackInvoke();
fakeClock.forwardNanos(1);
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one too
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Forth attempt will start immediately. Keep back-off policy.
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
verify(mockTransportFactory, times(++transportsAddr2))
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one too
assertNoCallbackInvoke();
transports.poll().listener.transportShutdown(Status.RESOURCE_EXHAUSTED);
// All addresses have failed again. Delayed transport will be in back-off interval.
assertExactCallbackInvokes("onStateChange:" + RESOURCE_EXHAUSTED_STATE);
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
// Second back-off interval begins
verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
// Fifth attempt for the first address, thus controlled by the second back-off interval.
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
fakeClock.forwardNanos(99);
verify(mockTransportFactory, times(transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertNoCallbackInvoke();
fakeClock.forwardNanos(1);
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Let it through
assertNoCallbackInvoke();
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
assertEquals(READY, internalSubchannel.getState());
assertSame(
transports.peek().transport,
((CallTracingTransport) internalSubchannel.obtainActiveTransport()).delegate());
// Then close it.
assertNoCallbackInvoke();
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:IDLE");
assertEquals(IDLE, internalSubchannel.getState());
// First attempt after a successful connection. Old back-off policy should be ignored, but there
// is not yet a need for a new one. Start from the first address.
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(CONNECTING, internalSubchannel.getState());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
verify(mockTransportFactory, times(++transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail the transport
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Second attempt will start immediately. Still no new back-off policy.
verify(mockBackoffPolicyProvider, times(backoffReset)).get();
verify(mockTransportFactory, times(++transportsAddr2))
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one too
assertEquals(CONNECTING, internalSubchannel.getState());
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
// All addresses have failed. Enter TRANSIENT_FAILURE. Back-off in effect.
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
// Back-off reset and first back-off interval begins
verify(mockBackoffPolicy2, times(++backoff2Consulted)).nextBackoffNanos();
verify(mockBackoffPolicyProvider, times(++backoffReset)).get();
// Third attempt is the first address, thus controlled by the first back-off interval.
fakeClock.forwardNanos(9);
verify(mockTransportFactory, times(transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
assertNoCallbackInvoke();
fakeClock.forwardNanos(1);
assertExactCallbackInvokes("onStateChange:CONNECTING");
assertEquals(CONNECTING, internalSubchannel.getState());
verify(mockTransportFactory, times(++transportsAddr1))
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Final checks on invocations on back-off policies
verify(mockBackoffPolicy1, times(backoff1Consulted)).nextBackoffNanos();
verify(mockBackoffPolicy2, times(backoff2Consulted)).nextBackoffNanos();
verify(mockBackoffPolicy3, times(backoff3Consulted)).nextBackoffNanos();
}
@Test
public void updateAddresses_emptyEagList_throws() {
SocketAddress addr = new FakeSocketAddress();
createInternalSubchannel(addr);
thrown.expect(IllegalArgumentException.class);
internalSubchannel.updateAddresses(Arrays.<EquivalentAddressGroup>asList());
}
@Test
public void updateAddresses_eagListWithNull_throws() {
SocketAddress addr = new FakeSocketAddress();
createInternalSubchannel(addr);
List<EquivalentAddressGroup> eags = Arrays.asList((EquivalentAddressGroup) null);
thrown.expect(NullPointerException.class);
internalSubchannel.updateAddresses(eags);
}
@Test public void updateAddresses_intersecting_ready() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
SocketAddress addr3 = mock(SocketAddress.class);
createInternalSubchannel(addr1, addr2);
assertEquals(IDLE, internalSubchannel.getState());
// First address fails
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Second address connects
verify(mockTransportFactory)
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
assertEquals(READY, internalSubchannel.getState());
// Update addresses
internalSubchannel.updateAddresses(
Arrays.asList(new EquivalentAddressGroup(Arrays.asList(addr2, addr3))));
assertNoCallbackInvoke();
assertEquals(READY, internalSubchannel.getState());
verify(transports.peek().transport, never()).shutdown(any(Status.class));
verify(transports.peek().transport, never()).shutdownNow(any(Status.class));
// And new addresses chosen when re-connecting
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:IDLE");
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(0, fakeClock.numPendingTasks());
verify(mockTransportFactory, times(2))
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verify(mockTransportFactory)
.newClientTransport(
eq(addr3),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verifyNoMoreInteractions(mockTransportFactory);
fakeClock.forwardNanos(10); // Drain retry, but don't care about result
}
@Test public void updateAddresses_intersecting_connecting() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
SocketAddress addr3 = mock(SocketAddress.class);
createInternalSubchannel(addr1, addr2);
assertEquals(IDLE, internalSubchannel.getState());
// First address fails
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Second address connecting
verify(mockTransportFactory)
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
// Update addresses
internalSubchannel.updateAddresses(
Arrays.asList(new EquivalentAddressGroup(Arrays.asList(addr2, addr3))));
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
verify(transports.peek().transport, never()).shutdown(any(Status.class));
verify(transports.peek().transport, never()).shutdownNow(any(Status.class));
// And new addresses chosen when re-connecting
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:IDLE");
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(0, fakeClock.numPendingTasks());
verify(mockTransportFactory, times(2))
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verify(mockTransportFactory)
.newClientTransport(
eq(addr3),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verifyNoMoreInteractions(mockTransportFactory);
fakeClock.forwardNanos(10); // Drain retry, but don't care about result
}
@Test public void updateAddresses_disjoint_idle() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
createInternalSubchannel(addr1);
internalSubchannel.updateAddresses(Arrays.asList(new EquivalentAddressGroup(addr2)));
// Nothing happened on address update
verify(mockTransportFactory, never())
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
verify(mockTransportFactory, never())
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
verifyNoMoreInteractions(mockTransportFactory);
assertNoCallbackInvoke();
assertEquals(IDLE, internalSubchannel.getState());
// But new address chosen when connecting
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// And no other addresses attempted
assertEquals(0, fakeClock.numPendingTasks());
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
assertEquals(TRANSIENT_FAILURE, internalSubchannel.getState());
verifyNoMoreInteractions(mockTransportFactory);
fakeClock.forwardNanos(10); // Drain retry, but don't care about result
}
@Test public void updateAddresses_disjoint_ready() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
SocketAddress addr3 = mock(SocketAddress.class);
SocketAddress addr4 = mock(SocketAddress.class);
createInternalSubchannel(addr1, addr2);
assertEquals(IDLE, internalSubchannel.getState());
// First address fails
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Second address connects
verify(mockTransportFactory)
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
assertEquals(READY, internalSubchannel.getState());
// Update addresses
internalSubchannel.updateAddresses(
Arrays.asList(new EquivalentAddressGroup(Arrays.asList(addr3, addr4))));
assertExactCallbackInvokes("onStateChange:IDLE");
assertEquals(IDLE, internalSubchannel.getState());
verify(transports.peek().transport).shutdown(any(Status.class));
// And new addresses chosen when re-connecting
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertNoCallbackInvoke();
assertEquals(IDLE, internalSubchannel.getState());
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(0, fakeClock.numPendingTasks());
verify(mockTransportFactory)
.newClientTransport(
eq(addr3),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verify(mockTransportFactory)
.newClientTransport(
eq(addr4),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verifyNoMoreInteractions(mockTransportFactory);
fakeClock.forwardNanos(10); // Drain retry, but don't care about result
}
@Test public void updateAddresses_disjoint_connecting() {
SocketAddress addr1 = mock(SocketAddress.class);
SocketAddress addr2 = mock(SocketAddress.class);
SocketAddress addr3 = mock(SocketAddress.class);
SocketAddress addr4 = mock(SocketAddress.class);
createInternalSubchannel(addr1, addr2);
assertEquals(IDLE, internalSubchannel.getState());
// First address fails
assertNull(internalSubchannel.obtainActiveTransport());
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr1),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertEquals(CONNECTING, internalSubchannel.getState());
// Second address connecting
verify(mockTransportFactory)
.newClientTransport(
eq(addr2),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
// Update addresses
internalSubchannel.updateAddresses(
Arrays.asList(new EquivalentAddressGroup(Arrays.asList(addr3, addr4))));
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
// And new addresses chosen immediately
verify(transports.poll().transport).shutdown(any(Status.class));
assertNoCallbackInvoke();
assertEquals(CONNECTING, internalSubchannel.getState());
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(0, fakeClock.numPendingTasks());
verify(mockTransportFactory)
.newClientTransport(
eq(addr3),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verify(mockTransportFactory)
.newClientTransport(
eq(addr4),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
verifyNoMoreInteractions(mockTransportFactory);
fakeClock.forwardNanos(10); // Drain retry, but don't care about result
}
@Test
public void connectIsLazy() {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
// Invocation counters
int transportsCreated = 0;
// Won't connect until requested
verify(mockTransportFactory, times(transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// First attempt
internalSubchannel.obtainActiveTransport();
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
// Will always reconnect after back-off
fakeClock.forwardNanos(10);
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Make this one proceed
transports.peek().listener.transportReady();
assertExactCallbackInvokes("onStateChange:READY");
// Then go-away
transports.poll().listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:IDLE");
// No scheduled tasks that would ever try to reconnect ...
assertEquals(0, fakeClock.numPendingTasks());
assertEquals(0, fakeExecutor.numPendingTasks());
// ... until it's requested.
internalSubchannel.obtainActiveTransport();
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory, times(++transportsCreated))
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
}
@Test
public void shutdownWhenReady() throws Exception {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
internalSubchannel.obtainActiveTransport();
MockClientTransportInfo transportInfo = transports.poll();
transportInfo.listener.transportReady();
assertExactCallbackInvokes("onStateChange:CONNECTING", "onStateChange:READY");
internalSubchannel.shutdown(SHUTDOWN_REASON);
verify(transportInfo.transport).shutdown(same(SHUTDOWN_REASON));
assertExactCallbackInvokes("onStateChange:SHUTDOWN");
transportInfo.listener.transportShutdown(SHUTDOWN_REASON);
transportInfo.listener.transportTerminated();
assertExactCallbackInvokes("onTerminated");
verify(transportInfo.transport, never()).shutdownNow(any(Status.class));
}
@Test
public void shutdownBeforeTransportCreated() throws Exception {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
// First transport is created immediately
internalSubchannel.obtainActiveTransport();
assertExactCallbackInvokes("onStateChange:CONNECTING");
verify(mockTransportFactory)
.newClientTransport(
eq(addr),
eq(createClientTransportOptions()),
isA(TransportLogger.class));
// Fail this one
MockClientTransportInfo transportInfo = transports.poll();
transportInfo.listener.transportShutdown(Status.UNAVAILABLE);
transportInfo.listener.transportTerminated();
// Entering TRANSIENT_FAILURE, waiting for back-off
assertExactCallbackInvokes("onStateChange:" + UNAVAILABLE_STATE);
// Save the reconnectTask before shutting down
FakeClock.ScheduledTask reconnectTask = null;
for (FakeClock.ScheduledTask task : fakeClock.getPendingTasks()) {
if (task.command.toString().contains("EndOfCurrentBackoff")) {
assertNull("There shouldn't be more than one reconnectTask", reconnectTask);
assertFalse(task.isDone());
reconnectTask = task;
}
}
assertNotNull("There should be at least one reconnectTask", reconnectTask);
// Shut down InternalSubchannel before the transport is created.
internalSubchannel.shutdown(SHUTDOWN_REASON);
assertTrue(reconnectTask.isCancelled());
// InternalSubchannel terminated promptly.
assertExactCallbackInvokes("onStateChange:SHUTDOWN", "onTerminated");
// Simulate a race between reconnectTask cancellation and execution -- the task runs anyway.
// This should not lead to the creation of a new transport.
reconnectTask.command.run();
// Futher call to obtainActiveTransport() is no-op.
assertNull(internalSubchannel.obtainActiveTransport());
assertEquals(SHUTDOWN, internalSubchannel.getState());
assertNoCallbackInvoke();
// No more transports will be created.
fakeClock.forwardNanos(10000);
assertEquals(SHUTDOWN, internalSubchannel.getState());
verifyNoMoreInteractions(mockTransportFactory);
assertEquals(0, transports.size());
assertNoCallbackInvoke();
}
@Test
public void shutdownBeforeTransportReady() throws Exception {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
internalSubchannel.obtainActiveTransport();
assertExactCallbackInvokes("onStateChange:CONNECTING");
MockClientTransportInfo transportInfo = transports.poll();
// Shutdown the InternalSubchannel before the pending transport is ready
assertNull(internalSubchannel.obtainActiveTransport());
internalSubchannel.shutdown(SHUTDOWN_REASON);
assertExactCallbackInvokes("onStateChange:SHUTDOWN");
// The transport should've been shut down even though it's not the active transport yet.
verify(transportInfo.transport).shutdown(same(SHUTDOWN_REASON));
transportInfo.listener.transportShutdown(Status.UNAVAILABLE);
assertNoCallbackInvoke();
transportInfo.listener.transportTerminated();
assertExactCallbackInvokes("onTerminated");
assertEquals(SHUTDOWN, internalSubchannel.getState());
}
@Test
public void shutdownNow() throws Exception {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
internalSubchannel.obtainActiveTransport();
MockClientTransportInfo t1 = transports.poll();
t1.listener.transportReady();
assertExactCallbackInvokes("onStateChange:CONNECTING", "onStateChange:READY");
t1.listener.transportShutdown(Status.UNAVAILABLE);
assertExactCallbackInvokes("onStateChange:IDLE");
internalSubchannel.obtainActiveTransport();
assertExactCallbackInvokes("onStateChange:CONNECTING");
MockClientTransportInfo t2 = transports.poll();
Status status = Status.UNAVAILABLE.withDescription("Requested");
internalSubchannel.shutdownNow(status);
verify(t1.transport).shutdownNow(same(status));
verify(t2.transport).shutdownNow(same(status));
assertExactCallbackInvokes("onStateChange:SHUTDOWN");
}
@Test
public void obtainTransportAfterShutdown() throws Exception {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
internalSubchannel.shutdown(SHUTDOWN_REASON);
assertExactCallbackInvokes("onStateChange:SHUTDOWN", "onTerminated");
assertEquals(SHUTDOWN, internalSubchannel.getState());
assertNull(internalSubchannel.obtainActiveTransport());
verify(mockTransportFactory, times(0))
.newClientTransport(
addr,
createClientTransportOptions(),
internalSubchannel.getChannelLogger());
assertNoCallbackInvoke();
assertEquals(SHUTDOWN, internalSubchannel.getState());
}
@Test
public void logId() {
createInternalSubchannel(mock(SocketAddress.class));
assertNotNull(internalSubchannel.getLogId());
}
@Test
public void inUseState() {
SocketAddress addr = mock(SocketAddress.class);
createInternalSubchannel(addr);
internalSubchannel.obtainActiveTransport();
MockClientTransportInfo t0 = transports.poll();
t0.listener.transportReady();