-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebSocketTests.cs
More file actions
354 lines (298 loc) · 12 KB
/
Copy pathWebSocketTests.cs
File metadata and controls
354 lines (298 loc) · 12 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
using System.Net;
using System.Net.WebSockets;
using System.Text;
using Shiny.Net.HttpServer.WebSockets;
using ServerWebSocket = Shiny.Net.HttpServer.WebSockets.WebSocket;
using ServerCloseStatus = Shiny.Net.HttpServer.WebSockets.WebSocketCloseStatus;
namespace Shiny.Net.HttpServer.Tests;
/// <summary>
/// Tested against <see cref="ClientWebSocket"/> rather than a hand-rolled client. A framing bug that
/// only a matching hand-rolled client tolerates is exactly the bug worth catching, and the BCL
/// client is as unforgiving as a browser.
/// </summary>
public class WebSocketTests
{
static CancellationToken Token => TestContext.Current.CancellationToken;
static async Task<(TestServer Server, ClientWebSocket Client)> ConnectAsync(
Func<ServerWebSocket, Task> handle,
Action<WebSocketAcceptOptions>? configure = null,
Action<ClientWebSocket>? configureClient = null
)
{
var server = await TestServer.StartAsync(app => app.MapGet("/ws", async ctx =>
{
if (!ctx.Request.IsWebSocketRequest())
{
ctx.Response.StatusCode = StatusCodes.Status400BadRequest;
await ctx.Response.WriteAsync("not a websocket request");
return;
}
var options = new WebSocketAcceptOptions();
configure?.Invoke(options);
await using var socket = await ctx.AcceptWebSocketAsync(options, ctx.RequestAborted);
await handle(socket);
}));
var client = new ClientWebSocket();
configureClient?.Invoke(client);
await client.ConnectAsync(
new Uri($"ws://127.0.0.1:{server.Port}/ws"),
TestContext.Current.CancellationToken
);
return (server, client);
}
static async Task<string> ReceiveTextAsync(ClientWebSocket client, CancellationToken cancellationToken)
{
var buffer = new byte[64 * 1024];
var received = new List<byte>();
while (true)
{
var result = await client.ReceiveAsync(buffer, cancellationToken);
if (result.MessageType == WebSocketMessageType.Close)
return string.Empty;
received.AddRange(buffer.AsSpan(0, result.Count).ToArray());
if (result.EndOfMessage)
return Encoding.UTF8.GetString([.. received]);
}
}
[Fact]
public async Task Completes_the_handshake()
{
var (server, client) = await ConnectAsync(async socket =>
{
await socket.SendAsync("hello", CancellationToken.None);
await socket.CloseAsync(cancellationToken: CancellationToken.None);
});
await using (server)
using (client)
{
Assert.Equal(WebSocketState.Open, client.State);
Assert.Equal("hello", await ReceiveTextAsync(client, Token));
}
}
[Fact]
public void Computes_the_handshake_accept_value()
// The example from RFC 6455 §1.3, which is the whole point of a fixed test vector.
=> Assert.Equal("s3pPLMBiTxaQ9kYGzzhZRbK+xOo=", WebSocketExtensions.ComputeAccept("dGhlIHNhbXBsZSBub25jZQ=="));
[Fact]
public async Task Echoes_text_messages()
{
var (server, client) = await ConnectAsync(async socket =>
{
while (await socket.ReceiveAsync(CancellationToken.None) is { } message)
await socket.SendAsync($"echo:{message.Text}", CancellationToken.None);
});
await using (server)
using (client)
{
foreach (var text in (string[])["one", "two", "three"])
{
await client.SendAsync(Encoding.UTF8.GetBytes(text), WebSocketMessageType.Text, true, Token);
Assert.Equal($"echo:{text}", await ReceiveTextAsync(client, Token));
}
}
}
[Fact]
public async Task Carries_binary_messages()
{
var payload = new byte[4096];
Random.Shared.NextBytes(payload);
var (server, client) = await ConnectAsync(async socket =>
{
var message = await socket.ReceiveAsync(CancellationToken.None);
await socket.SendAsync(message!.Payload, CancellationToken.None);
});
await using (server)
using (client)
{
await client.SendAsync(payload, WebSocketMessageType.Binary, true, Token);
var buffer = new byte[8192];
var received = new List<byte>();
while (true)
{
var result = await client.ReceiveAsync(buffer, Token);
received.AddRange(buffer.AsSpan(0, result.Count).ToArray());
if (result.EndOfMessage)
break;
}
Assert.Equal(payload, received);
}
}
[Fact]
public async Task Reassembles_a_fragmented_message()
{
var (server, client) = await ConnectAsync(async socket =>
{
var message = await socket.ReceiveAsync(CancellationToken.None);
await socket.SendAsync($"{message!.Text.Length}", CancellationToken.None);
});
await using (server)
using (client)
{
// Three frames, one message: the client marks only the last as end-of-message.
await client.SendAsync("aaa"u8.ToArray(), WebSocketMessageType.Text, false, Token);
await client.SendAsync("bbb"u8.ToArray(), WebSocketMessageType.Text, false, Token);
await client.SendAsync("ccc"u8.ToArray(), WebSocketMessageType.Text, true, Token);
Assert.Equal("9", await ReceiveTextAsync(client, Token));
}
}
[Fact]
public async Task Sends_a_message_larger_than_one_frame_header_size()
{
// Crosses both the 126 and 65536 length encodings.
var text = new string('x', 100_000);
var (server, client) = await ConnectAsync(async socket =>
{
await socket.SendAsync(text, CancellationToken.None);
await socket.CloseAsync(cancellationToken: CancellationToken.None);
});
await using (server)
using (client)
Assert.Equal(text, await ReceiveTextAsync(client, Token));
}
[Fact]
public async Task Answers_a_ping_with_a_pong()
{
var pinged = new TaskCompletionSource();
var (server, client) = await ConnectAsync(async socket =>
{
// The client's keepalive ping is handled inside ReceiveAsync and never surfaces here.
await socket.ReceiveAsync(CancellationToken.None);
pinged.TrySetResult();
}, configureClient: c => c.Options.KeepAliveInterval = TimeSpan.FromMilliseconds(100));
await using (server)
using (client)
{
await client.SendAsync("after-ping"u8.ToArray(), WebSocketMessageType.Text, true, Token);
await pinged.Task.WaitAsync(TimeSpan.FromSeconds(10), Token);
}
}
[Fact]
public async Task Completes_the_close_handshake_from_the_client()
{
var closed = new TaskCompletionSource<WebSocketCloseResult?>();
var (server, client) = await ConnectAsync(async socket =>
{
while (await socket.ReceiveAsync(CancellationToken.None) is not null)
{
}
closed.TrySetResult(socket.CloseResult);
});
await using (server)
using (client)
{
await client.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus.NormalClosure, "done", Token);
var result = await closed.Task.WaitAsync(TimeSpan.FromSeconds(10), Token);
Assert.NotNull(result);
Assert.Equal(ServerCloseStatus.NormalClosure, result.Status);
Assert.Equal("done", result.Description);
}
}
[Fact]
public async Task Closes_cleanly_from_the_server()
{
var (server, client) = await ConnectAsync(async socket =>
await socket.CloseAsync(
ServerCloseStatus.EndpointUnavailable,
"going away",
CancellationToken.None
));
await using (server)
using (client)
{
var result = await client.ReceiveAsync(new byte[64], Token);
Assert.Equal(WebSocketMessageType.Close, result.MessageType);
Assert.Equal(System.Net.WebSockets.WebSocketCloseStatus.EndpointUnavailable, result.CloseStatus);
Assert.Equal("going away", result.CloseStatusDescription);
}
}
[Fact]
public async Task Negotiates_a_sub_protocol()
{
var (server, client) = await ConnectAsync(
async socket =>
{
await socket.SendAsync(socket.SubProtocol ?? "(none)", CancellationToken.None);
await socket.CloseAsync(cancellationToken: CancellationToken.None);
},
configure: o =>
{
o.SupportedSubProtocols.Add("chat.v2");
o.SupportedSubProtocols.Add("chat.v1");
},
configureClient: c =>
{
c.Options.AddSubProtocol("chat.v1");
c.Options.AddSubProtocol("chat.v2");
}
);
await using (server)
using (client)
{
// The server's preference order wins: it is the side that knows what it can do.
Assert.Equal("chat.v2", client.SubProtocol);
Assert.Equal("chat.v2", await ReceiveTextAsync(client, Token));
}
}
[Fact]
public async Task Rejects_a_plain_get_on_a_websocket_route()
{
await using var server = await TestServer.StartAsync(app => app.MapGet("/ws", async ctx =>
{
if (!ctx.Request.IsWebSocketRequest())
{
ctx.Response.StatusCode = StatusCodes.Status400BadRequest;
await ctx.Response.WriteAsync("not a websocket request");
return;
}
await using var socket = await ctx.AcceptWebSocketAsync(cancellationToken: ctx.RequestAborted);
}));
var response = await server.Client.GetAsync("/ws", Token);
Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
Assert.Equal("not a websocket request", await response.Content.ReadAsStringAsync(Token));
}
[Fact]
public async Task Refuses_a_message_over_the_configured_limit()
{
var faulted = new TaskCompletionSource<string>();
var (server, client) = await ConnectAsync(
async socket =>
{
try
{
await socket.ReceiveAsync(CancellationToken.None);
faulted.TrySetResult("no error");
}
catch (WebSocketProtocolException ex)
{
faulted.TrySetResult(ex.Status.ToString());
}
},
configure: o => o.MaxMessageLength = 1024
);
await using (server)
using (client)
{
await client.SendAsync(new byte[8192], WebSocketMessageType.Binary, true, Token);
Assert.Equal("MessageTooBig", await faulted.Task.WaitAsync(TimeSpan.FromSeconds(10), Token));
}
}
[Fact]
public async Task Serves_ordinary_requests_on_the_same_server()
{
await using var server = await TestServer.StartAsync(app =>
{
app.MapGet("/ping", ctx => ctx.Response.WriteAsync("pong"));
app.MapGet("/ws", async ctx =>
{
await using var socket = await ctx.AcceptWebSocketAsync(cancellationToken: ctx.RequestAborted);
await socket.SendAsync("hi", CancellationToken.None);
await socket.CloseAsync(cancellationToken: CancellationToken.None);
});
});
using var client = new ClientWebSocket();
await client.ConnectAsync(new Uri($"ws://127.0.0.1:{server.Port}/ws"), Token);
Assert.Equal("hi", await ReceiveTextAsync(client, Token));
// The upgrade took over one connection, not the listener.
Assert.Equal("pong", await server.Client.GetStringAsync("/ping", Token));
}
}