Repository navigation
Expand file tree
/
Copy pathengine_test.go
More file actions
1647 lines (1583 loc) · 47.3 KB
/
Copy pathengine_test.go
File metadata and controls
1647 lines (1583 loc) · 47.3 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
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
//go:build linux || darwin || dragonfly || freebsd || netbsd || openbsd || windows
package core
import (
"bytes"
"errors"
"fmt"
"io"
"net"
"os"
"path/filepath"
"runtime"
"strconv"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/lesismal/fib/taskpool"
)
func TestConcurrentBackpressuredEcho(t *testing.T) {
for _, useWritev := range []bool{false, true} {
t.Run(map[bool]string{false: "write", true: "writev"}[useWritev], func(t *testing.T) {
config := DefaultConfig()
config.UseWritev = useWritev
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}()
var wg sync.WaitGroup
for i := 0; i < 16; i++ {
wg.Add(1)
go func(value byte) {
defer wg.Done()
payload := bytes.Repeat([]byte{value}, 1024*1024)
conn, err := net.DialTimeout("tcp4", addr.String(), 5*time.Second)
if err != nil {
t.Error(err)
return
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(15 * time.Second))
if _, err = conn.Write(payload); err != nil {
t.Error(err)
return
}
received := make([]byte, len(payload))
if _, err = io.ReadFull(conn, received); err != nil {
t.Error(err)
return
}
if !bytes.Equal(received, payload) {
t.Error("echo mismatch")
}
}(byte(i))
}
wg.Wait()
})
}
}
// TestStopRefusesNewConnections checks that a client connecting to an engine
// that has stopped is refused at once, as it is by a net/http server that
// has shut down, rather than accepted into a backlog nothing serves until
// Close, and that the engine still reports the address it listened on.
func TestStopRefusesNewConnections(t *testing.T) {
for _, pollers := range []int{0, 2} {
config := DefaultConfig()
config.IOPollers = pollers > 0
config.IOPollerCount = pollers
engine, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{Data: func(c *Connection, b []byte) { _, _ = c.Write(b) }}})
if err != nil {
t.Fatal(err)
}
addr, err := engine.LocalAddr()
if err != nil {
t.Fatal(err)
}
done := make(chan error, 1)
go func() { done <- engine.Run() }()
if c, err := net.DialTimeout("tcp", addr.String(), time.Second); err != nil {
t.Fatalf("pollers %d: before Stop: %v", pollers, err)
} else {
_ = c.Close()
}
engine.Stop()
if err := <-done; err != nil {
t.Fatalf("pollers %d: Run: %v", pollers, err)
}
if after, err := engine.LocalAddr(); err != nil || after.String() != addr.String() {
t.Errorf("pollers %d: LocalAddr after Stop = %v, %v; want %v", pollers, after, err, addr)
}
if c, err := net.DialTimeout("tcp", addr.String(), time.Second); err == nil {
_ = c.Close()
t.Errorf("pollers %d: a connection was taken after Stop", pollers)
}
if err := engine.Close(); err != nil {
t.Errorf("pollers %d: Close: %v", pollers, err)
}
}
}
func TestOnCloseReportsPeerEOF(t *testing.T) {
closed := make(chan error, 1)
config := DefaultConfig()
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{Close: func(_ *Connection, err error) { closed <- err }}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
conn, err := net.DialTimeout("tcp4", addr.String(), 5*time.Second)
if err != nil {
t.Fatal(err)
}
if err := conn.Close(); err != nil {
t.Fatal(err)
}
select {
case err := <-closed:
if err != io.EOF {
t.Fatalf("OnClose error = %v, want io.EOF", err)
}
case <-time.After(5 * time.Second):
t.Fatal("timed out waiting for OnClose")
}
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}
// TestReadsDeferredWhileOutputQueued covers the flush-before-read ordering in
// process: without a watermark, while Send output is still queued the worker
// must not read, and the deferred readiness must survive until the queue
// drains so the socket does not turn into a zombie with unread bytes and no
// further edge.
func TestReadsDeferredWhileOutputQueued(t *testing.T) {
for _, halfClose := range []bool{false, true} {
t.Run(map[bool]string{false: "open", true: "halfclose"}[halfClose], func(t *testing.T) {
payload := bytes.Repeat([]byte{0xAB}, 32*1024*1024)
second := make(chan []byte, 1)
closed := make(chan error, 1)
config := DefaultConfig()
// Disable the watermark so epoll keeps EPOLLIN registered and only
// the process ordering stands between queued output and a read.
config.WriteBufferHighWatermark = -1
var first sync.Once
var sender atomic.Pointer[Connection]
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{
Data: func(c *Connection, data []byte) {
started := false
first.Do(func() {
started = true
sender.Store(c)
// Send in chunks: Windows accepts one send of any size
// while its send backlog is below SO_SNDBUF, so a single
// call could leave nothing queued. Later chunks queue
// once the backlog is full, on every platform.
for offset := 0; offset < len(payload); offset += 1 << 20 {
if err := c.SendOwned(payload[offset : offset+1<<20]); err != nil {
t.Error(err)
return
}
}
})
if !started {
second <- append([]byte(nil), data...)
}
},
Close: func(_ *Connection, err error) { closed <- err },
}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}()
conn, err := net.DialTCP("tcp4", nil, addr)
if err != nil {
t.Fatal(err)
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(30 * time.Second))
if _, err := conn.Write([]byte("start")); err != nil {
t.Fatal(err)
}
// Let the server block on the peer's full receive window before
// the second message arrives.
time.Sleep(300 * time.Millisecond)
if c := sender.Load(); c == nil || !c.hasQueuedOutput() {
t.Skip("the kernel accepted the whole payload; no output is queued to defer reads behind")
}
if _, err := conn.Write([]byte("ping")); err != nil {
t.Fatal(err)
}
if halfClose {
if err := conn.CloseWrite(); err != nil {
t.Fatal(err)
}
}
select {
case data := <-second:
t.Fatalf("read %q while output was still queued", data)
case <-time.After(300 * time.Millisecond):
}
received := make([]byte, len(payload))
if _, err := io.ReadFull(conn, received); err != nil {
t.Fatal(err)
}
if !bytes.Equal(received, payload) {
t.Fatal("payload mismatch")
}
select {
case data := <-second:
if !bytes.Equal(data, []byte("ping")) {
t.Fatalf("second message = %q", data)
}
case <-time.After(5 * time.Second):
t.Fatal("deferred read never resumed after the queue drained")
}
if halfClose {
select {
case err := <-closed:
if err != io.EOF {
t.Fatalf("OnClose error = %v, want io.EOF", err)
}
case <-time.After(5 * time.Second):
t.Fatal("timed out waiting for OnClose after half-close")
}
}
})
}
}
// TestReadsContinueBelowWatermark covers the other side of that ordering: with
// a watermark, output queued below it does not stop the worker from reading,
// so a peer that sends while its replies are still queued is not left waiting
// on a full receive queue.
func TestReadsContinueBelowWatermark(t *testing.T) {
payload := bytes.Repeat([]byte{0xCD}, 8*1024*1024)
second := make(chan []byte, 1)
config := DefaultConfig()
config.WriteBufferHighWatermark = 4 * len(payload)
var first sync.Once
var sender atomic.Pointer[Connection]
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{
Data: func(c *Connection, data []byte) {
started := false
first.Do(func() {
started = true
sender.Store(c)
for offset := 0; offset < len(payload); offset += 1 << 20 {
if err := c.SendOwned(payload[offset : offset+1<<20]); err != nil {
t.Error(err)
return
}
}
})
if !started {
second <- append([]byte(nil), data...)
}
},
}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}()
conn, err := net.DialTCP("tcp4", nil, addr)
if err != nil {
t.Fatal(err)
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(30 * time.Second))
if _, err := conn.Write([]byte("start")); err != nil {
t.Fatal(err)
}
time.Sleep(300 * time.Millisecond)
if c := sender.Load(); c == nil || !c.hasQueuedOutput() {
t.Skip("the kernel accepted the whole payload; no output is queued")
}
if _, err := conn.Write([]byte("ping")); err != nil {
t.Fatal(err)
}
select {
case data := <-second:
if !bytes.Equal(data, []byte("ping")) {
t.Fatalf("second message = %q", data)
}
case <-time.After(5 * time.Second):
t.Fatal("read deferred behind output queued below the watermark")
}
if c := sender.Load(); !c.hasQueuedOutput() {
t.Log("the queue drained before the second read; the test proved less than it meant to")
}
received := make([]byte, len(payload))
if _, err := io.ReadFull(conn, received); err != nil {
t.Fatal(err)
}
if !bytes.Equal(received, payload) {
t.Fatal("payload mismatch")
}
}
// TestConcurrentAcceptBurst covers the accept path when many connections arrive
// at once: every one must be accepted, tracked, and able to carry data.
func TestConcurrentAcceptBurst(t *testing.T) {
const burst = 256
config := DefaultConfig()
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}()
var wg sync.WaitGroup
for i := 0; i < burst; i++ {
wg.Add(1)
go func(value byte) {
defer wg.Done()
conn, err := net.DialTimeout("tcp4", addr.String(), 20*time.Second)
if err != nil {
t.Error(err)
return
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(20 * time.Second))
payload := []byte{value, value, value, value}
if _, err = conn.Write(payload); err != nil {
t.Error(err)
return
}
echoed := make([]byte, len(payload))
if _, err = io.ReadFull(conn, echoed); err != nil {
t.Error(err)
return
}
if !bytes.Equal(echoed, payload) {
t.Error("echo mismatch")
}
}(byte(i))
}
wg.Wait()
}
// An engine never runs a connection's round on its loop, so it refuses an
// inline pool, whether it would build it or is handed one.
func TestEngineRefusesInlinePool(t *testing.T) {
config := DefaultConfig()
config.SetTaskPoolMode(taskpool.ModeInline)
if server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{}}); !errors.Is(err, errInlinePool) {
if server != nil {
_ = server.Close()
}
t.Fatalf("New with ModeInline: %v, want errInlinePool", err)
}
config = DefaultConfig()
pool := taskpool.NewInline("refused-inline")
defer pool.Stop()
config.SetTaskPool(pool)
if server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{}}); !errors.Is(err, errInlinePool) {
if server != nil {
_ = server.Close()
}
t.Fatalf("New with an inline TaskPool: %v, want errInlinePool", err)
}
}
// TestMultipleListenersShareOneEngine covers a server carrying several
// listeners: every port must accept, and the connections from all of them must
// land in the one descriptor table, event loop and worker pool rather than
// needing a server each.
func TestMultipleListenersShareOneEngine(t *testing.T) {
const listeners = 4
config := DefaultConfig()
// Addr is ignored once Addrs is set.
binding := Binding{Addr: "127.0.0.1:9999", Addrs: make([]string, listeners)}
for i := range binding.Addrs {
binding.Addrs[i] = "127.0.0.1:0"
}
binding.Handler = HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}
server, err := New(config, binding)
if err != nil {
t.Fatal(err)
}
addrs, err := server.LocalAddrs()
if err != nil {
t.Fatal(err)
}
if len(addrs) != listeners {
t.Fatalf("LocalAddrs returned %d addresses, want %d", len(addrs), listeners)
}
seen := make(map[int]bool, listeners)
for _, addr := range addrs {
if addr.Port == 0 || addr.Port == 9999 || seen[addr.Port] {
t.Fatalf("listener ports are not distinct ephemeral ports: %v", addrs)
}
seen[addr.Port] = true
}
first, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
if first.Port != addrs[0].Port {
t.Fatalf("LocalAddr port = %d, want the first listener %d", first.Port, addrs[0].Port)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
}()
var wg sync.WaitGroup
for i, addr := range addrs {
for round := 0; round < 4; round++ {
wg.Add(1)
go func(addr string, value byte) {
defer wg.Done()
conn, err := net.DialTimeout("tcp4", addr, 10*time.Second)
if err != nil {
t.Error(err)
return
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(10 * time.Second))
payload := bytes.Repeat([]byte{value}, 64)
if _, err = conn.Write(payload); err != nil {
t.Error(err)
return
}
echoed := make([]byte, len(payload))
if _, err = io.ReadFull(conn, echoed); err != nil {
t.Error(err)
return
}
if !bytes.Equal(echoed, payload) {
t.Errorf("echo mismatch on listener %s", addr)
}
}(addr.String(), byte(i))
}
}
wg.Wait()
}
// Network and Addr are read the way net.Listen reads them, so the same strings
// that name a listener there name one here.
func TestListenAddressFormsMatchNetListen(t *testing.T) {
for _, tc := range []struct {
name string
network string
addr string
wantIP func(net.IP) bool
}{
{"tcp4 literal", "tcp4", "127.0.0.1:0", func(ip net.IP) bool { return ip.Equal(net.IPv4(127, 0, 0, 1)) }},
{"tcp literal", "tcp", "127.0.0.1:0", func(ip net.IP) bool { return ip.Equal(net.IPv4(127, 0, 0, 1)) }},
{"tcp6 literal", "tcp6", "[::1]:0", func(ip net.IP) bool { return ip.Equal(net.IPv6loopback) }},
{"tcp wildcard", "tcp", ":0", func(ip net.IP) bool { return ip.IsUnspecified() }},
{"empty network defaults to tcp", "", "127.0.0.1:0", func(ip net.IP) bool { return ip.Equal(net.IPv4(127, 0, 0, 1)) }},
} {
t.Run(tc.name, func(t *testing.T) {
// Whatever this library does with the arguments, net.Listen has to
// accept them too, or they are not the standard forms.
reference, err := net.Listen(map[bool]string{true: "tcp", false: tc.network}[tc.network == ""], tc.addr)
if err != nil {
t.Skipf("net.Listen(%q, %q): %v", tc.network, tc.addr, err)
}
reference.Close()
config := DefaultConfig()
config.Network = tc.network
server, err := New(config, Binding{Addr: tc.addr, Handler: HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}})
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
defer func() {
server.Stop()
if err := <-runDone; err != nil {
t.Errorf("Run: %v", err)
}
if err := server.Close(); err != nil {
t.Errorf("Close: %v", err)
}
}()
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
if addr.Port == 0 {
t.Fatal("LocalAddr reports port 0, want the port the kernel chose")
}
if !tc.wantIP(addr.IP) {
t.Fatalf("LocalAddr IP = %v, not the address asked for", addr.IP)
}
// A wildcard listener is reachable over loopback; a literal one is
// reachable at itself. Dialing the reported address covers both.
dialAddr := addr.String()
if addr.IP.IsUnspecified() {
dialAddr = net.JoinHostPort("127.0.0.1", strconv.Itoa(addr.Port))
}
conn, err := net.DialTimeout("tcp", dialAddr, 5*time.Second)
if err != nil {
t.Fatal(err)
}
defer conn.Close()
if err := conn.SetDeadline(time.Now().Add(10 * time.Second)); err != nil {
t.Fatal(err)
}
payload := []byte("listen")
if _, err := conn.Write(payload); err != nil {
t.Fatal(err)
}
reply := make([]byte, len(payload))
if _, err := io.ReadFull(conn, reply); err != nil {
t.Fatal(err)
}
if !bytes.Equal(reply, payload) {
t.Fatalf("echo returned %q, want %q", reply, payload)
}
})
}
}
func TestListenRejectsUnknownNetwork(t *testing.T) {
config := DefaultConfig()
config.Network = "unixgram"
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{}})
if err == nil {
server.Close()
t.Fatal("New accepted network \"unixgram\", want an error")
}
var unknown net.UnknownNetworkError
if !errors.As(err, &unknown) {
t.Fatalf("New error = %v, want net.UnknownNetworkError", err)
}
}
// countingPool runs tasks on a real pool and counts what it was handed, so a
// test can tell the engine used it.
type countingPool struct {
*taskpool.TaskPool
tasks atomic.Int64
}
func (p *countingPool) GoTask(task taskpool.Task) bool {
p.tasks.Add(1)
return p.TaskPool.GoTask(task)
}
func (p *countingPool) GoTasks(tasks []taskpool.Task) int {
p.tasks.Add(int64(len(tasks)))
return p.TaskPool.GoTasks(tasks)
}
// A pool the caller supplies has to carry the connections, make the built-in
// pool's settings irrelevant, and survive the engine: the caller owns it and
// may be sharing it.
func TestCustomTaskPoolRunsConnectionsAndOutlivesEngine(t *testing.T) {
pool := &countingPool{TaskPool: taskpool.NewWithMode("test", taskpool.ModeElastic, 4, 64)}
defer pool.Stop()
config := DefaultConfig()
// Invalid for the built-in pool, and ignored once a pool is supplied.
config.WorkerCount = 0
config.SetTaskPool(pool)
server, err := New(config, Binding{Addr: "127.0.0.1:0", Handler: HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}})
if err != nil {
t.Fatal(err)
}
addr, err := server.LocalAddr()
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
conn, err := net.DialTimeout("tcp4", addr.String(), 5*time.Second)
if err != nil {
t.Fatal(err)
}
_ = conn.SetDeadline(time.Now().Add(5 * time.Second))
payload := []byte("custom pool")
if _, err := conn.Write(payload); err != nil {
t.Fatal(err)
}
reply := make([]byte, len(payload))
if _, err := io.ReadFull(conn, reply); err != nil {
t.Fatal(err)
}
if !bytes.Equal(reply, payload) {
t.Fatalf("echo = %q, want %q", reply, payload)
}
_ = conn.Close()
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
if err := server.Close(); err != nil {
t.Error(err)
}
if pool.tasks.Load() == 0 {
t.Fatal("the engine never handed a task to the supplied pool")
}
done := make(chan struct{})
if !pool.Go(func() { close(done) }) {
t.Fatal("closing the engine stopped a pool it does not own")
}
<-done
}
// A close the loop carries out while a round is still running on a worker is
// ordered after that round, as an event would be: OnClose waits for the
// OnData in progress to return, and the descriptor stays the connection's
// until then, so the round never reads one that has been closed or handed on.
func TestOnCloseFollowsTheRunningRound(t *testing.T) {
entered := make(chan *Connection, 1)
release := make(chan struct{})
var dataDone atomic.Bool
closed := make(chan bool, 1)
_, addr := startEchoServer(t, DefaultConfig(), HandlerFuncs{
Data: func(c *Connection, _ []byte) {
entered <- c
<-release
dataDone.Store(true)
},
Close: func(*Connection, error) { closed <- dataDone.Load() },
})
conn, err := net.DialTimeout("tcp", addr, 5*time.Second)
if err != nil {
t.Fatal(err)
}
defer conn.Close()
if _, err := conn.Write([]byte("x")); err != nil {
t.Fatal(err)
}
c := <-entered
fd := c.FD()
c.Close()
select {
case <-closed:
close(release)
t.Fatal("OnClose ran while OnData was still running")
case <-time.After(100 * time.Millisecond):
}
if c.FD() != fd {
close(release)
t.Fatalf("descriptor went from %d to %d under a running round", fd, c.FD())
}
close(release)
select {
case afterData := <-closed:
if !afterData {
t.Fatal("OnClose ran before OnData returned")
}
case <-time.After(5 * time.Second):
t.Fatal("OnClose never ran")
}
for deadline := time.Now().Add(5 * time.Second); c.FD() >= 0; time.Sleep(time.Millisecond) {
if time.Now().After(deadline) {
t.Fatal("the descriptor was never released")
}
}
}
// unixSocketPath returns a path for a Unix socket in a directory of its own.
// t.TempDir can run past the 104 bytes macOS allows a socket path, so the
// directory is made directly under the system temporary directory.
func unixSocketPath(t *testing.T) string {
t.Helper()
dir, err := os.MkdirTemp("", "fib")
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { _ = os.RemoveAll(dir) })
return filepath.Join(dir, "s.sock")
}
func startUnixServer(t *testing.T, path string, handler Handler) *Engine {
t.Helper()
config := DefaultConfig()
config.Network = "unix"
server, err := New(config, Binding{Addr: path, Handler: handler})
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
t.Cleanup(func() {
server.Stop()
if err := <-runDone; err != nil {
t.Error(err)
}
_ = server.Close()
})
return server
}
// A Unix socket serves like TCP: large echoes run through the same queueing
// and backpressure, the peer's address is a *net.UnixAddr, and the socket file
// is gone once the engine closes.
func TestUnixSocketEcho(t *testing.T) {
path := unixSocketPath(t)
var remote sync.Map
config := DefaultConfig()
config.Network = "unix"
server, err := New(config, Binding{Addr: path, Handler: HandlerFuncs{
Open: func(c *Connection) { remote.Store(c, c.RemoteAddr()) },
Data: func(c *Connection, b []byte) {
if c.Send(b) != nil {
c.Close()
}
},
}})
if err != nil {
t.Fatal(err)
}
runDone := make(chan error, 1)
go func() { runDone <- server.Run() }()
addrs, err := server.ListenAddrs()
if err != nil {
t.Fatal(err)
}
if len(addrs) != 1 || addrs[0].Network() != "unix" || addrs[0].String() != path {
t.Fatalf("ListenAddrs = %v, want unix %s", addrs, path)
}
if _, err := server.LocalAddr(); err == nil {
t.Error("LocalAddr reported a TCP address for a Unix listener")
}
var wg sync.WaitGroup
for i := 0; i < 8; i++ {
wg.Add(1)
go func(value byte) {
defer wg.Done()
conn, err := net.DialTimeout("unix", path, 5*time.Second)
if err != nil {
t.Error(err)
return
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(15 * time.Second))
payload := bytes.Repeat([]byte{value}, 1<<20)
go func() { _, _ = conn.Write(payload) }()
received := make([]byte, len(payload))
if _, err := io.ReadFull(conn, received); err != nil {
t.Error(err)
return
}
if !bytes.Equal(received, payload) {
t.Error("echo mismatch")
}
}(byte(i))
}
wg.Wait()
remote.Range(func(_, addr any) bool {
if _, ok := addr.(*net.UnixAddr); !ok {
t.Errorf("RemoteAddr = %T, want *net.UnixAddr", addr)
}
return true
})
server.Stop()
if err := <-runDone; err != nil {
t.Fatal(err)
}
if err := server.Close(); err != nil {
t.Fatal(err)
}
if _, err := os.Stat(path); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("socket file left behind: %v", err)
}
}
// Binding a path that already exists fails, as it does for net.Listen, rather
// than taking the path from whatever owns it.
func TestUnixSocketPathInUse(t *testing.T) {
path := unixSocketPath(t)
startUnixServer(t, path, HandlerFuncs{})
config := DefaultConfig()
config.Network = "unix"
if second, err := New(config, Binding{Addr: path, Handler: HandlerFuncs{}}); err == nil {
second.Close()
t.Fatal("a second engine bound a path already in use")
}
if _, err := os.Stat(path); err != nil {
t.Fatalf("the failed New removed the first engine's socket: %v", err)
}
}
// An engine dials a Unix socket like a TCP address, and a path nothing
// listens on fails the dial.
func TestDialUnix(t *testing.T) {
path := unixSocketPath(t)
startUnixServer(t, path, echoHandler())
client, _ := startEchoServer(t, DefaultConfig(), HandlerFuncs{})
received := make(chan []byte, 16)
handler := HandlerFuncs{Data: func(_ *Connection, b []byte) { received <- append([]byte(nil), b...) }}
dialed := make(chan dialResult, 1)
err := client.DialWithHandler("unix", path, 5*time.Second, handler, func(c *Connection, err error) {
dialed <- dialResult{c, err}
})
if err != nil {
t.Fatal(err)
}
r := <-dialed
if r.err != nil {
t.Fatal(r.err)
}
for i := 0; i < 3; i++ {
msg := "unix " + strconv.Itoa(i)
if err := r.c.Send([]byte(msg)); err != nil {
t.Fatal(err)
}
var got []byte
for len(got) < len(msg) {
select {
case b := <-received:
got = append(got, b...)
case <-time.After(5 * time.Second):
t.Fatal("no echo")
}
}
if string(got) != msg {
t.Fatalf("echo %q, want %q", got, msg)
}
}
r.c.Close()
failed := make(chan error, 1)
missing := filepath.Join(filepath.Dir(path), "missing.sock")
err = client.Dial("unix", missing, time.Second, func(c *Connection, err error) { failed <- err })
if err == nil {
err = <-failed
}
var opErr *net.OpError
if !errors.As(err, &opErr) || opErr.Addr == nil || opErr.Addr.String() != missing {
t.Fatalf("dial to a missing socket: %v, want a *net.OpError naming it", err)
}
}
// On Linux a leading '@' names an abstract socket, which has no file.
func TestUnixAbstractSocket(t *testing.T) {
if runtime.GOOS != "linux" {
t.Skip("abstract Unix sockets are Linux-only")
}
name := "@fib-test-" + strconv.Itoa(os.Getpid())
startUnixServer(t, name, echoHandler())
conn, err := net.DialTimeout("unix", name, 5*time.Second)
if err != nil {
t.Fatal(err)
}
defer conn.Close()
_ = conn.SetDeadline(time.Now().Add(5 * time.Second))
if _, err := conn.Write([]byte("abstract")); err != nil {
t.Fatal(err)
}
buf := make([]byte, 8)
if _, err := io.ReadFull(conn, buf); err != nil || string(buf) != "abstract" {
t.Fatalf("echo %q, %v", buf, err)
}
}
// dialResult is what one Dial's done callback reported.
type dialResult struct {
c *Connection
err error
}
func echoHandler() Handler {
return HandlerFuncs{Data: func(c *Connection, b []byte) {
if err := c.Send(b); err != nil {
c.Close()
}
}}
}
// A dialed connection joins the engine the way an accepted one does: OnOpen
// runs before the dialer hears of it, and its replies arrive through the same
// handler and workers.
func TestDialedConnectionsEcho(t *testing.T) {
_, serverAddr := startEchoServer(t, DefaultConfig(), echoHandler())
const conns = 64
payload := []byte("dialed through the event loop")
var mu sync.Mutex
opened := map[*Connection]bool{}
received := map[*Connection][]byte{}
echoed := make(chan *Connection, conns)
client, _ := startEchoServer(t, DefaultConfig(), HandlerFuncs{})
handler := HandlerFuncs{
Open: func(c *Connection) {
mu.Lock()
opened[c] = true
mu.Unlock()
},
Data: func(c *Connection, b []byte) {
mu.Lock()
received[c] = append(received[c], b...)
done := len(received[c]) == len(payload)
mu.Unlock()
if done {
echoed <- c
}
},
}