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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2019 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import XCTest
@testable import NIO
import NIOHTTP1
@testable import NIOWebSocket
extension EmbeddedChannel {
func readAllInboundBuffers() throws -> ByteBuffer {
var buffer = self.allocator.buffer(capacity: 100)
while var writtenData: ByteBuffer = try self.readInbound() {
buffer.writeBuffer(&writtenData)
}
return buffer
}
func finishAcceptingAlreadyClosed() throws {
do {
let result = try self.finish().isClean
XCTAssertTrue(result)
} catch ChannelError.alreadyClosed {
// ok
}
}
}
extension ByteBuffer {
func allAsString() -> String {
return self.getString(at: self.readerIndex, length: self.readableBytes)!
}
}
extension EmbeddedChannel {
func writeString(_ string: String) -> EventLoopFuture<Void> {
return self.writeAndFlush(self.allocator.buffer(string: string))
}
}
private func interactInMemory(_ first: EmbeddedChannel,
_ second: EmbeddedChannel,
eventLoop: EmbeddedEventLoop) throws {
var operated: Bool
repeat {
eventLoop.run()
operated = false
if let data = try first.readOutbound(as: ByteBuffer.self) {
operated = true
try second.writeInbound(data)
}
if let data = try second.readOutbound(as: ByteBuffer.self) {
operated = true
try first.writeInbound(data)
}
} while operated
}
private func assertResponseIs(response: String, expectedResponseLine: String, expectedResponseHeaders: [String]) {
var lines = response.split(separator: "\r\n", omittingEmptySubsequences: false).map { String($0) }
// We never expect a response body here. This means we need the last two entries to be empty strings.
XCTAssertEqual("", lines.removeLast())
XCTAssertEqual("", lines.removeLast())
// Check the response line is correct.
let actualResponseLine = lines.removeFirst()
XCTAssertEqual(expectedResponseLine, actualResponseLine)
// For each header, find it in the actual response headers and remove it.
for expectedHeader in expectedResponseHeaders {
guard let index = lines.firstIndex(of: expectedHeader) else {
XCTFail("Could not find header \"\(expectedHeader)\"")
return
}
lines.remove(at: index)
}
// That should be all the headers.
XCTAssertEqual(lines.count, 0)
}
private class WebSocketRecorderHandler: ChannelInboundHandler {
typealias InboundIn = WebSocketFrame
typealias OutboundOut = WebSocketFrame
fileprivate var frames: [WebSocketFrame] = []
fileprivate var errors: [Error] = []
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
let frame = self.unwrapInboundIn(data)
self.frames.append(frame)
}
func errorCaught(context: ChannelHandlerContext, error: Error) {
self.errors.append(error)
context.fireErrorCaught(error)
}
}
class WebSocketServerEndToEndTests: XCTestCase {
private func createTestFixtures(upgraders: [NIOWebSocketServerUpgrader]) -> (loop: EmbeddedEventLoop, serverChannel: EmbeddedChannel, clientChannel: EmbeddedChannel) {
let loop = EmbeddedEventLoop()
let serverChannel = EmbeddedChannel(loop: loop)
let upgradeConfig = (upgraders: upgraders as [HTTPServerProtocolUpgrader], completionHandler: { (context: ChannelHandlerContext) in } )
XCTAssertNoThrow(try serverChannel.pipeline.configureHTTPServerPipeline(withServerUpgrade: upgradeConfig).wait())
let clientChannel = EmbeddedChannel(loop: loop)
return (loop: loop, serverChannel: serverChannel, clientChannel: clientChannel)
}
private func upgradeRequest(path: String = "/", extraHeaders: [String: String], protocolName: String = "websocket") -> String {
let extraHeaderString = extraHeaders.map { hdr in "\(hdr.key): \(hdr.value)" }.joined(separator: "\r\n")
return "GET \(path) HTTP/1.1\r\nHost: example.com\r\nConnection: upgrade\r\nUpgrade: \(protocolName)\r\n" + extraHeaderString + "\r\n\r\n"
}
func testBasicUpgradeDance() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
loop.run()
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
}
func testUpgradeWithProtocolName() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="], protocolName: "WebSocket")
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
}
func testCanRejectUpgrade() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(nil) },
upgradePipelineHandler: { (channel, req) in
XCTFail("Should not have called")
return channel.eventLoop.makeSucceededFuture(())
}
)
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
let buffer = server.allocator.buffer(string: upgradeRequest)
// Write this directly to the server.
XCTAssertThrowsError(try server.writeInbound(buffer)) { error in
XCTAssertEqual(.unsupportedWebSocketTarget, error as? NIOWebSocketUpgradeError)
}
// Nothing gets written.
XCTAssertNoThrow(XCTAssertEqual(try server.readAllOutboundBuffers().allAsString(), ""))
}
func testCanDelayAcceptingUpgrade() throws {
// This accept promise is going to be written to from a callback. This is only safe because we use
// embedded channels.
var acceptPromise: EventLoopPromise<HTTPHeaders?>? = nil
var upgradeComplete = false
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in
acceptPromise = channel.eventLoop.makePromise()
return acceptPromise!.futureResult
},
upgradePipelineHandler: { (channel, req) in
upgradeComplete = true
return channel.eventLoop.makeSucceededFuture(())
})
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
XCTAssertNil(acceptPromise)
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNotNil(acceptPromise)
// No upgrade should have occurred yet.
XCTAssertNoThrow(XCTAssertNil(try client.readInbound(as: ByteBuffer.self)))
XCTAssertFalse(upgradeComplete)
// Satisfy the promise. This will cause the upgrade to complete.
acceptPromise?.succeed(HTTPHeaders())
loop.run()
XCTAssertTrue(upgradeComplete)
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
}
func testRequiresVersion13() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "12", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
let buffer = server.allocator.buffer(string: upgradeRequest)
// Write this directly to the server.
XCTAssertThrowsError(try server.writeInbound(buffer)) { error in
XCTAssertEqual(.invalidUpgradeHeader, error as? NIOWebSocketUpgradeError)
}
// Nothing gets written.
XCTAssertNoThrow(XCTAssertEqual(try server.readAllOutboundBuffers().allAsString(), ""))
}
func testRequiresVersionHeader() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
let buffer = server.allocator.buffer(string: upgradeRequest)
// Write this directly to the server.
XCTAssertThrowsError(try server.writeInbound(buffer)) { error in
XCTAssertEqual(.invalidUpgradeHeader, error as? NIOWebSocketUpgradeError)
}
// Nothing gets written.
XCTAssertNoThrow(XCTAssertEqual(try server.readAllOutboundBuffers().allAsString(), ""))
}
func testRequiresKeyHeader() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13"])
let buffer = server.allocator.buffer(string: upgradeRequest)
// Write this directly to the server.
XCTAssertThrowsError(try server.writeInbound(buffer)) { error in
XCTAssertEqual(.invalidUpgradeHeader, error as? NIOWebSocketUpgradeError)
}
// Nothing gets written.
XCTAssertNoThrow(XCTAssertEqual(try server.readAllOutboundBuffers().allAsString(), ""))
}
func testUpgradeMayAddCustomHeaders() throws {
let upgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in
var hdrs = HTTPHeaders()
hdrs.add(name: "TestHeader", value: "TestValue")
return channel.eventLoop.makeSucceededFuture(hdrs)
},
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
let (loop, server, client) = self.createTestFixtures(upgraders: [upgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade", "TestHeader: TestValue"]))
}
func testMayRegisterMultipleWebSocketEndpoints() throws {
func buildHandler(path: String) -> NIOWebSocketServerUpgrader {
return NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in
guard head.uri == "/\(path)" else { return channel.eventLoop.makeSucceededFuture(nil) }
var hdrs = HTTPHeaders()
hdrs.add(name: "Target", value: path)
return channel.eventLoop.makeSucceededFuture(hdrs)
},
upgradePipelineHandler: { (channel, req) in channel.eventLoop.makeSucceededFuture(()) })
}
let first = buildHandler(path: "first")
let second = buildHandler(path: "second")
let third = buildHandler(path: "third")
let (loop, server, client) = self.createTestFixtures(upgraders: [first, second, third])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(path: "/third", extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade", "Target: third"]))
}
func testSendAFewFrames() throws {
let recorder = WebSocketRecorderHandler()
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in
channel.pipeline.addHandler(recorder)
})
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
// Put a frame encoder in the client pipeline.
XCTAssertNoThrow(try client.pipeline.addHandler(WebSocketFrameEncoder()).wait())
var data = client.allocator.buffer(capacity: 12)
data.writeString("hello, world")
// Let's send a frame or two, to confirm that this works.
let dataFrame = WebSocketFrame(fin: true, opcode: .binary, data: data)
XCTAssertNoThrow(try client.writeAndFlush(dataFrame).wait())
let pingFrame = WebSocketFrame(fin: true, opcode: .ping, data: client.allocator.buffer(capacity: 0))
XCTAssertNoThrow(try client.writeAndFlush(pingFrame).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertEqual(recorder.frames, [dataFrame, pingFrame])
}
func testMaxFrameSize() throws {
let basicUpgrader = NIOWebSocketServerUpgrader(maxFrameSize: 16, shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in
return channel.eventLoop.makeSucceededFuture(())
})
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finish())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
let decoder = ((try server.pipeline.context(handlerType: ByteToMessageHandler<WebSocketFrameDecoder>.self).wait()).handler as! ByteToMessageHandler<WebSocketFrameDecoder>).decoder
XCTAssertEqual(16, decoder?.maxFrameSize)
}
func testAutomaticErrorHandling() throws {
let recorder = WebSocketRecorderHandler()
let basicUpgrader = NIOWebSocketServerUpgrader(shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in
channel.pipeline.addHandler(recorder)
})
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finishAcceptingAlreadyClosed())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
// Send a fake frame header that claims this is a ping frame with 126 bytes of data.
var data = client.allocator.buffer(capacity: 12)
data.writeBytes([0x89, 0x7E, 0x00, 0x7E])
XCTAssertNoThrow(try client.writeAndFlush(data).wait())
XCTAssertThrowsError(try interactInMemory(client, server, eventLoop: loop)) { error in
XCTAssertEqual(NIOWebSocketError.multiByteControlFrameLength, error as? NIOWebSocketError)
}
XCTAssertEqual(recorder.errors.count, 1)
XCTAssertEqual(recorder.errors.first as? NIOWebSocketError, .some(.multiByteControlFrameLength))
// The client should have received a close frame, if we'd continued interacting.
XCTAssertNoThrow(XCTAssertEqual(try server.readAllOutboundBytes(), [0x88, 0x02, 0x03, 0xEA]))
}
func testNoAutomaticErrorHandling() throws {
let recorder = WebSocketRecorderHandler()
let basicUpgrader = NIOWebSocketServerUpgrader(automaticErrorHandling: false,
shouldUpgrade: { (channel, head) in channel.eventLoop.makeSucceededFuture(HTTPHeaders()) },
upgradePipelineHandler: { (channel, req) in
channel.pipeline.addHandler(recorder)
})
let (loop, server, client) = self.createTestFixtures(upgraders: [basicUpgrader])
defer {
XCTAssertNoThrow(try client.finish())
XCTAssertNoThrow(try server.finishAcceptingAlreadyClosed())
XCTAssertNoThrow(try loop.syncShutdownGracefully())
}
let upgradeRequest = self.upgradeRequest(extraHeaders: ["Sec-WebSocket-Version": "13", "Sec-WebSocket-Key": "AQIDBAUGBwgJCgsMDQ4PEC=="])
XCTAssertNoThrow(try client.writeString(upgradeRequest).wait())
XCTAssertNoThrow(try interactInMemory(client, server, eventLoop: loop))
XCTAssertNoThrow(assertResponseIs(response: try client.readAllInboundBuffers().allAsString(),
expectedResponseLine: "HTTP/1.1 101 Switching Protocols",
expectedResponseHeaders: ["Upgrade: websocket", "Sec-WebSocket-Accept: OfS0wDaT5NoxF2gqm7Zj2YtetzM=", "Connection: upgrade"]))
// Send a fake frame header that claims this is a ping frame with 126 bytes of data.
var data = client.allocator.buffer(capacity: 12)
data.writeBytes([0x89, 0x7E, 0x00, 0x7E])
XCTAssertNoThrow(try client.writeAndFlush(data).wait())
XCTAssertThrowsError(try interactInMemory(client, server, eventLoop: loop)) { error in
XCTAssertEqual(NIOWebSocketError.multiByteControlFrameLength, error as? NIOWebSocketError)
}
XCTAssertEqual(recorder.errors.count, 1)
XCTAssertEqual(recorder.errors.first as? NIOWebSocketError, .some(.multiByteControlFrameLength))
// The client should not have received a close frame, if we'd continued interacting.
XCTAssertNoThrow(XCTAssertEqual([], try server.readAllOutboundBytes()))
}
}
|
