Skip to content

Commit 08bba6e

Browse files
eloylpeloylp
committed
Refactor, simeplify test helper names
1 parent 5f7cec2 commit 08bba6e

15 files changed

+81
-78
lines changed

Diff for: ‎broadcast_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ func TestServerSideBroadcast(t *testing.T) {
1818
t.Parallel()
1919

2020
arbiter := test.NewArbiter(t)
21-
s, waitAndRun := PrepareServer(t)
21+
s, waitAndRun := Server(t)
2222
waitAndRun()
2323
defer s.Shutdown(defaultCtx)
2424

25-
c1, connect1 := PrepareClient(t, client.WithServerAddr(s.Addr()))
25+
c1, connect1 := Client(t, client.WithServerAddr(s.Addr()))
2626
defer c1.Close(defaultCtx)
2727
c1.Handle(defaultMsg.Payload, message.HandlerFunc(func(ops message.Sender, msg *message.Message) {
2828
arbiter.ItsAFactThat("CLIENT1_RECEIVED_SERVER_GREET")
2929
}))
3030
connect1()
31-
c2, connect2 := PrepareClient(t, client.WithServerAddr(s.Addr()))
31+
c2, connect2 := Client(t, client.WithServerAddr(s.Addr()))
3232
defer c2.Close(defaultCtx)
3333
c2.Handle(defaultMsg.Payload, message.HandlerFunc(func(ops message.Sender, msg *message.Message) {
3434
arbiter.ItsAFactThat("CLIENT2_RECEIVED_SERVER_GREET")
@@ -49,18 +49,18 @@ func TestClientSideBroadCast(t *testing.T) {
4949
t.Parallel()
5050

5151
arbiter := test.NewArbiter(t)
52-
s, waitAndRun := PrepareServer(t, server.WithOnErrorHook(noErrorHook(arbiter)))
52+
s, waitAndRun := Server(t, server.WithOnErrorHook(noErrorHook(arbiter)))
5353
s.RegisterMessage(defaultMsg.Payload)
5454
waitAndRun()
5555
defer s.Shutdown(defaultCtx)
5656

57-
c1, connect1 := PrepareClient(t, client.WithServerAddr(s.Addr()), client.WithOnErrorHook(noErrorHook(arbiter)))
57+
c1, connect1 := Client(t, client.WithServerAddr(s.Addr()), client.WithOnErrorHook(noErrorHook(arbiter)))
5858
defer c1.Close(defaultCtx)
5959
c1.Handle(defaultMsg.Payload, message.HandlerFunc(func(ops message.Sender, msg *message.Message) {
6060
arbiter.ItsAFactThat("CLIENT1_RECEIVED_SERVER_GREET")
6161
}))
6262
connect1()
63-
c2, connect2 := PrepareClient(t, client.WithServerAddr(s.Addr()))
63+
c2, connect2 := Client(t, client.WithServerAddr(s.Addr()))
6464
defer c2.Close(defaultCtx)
6565
c2.Handle(defaultMsg.Payload, message.HandlerFunc(func(ops message.Sender, msg *message.Message) {
6666
arbiter.ItsAFactThat("CLIENT2_RECEIVED_SERVER_GREET")

Diff for: ‎chaos_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ func TestClientReturnsKnownErrOnConnFailure(t *testing.T) {
1818

1919
arbiter := test.NewArbiter(t)
2020

21-
s, run := PrepareServer(t)
21+
s, run := Server(t)
2222
s.Handle(defaultMsg.Payload, echoHandler)
2323
run()
2424
defer s.Shutdown(defaultCtx)
@@ -27,7 +27,7 @@ func TestClientReturnsKnownErrOnConnFailure(t *testing.T) {
2727
require.NoError(t, err)
2828
defer goomerangProxy.Delete()
2929

30-
c, connect := PrepareClient(t,
30+
c, connect := Client(t,
3131
client.WithServerAddr(goomerangProxy.Listen),
3232
client.WithOnCloseHook(func() {
3333
arbiter.ItsAFactThat("CLIENT_ONCLOSE_HOOK")

Diff for: ‎goomerang_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020

2121
func TestRoundTrip(t *testing.T) {
2222
arbiter := test.NewArbiter(t)
23-
s, run := PrepareServer(t)
23+
s, run := Server(t)
2424
defer s.Shutdown(defaultCtx)
2525

2626
s.Handle(defaultMsg.Payload, message.HandlerFunc(func(s message.Sender, msg *message.Message) {
@@ -31,7 +31,7 @@ func TestRoundTrip(t *testing.T) {
3131
arbiter.ItsAFactThat("SERVER_RECEIVED_MSG")
3232
}))
3333
run()
34-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
34+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
3535
defer c.Close(defaultCtx)
3636

3737
c.Handle(defaultMsg.Payload, message.HandlerFunc(func(c message.Sender, msg *message.Message) {
@@ -69,7 +69,7 @@ func TestSecuredRoundTrip(t *testing.T) {
6969
run()
7070
certPool := x509.NewCertPool()
7171
certPool.AddCert(certificate.Leaf)
72-
c, connect := PrepareClient(t,
72+
c, connect := Client(t,
7373
client.WithServerAddr(s.Addr()),
7474
client.WithTLSConfig(&tls.Config{
7575
RootCAs: certPool,
@@ -91,7 +91,7 @@ func TestSecuredRoundTrip(t *testing.T) {
9191

9292
func TestMiddlewares(t *testing.T) {
9393
arbiter := test.NewArbiter(t)
94-
s, run := PrepareServer(t)
94+
s, run := Server(t)
9595
defer s.Shutdown(defaultCtx)
9696
s.Middleware(func(h message.Handler) message.Handler {
9797
return message.HandlerFunc(func(s message.Sender, msg *message.Message) {
@@ -108,7 +108,7 @@ func TestMiddlewares(t *testing.T) {
108108
}
109109
}))
110110
run()
111-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
111+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
112112
defer c.Close(defaultCtx)
113113

114114
c.Middleware(func(h message.Handler) message.Handler {
@@ -135,7 +135,7 @@ func TestMiddlewares(t *testing.T) {
135135

136136
func TestHeadersAreSent(t *testing.T) {
137137
arbiter := test.NewArbiter(t)
138-
s, run := PrepareServer(t)
138+
s, run := Server(t)
139139
defer s.Shutdown(defaultCtx)
140140

141141
m := defaultMsg.Payload
@@ -149,7 +149,7 @@ func TestHeadersAreSent(t *testing.T) {
149149
}))
150150
run()
151151

152-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
152+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
153153
defer c.Close(defaultCtx)
154154

155155
c.Handle(m, message.HandlerFunc(func(sender message.Sender, msg *message.Message) {
@@ -170,7 +170,7 @@ func TestHeadersAreSent(t *testing.T) {
170170
}
171171

172172
func TestUserCanAccessServerRegistry(t *testing.T) {
173-
s, _ := PrepareServer(t)
173+
s, _ := Server(t)
174174
s.Handle(defaultMsg.Payload, nilHandler)
175175
msg, err := s.Registry().Message(defaultMsg.Metadata.Kind)
176176
require.NoError(t, err)

Diff for: ‎helper_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func mustWaitTCPService(addr string, interval, maxWait time.Duration) {
6767
}
6868
}
6969

70-
func PrepareServer(t *testing.T, opts ...server.Option) (s *server.Server, run func()) {
70+
func Server(t *testing.T, opts ...server.Option) (s *server.Server, run func()) {
7171
t.Helper()
7272
is := configureServer(t, opts)
7373
return is, func() {
@@ -114,7 +114,7 @@ func PrepareTLSServer(t *testing.T, opts ...server.Option) (s *server.Server, ru
114114
}
115115
}
116116

117-
func PrepareClient(t *testing.T, opts ...client.Option) (c *client.Client, connect func()) {
117+
func Client(t *testing.T, opts ...client.Option) (c *client.Client, connect func()) {
118118
c, err := client.New(opts...)
119119
if err != nil {
120120
t.Fatal(err)

Diff for: ‎lifecycle_client_test.go

+16-16
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ func TestShutdownProcedureClientSideInit(t *testing.T) {
2222
serverArbiter := test.NewArbiter(t)
2323
clientArbiter := test.NewArbiter(t)
2424

25-
s, run := PrepareServer(t, server.WithOnCloseHook(func() {
25+
s, run := Server(t, server.WithOnCloseHook(func() {
2626
serverArbiter.ItsAFactThat("SERVER_PROPERLY_CLOSED")
2727
}),
2828
server.WithOnStatusChangeHook(statusChangesHook(serverArbiter, "server")),
2929
server.WithOnErrorHook(noErrorHook(serverArbiter)),
3030
)
3131
run()
3232

33-
c, connect := PrepareClient(t,
33+
c, connect := Client(t,
3434
client.WithServerAddr(s.Addr()),
3535
client.WithOnCloseHook(func() {
3636
clientArbiter.ItsAFactThat("CLIENT_PROPERLY_CLOSED")
@@ -68,20 +68,20 @@ func TestShutdownProcedureClientSideInit(t *testing.T) {
6868
func TestClientNormalClose(t *testing.T) {
6969
t.Parallel()
7070

71-
s, run := PrepareServer(t)
71+
s, run := Server(t)
7272
defer s.Shutdown(defaultCtx)
7373
run()
74-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
74+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
7575
connect()
7676
require.NoError(t, c.Close(defaultCtx))
7777
}
7878

7979
func TestClientShouldBeClosedWhenServerCloses(t *testing.T) {
8080
t.Parallel()
8181

82-
s, run := PrepareServer(t)
82+
s, run := Server(t)
8383
run()
84-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
84+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
8585
connect()
8686
err := s.Shutdown(defaultCtx)
8787
require.NoError(t, err)
@@ -93,11 +93,11 @@ func TestClientShouldBeClosedWhenServerCloses(t *testing.T) {
9393
func TestClientCanBeResumed(t *testing.T) {
9494
t.Parallel()
9595

96-
s, run := PrepareServer(t)
96+
s, run := Server(t)
9797
defer s.Shutdown(defaultCtx)
9898
run()
9999

100-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
100+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
101101
connect()
102102

103103
require.NoError(t, c.Close(defaultCtx))
@@ -108,11 +108,11 @@ func TestClientCanBeResumed(t *testing.T) {
108108
func TestClientCannotConnectForSecondTime(t *testing.T) {
109109
t.Parallel()
110110

111-
s, run := PrepareServer(t)
111+
s, run := Server(t)
112112
defer s.Shutdown(defaultCtx)
113113
run()
114114

115-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
115+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
116116
connect()
117117
defer c.Close(defaultCtx)
118118

@@ -122,12 +122,12 @@ func TestClientCannotConnectForSecondTime(t *testing.T) {
122122
func TestClientCannotSendMessagesIfNotRunning(t *testing.T) {
123123
t.Parallel()
124124

125-
s, run := PrepareServer(t)
125+
s, run := Server(t)
126126
defer s.Shutdown(defaultCtx)
127127
run()
128128

129129
// Cannot send if not connected
130-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
130+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
131131
_, err := c.Send(defaultMsg)
132132
assert.ErrorIs(t, err, client.ErrNotRunning, "should not send messages if not connected")
133133

@@ -150,11 +150,11 @@ func TestClientCannotSendMessagesIfNotRunning(t *testing.T) {
150150
func TestClientCannotShutdownIfNotRunning(t *testing.T) {
151151
t.Parallel()
152152

153-
s, run := PrepareServer(t)
153+
s, run := Server(t)
154154
run()
155155
defer s.Shutdown(defaultCtx)
156156

157-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
157+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
158158
assert.ErrorIs(t, c.Close(defaultCtx), client.ErrNotRunning, "should not shutdown if not running")
159159
connect()
160160
require.NoError(t, c.Close(defaultCtx))
@@ -166,10 +166,10 @@ func TestClientHandlerCannotSendIfClosed(t *testing.T) {
166166
t.Parallel()
167167

168168
arbiter := test.NewArbiter(t)
169-
s, run := PrepareServer(t)
169+
s, run := Server(t)
170170
run()
171171
defer s.Shutdown(defaultCtx)
172-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
172+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
173173
c.Handle(defaultMsg.Payload, message.HandlerFunc(func(s message.Sender, msg *message.Message) {
174174
// Let's wait the close before sending.
175175
// We expect an error here.

Diff for: ‎lifecycle_server_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ func TestShutdownProcedureServerSideInit(t *testing.T) {
2121
serverArbiter := test.NewArbiter(t)
2222
clientArbiter := test.NewArbiter(t)
2323

24-
s, run := PrepareServer(t, server.WithOnCloseHook(func() {
24+
s, run := Server(t, server.WithOnCloseHook(func() {
2525
serverArbiter.ItsAFactThat("SERVER_PROPERLY_CLOSED")
2626
}),
2727
server.WithOnStatusChangeHook(statusChangesHook(serverArbiter, "server")),
2828
server.WithOnErrorHook(noErrorHook(serverArbiter)),
2929
)
3030
run()
31-
_, connect := PrepareClient(t,
31+
_, connect := Client(t,
3232
client.WithServerAddr(s.Addr()),
3333
client.WithOnCloseHook(func() {
3434
clientArbiter.ItsAFactThat("CLIENT_PROPERLY_CLOSED")
@@ -67,18 +67,18 @@ func TestServerSendsCloseToAllClients(t *testing.T) {
6767
errHook := func(err error) {
6868
arbiter.ErrorHappened(err)
6969
}
70-
s, run := PrepareServer(t, server.WithOnErrorHook(errHook))
70+
s, run := Server(t, server.WithOnErrorHook(errHook))
7171
run()
7272

73-
_, connect1 := PrepareClient(t,
73+
_, connect1 := Client(t,
7474
client.WithServerAddr(s.Addr()),
7575
client.WithOnErrorHook(errHook),
7676
client.WithOnCloseHook(func() {
7777
arbiter.ItsAFactThat("CLIENT1_RECEIVED_CLOSE")
7878
}))
7979
connect1()
8080

81-
_, connect2 := PrepareClient(t,
81+
_, connect2 := Client(t,
8282
client.WithServerAddr(s.Addr()),
8383
client.WithOnErrorHook(errHook),
8484
client.WithOnCloseHook(func() {
@@ -96,7 +96,7 @@ func TestServerSendsCloseToAllClients(t *testing.T) {
9696
func TestServerCannotSendMessagesIfNotRunning(t *testing.T) {
9797
t.Parallel()
9898

99-
s, run := PrepareServer(t)
99+
s, run := Server(t)
100100

101101
_, err := s.Broadcast(defaultCtx, defaultMsg)
102102
assert.ErrorIs(t, err, server.ErrNotRunning, "should not broadcast messages if not connected")
@@ -113,15 +113,15 @@ func TestServerCannotSendMessagesIfNotRunning(t *testing.T) {
113113
func TestServerCannotShutdownIfNotRunning(t *testing.T) {
114114
t.Parallel()
115115

116-
s, _ := PrepareServer(t)
116+
s, _ := Server(t)
117117
err := s.Shutdown(defaultCtx)
118118
assert.ErrorIs(t, err, server.ErrNotRunning, "should not shutdown if not running")
119119
}
120120

121121
func TestServerCannotShutdownIfClosed(t *testing.T) {
122122
t.Parallel()
123123

124-
s, run := PrepareServer(t)
124+
s, run := Server(t)
125125
run()
126126
err := s.Shutdown(defaultCtx)
127127
require.NoError(t, err)
@@ -132,7 +132,7 @@ func TestServerCannotShutdownIfClosed(t *testing.T) {
132132
func TestServerCannotRunIfAlreadyRunning(t *testing.T) {
133133
t.Parallel()
134134

135-
s, run := PrepareServer(t)
135+
s, run := Server(t)
136136
run()
137137
defer s.Shutdown(defaultCtx)
138138
err := s.Run()
@@ -142,7 +142,7 @@ func TestServerCannotRunIfAlreadyRunning(t *testing.T) {
142142
func TestServerCannotRunIfAlreadyClosed(t *testing.T) {
143143
t.Parallel()
144144

145-
s, run := PrepareServer(t)
145+
s, run := Server(t)
146146
run()
147147
require.NoError(t, s.Shutdown(defaultCtx))
148148
err := s.Run()
@@ -153,7 +153,7 @@ func TestServerHandlerCannotSendIfClosed(t *testing.T) {
153153
t.Parallel()
154154

155155
arbiter := test.NewArbiter(t)
156-
s, run := PrepareServer(t)
156+
s, run := Server(t)
157157
s.Handle(defaultMsg.Payload, message.HandlerFunc(func(s message.Sender, msg *message.Message) {
158158
// We wait for the closed state to send,
159159
// as we expect an error.
@@ -163,7 +163,7 @@ func TestServerHandlerCannotSendIfClosed(t *testing.T) {
163163
}
164164
}))
165165
run()
166-
c, connect := PrepareClient(t, client.WithServerAddr(s.Addr()))
166+
c, connect := Client(t, client.WithServerAddr(s.Addr()))
167167
connect()
168168
defer c.Close(defaultCtx)
169169
// We send the message, in order to invoke the handler.

Diff for: ‎long_running_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func TestNoErrorsTransferringMessages(t *testing.T) {
2222

2323
// Server
2424
serverArbiter := test.NewArbiter(t)
25-
s, run := PrepareServer(t, server.WithOnErrorHook(noErrorHook(serverArbiter)))
25+
s, run := Server(t, server.WithOnErrorHook(noErrorHook(serverArbiter)))
2626
s.Handle(defaultMsg.Payload, message.HandlerFunc(func(sender message.Sender, msg *message.Message) {
2727
reply := &protos.ReplyV1{
2828
Message: "return back !",
@@ -36,7 +36,7 @@ func TestNoErrorsTransferringMessages(t *testing.T) {
3636
// Client
3737
clientArbiter := test.NewArbiter(t)
3838

39-
c, connect := PrepareClient(t,
39+
c, connect := Client(t,
4040
client.WithServerAddr(s.Addr()),
4141
client.WithOnErrorHook(noErrorHook(clientArbiter)),
4242
)

Diff for: ‎message/message_test.go

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ func messageFixture() *message.Message {
5454

5555
func TestMessageText(t *testing.T) {
5656
msg := messageFixture()
57+
// We need to assert multiple outputs, as the headers are a map, so the output is unordered.
5758
possibleOutput1 := `metadata: creation=1970-01-01 00:00:00.001 +0000 UTC,uuid=09AF,kind=goomerang.example.MessageV1,payloadSize=10,isSync=true headers: k1=v1,k2=v2 - payload: message:"Hi !"`
5859
possibleOutput2 := `metadata: creation=1970-01-01 00:00:00.001 +0000 UTC,uuid=09AF,kind=goomerang.example.MessageV1,payloadSize=10,isSync=true headers: k2=v2,k1=v1 - payload: message:"Hi !"`
5960
textMsg := msg.String()

0 commit comments

Comments
 (0)