forked from lorenzodonini/ocpp-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwebsocket_test.go
1478 lines (1409 loc) · 42.9 KB
/
websocket_test.go
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
package ws
import (
"bytes"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/tls"
"crypto/x509"
"crypto/x509/pkix"
"encoding/pem"
"errors"
"fmt"
"math/big"
"net"
"net/http"
"net/url"
"os"
"path"
"strings"
"sync"
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"github.com/gorilla/websocket"
"github.com/stretchr/testify/assert"
)
const (
serverPort = 8887
serverPath = "/ws/{id}"
testPath = "/ws/testws"
// Default sub-protocol to send to peer upon connection.
defaultSubProtocol = "ocpp1.6"
)
func newWebsocketServer(t *testing.T, onMessage func(data []byte) ([]byte, error)) *server {
wsServer := NewServer()
innerS, ok := wsServer.(*server)
require.True(t, ok)
innerS.SetMessageHandler(func(ws Channel, data []byte) error {
assert.NotNil(t, ws)
assert.NotNil(t, data)
if onMessage != nil {
response, err := onMessage(data)
assert.Nil(t, err)
if response != nil {
err = innerS.Write(ws.ID(), data)
assert.Nil(t, err)
}
}
return nil
})
return innerS
}
func newWebsocketClient(t *testing.T, onMessage func(data []byte) ([]byte, error)) *client {
wsClient := NewClient()
innerC, ok := wsClient.(*client)
require.True(t, ok)
innerC.SetRequestedSubProtocol(defaultSubProtocol)
innerC.SetMessageHandler(func(data []byte) error {
assert.NotNil(t, data)
if onMessage != nil {
response, err := onMessage(data)
assert.Nil(t, err)
if response != nil {
err = innerC.Write(data)
assert.Nil(t, err)
}
}
return nil
})
return innerC
}
type WebSocketSuite struct {
suite.Suite
client *client
server *server
}
func (s *WebSocketSuite) SetupTest() {
s.server = newWebsocketServer(s.T(), nil)
s.client = newWebsocketClient(s.T(), nil)
}
func (s *WebSocketSuite) TearDownTest() {
if s.client != nil {
s.client.Stop()
}
if s.server != nil {
s.server.Stop()
}
}
func (s *WebSocketSuite) TestPingTicker() {
defaultPeriod := 1 * time.Millisecond
testTable := []struct {
name string
active bool
pingPeriod time.Duration
expectedTickerNil bool
}{
{
"real ticker",
true,
defaultPeriod,
false,
},
{
"dummy ticker",
false,
defaultPeriod,
true,
},
{
"dummy ticker due to invalid period",
true,
0,
true,
},
}
for _, tc := range testTable {
var pc *PingConfig
if tc.active {
pc = &PingConfig{
PingPeriod: tc.pingPeriod,
}
}
t := newOptTicker(pc)
if tc.expectedTickerNil {
s.Nil(t.ticker, tc.name)
s.NotNil(t.c, tc.name)
} else {
s.NotNil(t.ticker, tc.name)
s.Nil(t.c, tc.name)
}
// Test retrieving channel
c := t.T()
s.NotNil(c)
// Test waiting for tick
select {
case <-c:
if tc.expectedTickerNil {
s.Fail("unexpected tick from nil ticker", tc.name)
}
case <-time.After(2 * defaultPeriod):
if !tc.expectedTickerNil {
s.Fail("unexpected timeout from real ticker", tc.name)
}
}
// Test waiting for tick after stop
t.Stop()
select {
case <-c:
s.Fail("unexpected tick from stopped ticker", tc.name)
case <-time.After(2 * defaultPeriod):
break
}
}
}
func (s *WebSocketSuite) TestWebsocketConnectionState() {
s.False(s.client.IsConnected())
closeC := make(chan struct{}, 1)
s.client.SetMessageHandler(func(data []byte) error {
s.Fail("unexpected message")
return nil
})
s.client.SetDisconnectedHandler(func(err error) {
closeC <- struct{}{}
})
// Simulate connection
go s.server.Start(serverPort, serverPath)
time.Sleep(50 * time.Millisecond)
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
// Check connection state on internal web socket
ws := s.client.webSocket
s.NotNil(ws)
s.True(ws.IsConnected())
// Close connection
err = ws.Close(websocket.CloseError{Code: websocket.CloseNormalClosure, Text: ""})
s.NoError(err)
select {
case <-closeC:
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for connection to close")
}
s.False(ws.IsConnected())
}
func (s *WebSocketSuite) TestWebsocketGetReadTimeout() {
// Create default timeout settings and handlers
serverTimeoutConfig := NewServerTimeoutConfig()
s.server.SetTimeoutConfig(serverTimeoutConfig)
ctrlC := make(chan struct{}, 1)
s.server.SetNewClientHandler(func(ws Channel) {
ctrlC <- struct{}{}
})
// Simulate connection to initialize a websocket
go s.server.Start(serverPort, serverPath)
time.Sleep(50 * time.Millisecond)
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
// Wait for connection to be established
select {
case <-ctrlC:
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for connection to establish")
}
// Test server timeout for default settings
serverW, ok := s.server.connections["testws"]
s.True(ok)
now := time.Now()
timeout := serverW.getReadTimeout()
s.GreaterOrEqual(timeout.Unix(), now.Add(s.server.timeoutConfig.PingWait).Unix())
// Test server timeout for zero setting
cfg := serverW.cfg
cfg.ReadWait = 0
serverW.updateConfig(cfg)
timeout = serverW.getReadTimeout()
s.Equal(time.Time{}, timeout)
// Test client timeout for default settings
clientW := s.client.webSocket
s.NotNil(clientW)
now = time.Now()
timeout = clientW.getReadTimeout()
s.GreaterOrEqual(timeout.Unix(), now.Add(s.client.timeoutConfig.PongWait).Unix())
// Test client timeout for zero setting
cfg = clientW.cfg
cfg.PingConfig.PongWait = 0
cfg.ReadWait = 0
clientW.updateConfig(cfg)
timeout = clientW.getReadTimeout()
s.Equal(time.Time{}, timeout)
}
func (s *WebSocketSuite) TestWebsocketEcho() {
msg := []byte("Hello webSocket!")
triggerC := make(chan struct{}, 1)
done := make(chan struct{}, 1)
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.True(bytes.Equal(msg, data))
// Echo reply received, notifying flow routine
triggerC <- struct{}{}
return data, nil
})
s.server.SetNewClientHandler(func(ws Channel) {
tlsState := ws.TLSConnectionState()
s.Nil(tlsState)
})
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.True(bytes.Equal(msg, data))
// Echo response received, notifying flow routine
done <- struct{}{}
return nil, nil
})
// Start server
go s.server.Start(serverPort, serverPath)
// Start flow routine
go func() {
// Wait for messages to be exchanged in a dedicate routine.
// Will reply to client.
sig := <-triggerC
s.NotNil(sig)
err := s.server.Write(path.Base(testPath), msg)
s.NoError(err)
sig = <-triggerC
s.NotNil(sig)
}()
time.Sleep(100 * time.Millisecond)
// Test connection
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
s.True(s.client.IsConnected())
// Test message
err = s.client.Write(msg)
s.NoError(err)
// Wait for echo result
select {
case result := <-done:
s.NotNil(result)
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for echo result")
}
}
func (s *WebSocketSuite) TestWebsocketChargePointIdResolver() {
connected := make(chan string)
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from client!")
return nil, nil
})
s.server.SetChargePointIdResolver(func(*http.Request) (string, error) {
return "my-custom-id", nil
})
s.server.SetNewClientHandler(func(ws Channel) {
connected <- ws.ID()
})
go s.server.Start(serverPort, serverPath)
time.Sleep(500 * time.Millisecond)
// Test message
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from server!")
return nil, nil
})
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
// Attempt to connect and expect the custom resolved charge point id
err := s.client.Start(u.String())
s.NoError(err)
result := <-connected
s.Equal("my-custom-id", result)
}
func (s *WebSocketSuite) TestWebsocketChargePointIdResolverFailure() {
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from client!")
return nil, nil
})
s.server.SetChargePointIdResolver(func(*http.Request) (string, error) {
return "", fmt.Errorf("test error")
})
go s.server.Start(serverPort, serverPath)
time.Sleep(500 * time.Millisecond)
// Test message
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from server!")
return nil, nil
})
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
// Attempt to connect and expect the custom resolved charge point id
err := s.client.Start(u.String())
s.Error(err)
httpErr, ok := err.(HttpConnectionError)
s.True(ok)
s.Equal(http.StatusNotFound, httpErr.HttpCode)
s.Equal("websocket: bad handshake", httpErr.Message)
}
func (s *WebSocketSuite) TestWebsocketBootRetries() {
verifyConnection := func(client *client, connected bool) {
maxAttempts := 20
for i := 0; i <= maxAttempts; i++ {
if client.IsConnected() != connected {
time.Sleep(200 * time.Millisecond)
continue
}
}
s.Equal(connected, client.IsConnected())
}
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
return data, nil
})
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
return nil, nil
})
// Reduce timeout to make test faster
s.client.timeoutConfig.RetryBackOffWaitMinimum = 1 * time.Second
s.client.timeoutConfig.RetryBackOffRandomRange = 2
go func() {
// Start websocket client
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
s.client.StartWithRetries(u.String())
}()
// Initial connection attempt fails, as server isn't listening yet
s.False(s.client.IsConnected())
time.Sleep(500 * time.Millisecond)
go s.server.Start(serverPort, serverPath)
verifyConnection(s.client, true)
s.server.Stop()
verifyConnection(s.client, false)
}
func (s *WebSocketSuite) TestTLSWebsocketEcho() {
msg := []byte("Hello Secure webSocket!")
triggerC := make(chan struct{}, 1)
done := make(chan struct{}, 1)
// Use NewServer(WithServerTLSConfig(...)) when in different package
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.True(bytes.Equal(msg, data))
// Message received, notifying flow routine
triggerC <- struct{}{}
return data, nil
})
s.server.SetNewClientHandler(func(ws Channel) {
tlsState := ws.TLSConnectionState()
s.NotNil(tlsState)
})
s.server.SetDisconnectedClientHandler(func(ws Channel) {
// Connection closed, completing test
done <- struct{}{}
})
// Create self-signed TLS certificate
// TODO: use FiloSottile's lib for this
certFilename := "/tmp/cert.pem"
keyFilename := "/tmp/key.pem"
err := createTLSCertificate(certFilename, keyFilename, "localhost", nil, nil)
s.NoError(err)
defer os.Remove(certFilename)
defer os.Remove(keyFilename)
// Set self-signed TLS certificate
s.server.tlsCertificatePath = certFilename
s.server.tlsCertificateKey = keyFilename
// Create TLS client
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.True(bytes.Equal(msg, data))
// Echo response received, notifying flow routine
done <- struct{}{}
return nil, nil
})
s.client.AddOption(func(dialer *websocket.Dialer) {
certPool := x509.NewCertPool()
data, err := os.ReadFile(certFilename)
s.NoError(err)
ok := certPool.AppendCertsFromPEM(data)
s.True(ok)
dialer.TLSClientConfig = &tls.Config{
RootCAs: certPool,
}
})
// Start server
go s.server.Start(serverPort, serverPath)
// Start flow routine
go func() {
// Wait for messages to be exchanged, then close connection
sig := <-triggerC
s.NotNil(sig)
err = s.server.Write(path.Base(testPath), msg)
s.NoError(err)
sig = <-triggerC
s.NotNil(sig)
}()
time.Sleep(100 * time.Millisecond)
// Test connection
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "wss", Host: host, Path: testPath}
err = s.client.Start(u.String())
s.NoError(err)
s.True(s.client.IsConnected())
// Test message
err = s.client.Write(msg)
s.NoError(err)
// Wait for echo result
select {
case result := <-done:
s.NotNil(result)
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for echo result")
}
}
func (s *WebSocketSuite) TestServerStartErrors() {
triggerC := make(chan struct{}, 1)
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
triggerC <- struct{}{}
})
// Make sure http server is initialized on start
s.server.httpServer = nil
// Listen for errors
go func() {
err, ok := <-s.server.Errors()
s.True(ok)
s.Error(err)
triggerC <- struct{}{}
}()
time.Sleep(100 * time.Millisecond)
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Starting server again throws error
s.server.Start(serverPort, serverPath)
r := <-triggerC
s.NotNil(r)
}
func (s *WebSocketSuite) TestClientDuplicateConnection() {
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
})
// Start server
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Connect client 1
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
return nil, nil
})
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
// Try to connect client 2
disconnectC := make(chan struct{})
wsClient2 := newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
return nil, nil
})
wsClient2.SetDisconnectedHandler(func(err error) {
s.IsType(&websocket.CloseError{}, err)
var wsErr *websocket.CloseError
ok := errors.As(err, &wsErr)
s.True(ok)
s.Equal(websocket.ClosePolicyViolation, wsErr.Code)
s.Equal("a connection with this ID already exists", wsErr.Text)
wsClient2.SetDisconnectedHandler(nil)
disconnectC <- struct{}{}
})
err = wsClient2.Start(u.String())
s.NoError(err)
// Expect connection to be closed immediately
_, ok := <-disconnectC
s.True(ok)
}
func (s *WebSocketSuite) TestServerStopConnection() {
triggerC := make(chan struct{}, 1)
disconnectedClientC := make(chan struct{}, 1)
disconnectedServerC := make(chan struct{}, 1)
closeError := websocket.CloseError{
Code: websocket.CloseGoingAway,
Text: "CloseClientConnection",
}
wsID := "testws"
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
triggerC <- struct{}{}
})
s.server.SetDisconnectedClientHandler(func(ws Channel) {
disconnectedServerC <- struct{}{}
})
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
return nil, nil
})
s.client.SetDisconnectedHandler(func(err error) {
s.IsType(&closeError, err)
var closeErr *websocket.CloseError
ok := errors.As(err, &closeErr)
s.True(ok)
s.Equal(closeError.Code, closeErr.Code)
s.Equal(closeError.Text, closeErr.Text)
disconnectedClientC <- struct{}{}
})
// Start server
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
var c Channel
var ok bool
c, ok = s.server.GetChannel(wsID)
s.False(ok)
s.Nil(c)
// Connect client
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
// Wait for client to connect
_, ok = <-triggerC
s.True(ok)
// Verify channel
c, ok = s.server.GetChannel(wsID)
s.True(ok)
s.NotNil(c)
s.Equal(wsID, c.ID())
s.True(c.IsConnected())
// Close connection and wait for client to be closed
err = s.server.StopConnection(path.Base(testPath), closeError)
s.NoError(err)
_, ok = <-disconnectedClientC
s.True(ok)
_, ok = <-disconnectedServerC
s.True(ok)
s.False(s.client.IsConnected())
time.Sleep(100 * time.Millisecond)
s.Empty(s.server.connections)
// client will attempt to reconnect under the hood, but test finishes before this can happen
}
func (s *WebSocketSuite) TestWebsocketServerStopAllConnections() {
triggerC := make(chan struct{}, 1)
numClients := 5
disconnectedServerC := make(chan struct{}, 1)
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
triggerC <- struct{}{}
})
s.server.SetDisconnectedClientHandler(func(ws Channel) {
disconnectedServerC <- struct{}{}
})
// Start server
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Connect clients
clients := []Client{}
wg := sync.WaitGroup{}
host := fmt.Sprintf("localhost:%v", serverPort)
for i := 0; i < numClients; i++ {
wsClient := newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
return nil, nil
})
wsClient.SetDisconnectedHandler(func(err error) {
s.IsType(&websocket.CloseError{}, err)
var closeErr *websocket.CloseError
ok := errors.As(err, &closeErr)
s.True(ok)
s.Equal(websocket.CloseNormalClosure, closeErr.Code)
s.Equal("", closeErr.Text)
wg.Done()
})
u := url.URL{Scheme: "ws", Host: host, Path: fmt.Sprintf("%v-%v", testPath, i)}
err := wsClient.Start(u.String())
s.NoError(err)
clients = append(clients, wsClient)
// Wait for client to connect
_, ok := <-triggerC
s.True(ok)
wg.Add(1)
}
// Stop server and wait for clients to disconnect
s.server.Stop()
waitC := make(chan struct{}, 1)
go func() {
wg.Wait()
waitC <- struct{}{}
}()
select {
case <-waitC:
break
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for clients to disconnect")
}
// Double-check disconnection status
for _, c := range clients {
s.False(c.IsConnected())
// client will attempt to reconnect under the hood, but test finishes before this can happen
c.Stop()
}
time.Sleep(100 * time.Millisecond)
s.Empty(s.server.connections)
}
func (s *WebSocketSuite) TestWebsocketClientConnectionBreak() {
newClient := make(chan struct{})
disconnected := make(chan struct{})
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
newClient <- struct{}{}
})
s.server.SetDisconnectedClientHandler(func(ws Channel) {
disconnected <- struct{}{}
})
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Test
s.client = newWebsocketClient(s.T(), nil)
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
// Wait for connection to be established, then break the connection asynchronously
go func() {
<-time.After(200 * time.Millisecond)
err := s.client.webSocket.connection.Close()
s.NoError(err)
}()
// Connect and wait
err := s.client.Start(u.String())
s.NoError(err)
result := <-newClient
s.NotNil(result)
// Wait for internal disconnect
select {
case result = <-disconnected:
s.NotNil(result)
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for client disconnect")
}
}
func (s *WebSocketSuite) TestWebsocketServerConnectionBreak() {
disconnected := make(chan struct{}, 1)
s.server = newWebsocketServer(s.T(), nil)
s.server.SetNewClientHandler(func(ws Channel) {
s.NotNil(ws)
conn := s.server.connections[ws.ID()]
s.NotNil(conn)
// Simulate connection closed as soon client is connected
err := conn.connection.Close()
s.NoError(err)
})
s.server.SetDisconnectedClientHandler(func(ws Channel) {
disconnected <- struct{}{}
})
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Test
s.client = newWebsocketClient(s.T(), nil)
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
err := s.client.Start(u.String())
s.NoError(err)
select {
case result := <-disconnected:
s.NotNil(result)
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for server disconnect")
}
}
func (s *WebSocketSuite) TestValidBasicAuth() {
var ok bool
authUsername := "testUsername"
authPassword := "testPassword"
// Create self-signed TLS certificate
// TODO: replace with FiloSottile's lib
certFilename := "/tmp/cert.pem"
keyFilename := "/tmp/key.pem"
err := createTLSCertificate(certFilename, keyFilename, "localhost", nil, nil)
s.NoError(err)
defer os.Remove(certFilename)
defer os.Remove(keyFilename)
// Create TLS server with self-signed certificate
tlsServer := NewServer(WithServerTLSConfig(certFilename, keyFilename, nil))
s.server, ok = tlsServer.(*server)
s.True(ok)
// Add basic auth handler
s.server.SetBasicAuthHandler(func(username string, password string) bool {
s.Equal(authUsername, username)
s.Equal(authPassword, password)
return true
})
connected := make(chan struct{}, 1)
s.server.SetNewClientHandler(func(ws Channel) {
connected <- struct{}{}
})
// Run server
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Create TLS client
certPool := x509.NewCertPool()
data, err := os.ReadFile(certFilename)
s.NoError(err)
ok = certPool.AppendCertsFromPEM(data)
s.True(ok)
tlsClient := NewClient(WithClientTLSConfig(&tls.Config{
RootCAs: certPool,
}))
s.client, ok = tlsClient.(*client)
s.True(ok)
s.client.SetRequestedSubProtocol(defaultSubProtocol)
// Add basic auth
s.client.SetBasicAuth(authUsername, authPassword)
// Test connection
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "wss", Host: host, Path: testPath}
err = s.client.Start(u.String())
s.NoError(err)
result := <-connected
s.NotNil(result)
s.True(s.client.IsConnected())
}
func (s *WebSocketSuite) TestInvalidBasicAuth() {
var ok bool
authUsername := "testUsername"
authPassword := "testPassword"
// Create self-signed TLS certificate
// TODO: replace with FiloSottile's lib
certFilename := "/tmp/cert.pem"
keyFilename := "/tmp/key.pem"
err := createTLSCertificate(certFilename, keyFilename, "localhost", nil, nil)
s.NoError(err)
defer os.Remove(certFilename)
defer os.Remove(keyFilename)
// Create TLS server with self-signed certificate
tlsServer := NewServer(WithServerTLSConfig(certFilename, keyFilename, nil))
s.server, ok = tlsServer.(*server)
s.True(ok)
// Add basic auth handler
s.server.SetBasicAuthHandler(func(username string, password string) bool {
validCredentials := authUsername == username && authPassword == password
s.False(validCredentials)
return validCredentials
})
s.server.SetNewClientHandler(func(ws Channel) {
// Should never reach this
s.Fail("no new connection should be received from client!")
})
// Run server
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Create TLS client
certPool := x509.NewCertPool()
data, err := os.ReadFile(certFilename)
s.NoError(err)
ok = certPool.AppendCertsFromPEM(data)
s.True(ok)
wsClient := NewClient(WithClientTLSConfig(&tls.Config{
RootCAs: certPool,
}))
// Test connection without bssic auth -> error expected
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "wss", Host: host, Path: testPath}
err = wsClient.Start(u.String())
// Assert HTTP error
s.Error(err)
var httpErr HttpConnectionError
ok = errors.As(err, &httpErr)
s.True(ok)
s.Equal(http.StatusUnauthorized, httpErr.HttpCode)
s.Equal("401 Unauthorized", httpErr.HttpStatus)
s.Equal("websocket: bad handshake", httpErr.Message)
s.True(strings.Contains(err.Error(), "http status:"))
// Add basic auth
wsClient.SetBasicAuth(authUsername, "invalidPassword")
// Test connection
err = wsClient.Start(u.String())
s.Error(err)
var httpError HttpConnectionError
ok = errors.As(err, &httpError)
s.True(ok)
s.Equal(http.StatusUnauthorized, httpError.HttpCode)
}
func (s *WebSocketSuite) TestInvalidOriginHeader() {
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from client!")
return nil, nil
})
s.server.SetNewClientHandler(func(ws Channel) {
s.Fail("no new connection should be received from client!")
})
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Test message
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from server!")
return nil, nil
})
// Set invalid origin header
s.client.SetHeaderValue("Origin", "example.org")
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
// Attempt to connect and expect cross-origin error
err := s.client.Start(u.String())
s.Error(err)
var httpErr HttpConnectionError
ok := errors.As(err, &httpErr)
s.True(ok)
s.Equal(http.StatusForbidden, httpErr.HttpCode)
s.Equal("websocket: bad handshake", httpErr.Message)
}
func (s *WebSocketSuite) TestCustomOriginHeaderHandler() {
origin := "example.org"
connected := make(chan struct{})
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from client!")
return nil, nil
})
s.server.SetNewClientHandler(func(ws Channel) {
connected <- struct{}{}
})
s.server.SetCheckOriginHandler(func(r *http.Request) bool {
return r.Header.Get("Origin") == origin
})
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Test message
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from server!")
return nil, nil
})
// Set invalid origin header (not example.org)
s.client.SetHeaderValue("Origin", "localhost")
host := fmt.Sprintf("localhost:%v", serverPort)
u := url.URL{Scheme: "ws", Host: host, Path: testPath}
// Attempt to connect and expect cross-origin error
err := s.client.Start(u.String())
s.Error(err)
var httpErr HttpConnectionError
ok := errors.As(err, &httpErr)
s.True(ok)
s.Equal(http.StatusForbidden, httpErr.HttpCode)
s.Equal("websocket: bad handshake", httpErr.Message)
// Re-attempt with correct header
s.client.SetHeaderValue("Origin", "example.org")
err = s.client.Start(u.String())
s.NoError(err)
result := <-connected
s.NotNil(result)
}
func (s *WebSocketSuite) TestCustomCheckClientHandler() {
invalidTestPath := "/ws/invalid-testws"
id := path.Base(testPath)
connected := make(chan struct{})
s.server = newWebsocketServer(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from client!")
return nil, nil
})
s.server.SetNewClientHandler(func(ws Channel) {
connected <- struct{}{}
})
s.server.SetCheckClientHandler(func(clientId string, r *http.Request) bool {
return id == clientId
})
go s.server.Start(serverPort, serverPath)
time.Sleep(100 * time.Millisecond)
// Test message
s.client = newWebsocketClient(s.T(), func(data []byte) ([]byte, error) {
s.Fail("no message should be received from server!")
return nil, nil
})
host := fmt.Sprintf("localhost:%v", serverPort)
// Set invalid client (not /ws/testws)
u := url.URL{Scheme: "ws", Host: host, Path: invalidTestPath}
// Attempt to connect and expect invalid client id error
err := s.client.Start(u.String())
s.Error(err)
var httpErr HttpConnectionError
ok := errors.As(err, &httpErr)
s.True(ok)
s.Equal(http.StatusUnauthorized, httpErr.HttpCode)
s.Equal("websocket: bad handshake", httpErr.Message)
// Re-attempt with correct client id
u = url.URL{Scheme: "ws", Host: host, Path: testPath}
err = s.client.Start(u.String())
s.NoError(err)
select {
case result := <-connected:
s.NotNil(result)
case <-time.After(1 * time.Second):
s.Fail("timeout waiting for client to connect")
}
}
func (s *WebSocketSuite) TestValidClientTLSCertificate() {
var ok bool
// Create self-signed TLS certificate
clientCertFilename := "/tmp/client.pem"
clientKeyFilename := "/tmp/client_key.pem"
// TODO: replace with FiloSottile's lib
err := createTLSCertificate(clientCertFilename, clientKeyFilename, "localhost", nil, nil)
s.NoError(err)
defer os.Remove(clientCertFilename)
defer os.Remove(clientKeyFilename)
serverCertFilename := "/tmp/cert.pem"
serverKeyFilename := "/tmp/key.pem"
err = createTLSCertificate(serverCertFilename, serverKeyFilename, "localhost", nil, nil)
s.NoError(err)
defer os.Remove(serverCertFilename)
defer os.Remove(serverKeyFilename)
// Create TLS server with self-signed certificate
certPool := x509.NewCertPool()
data, err := os.ReadFile(clientCertFilename)
s.NoError(err)
ok = certPool.AppendCertsFromPEM(data)
s.True(ok)
tlsServer := NewServer(WithServerTLSConfig(serverCertFilename, serverKeyFilename, &tls.Config{
ClientCAs: certPool,
ClientAuth: tls.RequireAndVerifyClientCert,
}))
s.server, ok = tlsServer.(*server)
s.True(ok)