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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2018 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
//
//===----------------------------------------------------------------------===//
@testable import NIO
import XCTest
class ChannelNotificationTest: XCTestCase {
private static func assertFulfilled(promise: EventLoopPromise<Void>?, promiseName: String, trigger: String, setter: String, file: StaticString = #file, line: UInt = #line) {
if let promise = promise {
XCTAssertTrue(promise.futureResult.isFulfilled, "\(promiseName) not fulfilled before \(trigger) was called", file: (file), line: line)
} else {
XCTFail("\(setter) not called before \(trigger)", file: (file), line: line)
}
}
// Handler that verifies the notification order of the different promises + the inbound events that are fired.
class SocketChannelLifecycleVerificationHandler: ChannelDuplexHandler {
typealias InboundIn = Any
typealias OutboundIn = Any
private var registerPromise: EventLoopPromise<Void>?
private var connectPromise: EventLoopPromise<Void>?
private var closePromise: EventLoopPromise<Void>?
public func channelActive(context: ChannelHandlerContext) {
XCTAssertTrue(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelActive", setter: "register")
assertFulfilled(promise: self.connectPromise, promiseName: "connectPromise", trigger: "channelActive", setter: "connect")
XCTAssertNil(self.closePromise)
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelInactive(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelInactive", setter: "register")
assertFulfilled(promise: self.connectPromise, promiseName: "connectPromise", trigger: "channelInactive", setter: "connect")
assertFulfilled(promise: self.closePromise, promiseName: "closePromise", trigger: "channelInactive", setter: "close")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelRegistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
XCTAssertNil(self.connectPromise)
XCTAssertNil(self.closePromise)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelRegistered", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelUnregistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelInactive", setter: "register")
assertFulfilled(promise: self.connectPromise, promiseName: "connectPromise", trigger: "channelInactive", setter: "connect")
assertFulfilled(promise: self.closePromise, promiseName: "closePromise", trigger: "channelInactive", setter: "close")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func register(context: ChannelHandlerContext, promise: EventLoopPromise<Void>?) {
XCTAssertNil(self.registerPromise)
XCTAssertNil(self.connectPromise)
XCTAssertNil(self.closePromise)
promise!.futureResult.whenSuccess {
XCTAssertFalse(context.channel.isActive)
}
self.registerPromise = promise
context.register(promise: promise)
}
public func bind(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTFail("bind(...) should not be called")
context.bind(to: address, promise: promise)
}
public func connect(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTAssertNotNil(self.registerPromise)
XCTAssertNil(self.connectPromise)
XCTAssertNil(self.closePromise)
promise!.futureResult.whenSuccess {
XCTAssertTrue(context.channel.isActive)
}
self.connectPromise = promise
context.connect(to: address, promise: promise)
}
public func close(context: ChannelHandlerContext, mode: CloseMode, promise: EventLoopPromise<Void>?) {
XCTAssertNotNil(self.registerPromise)
XCTAssertNotNil(self.connectPromise)
XCTAssertNil(self.closePromise)
promise!.futureResult.whenSuccess {
XCTAssertFalse(context.channel.isActive)
}
self.closePromise = promise
context.close(mode: mode, promise: promise)
}
}
class AcceptedSocketChannelLifecycleVerificationHandler: ChannelDuplexHandler {
typealias InboundIn = Any
typealias OutboundIn = Any
private var registerPromise: EventLoopPromise<Void>?
private let activeChannelPromise: EventLoopPromise<Channel>
init(_ activeChannelPromise: EventLoopPromise<Channel>) {
self.activeChannelPromise = activeChannelPromise
}
public func channelActive(context: ChannelHandlerContext) {
XCTAssertTrue(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelActive", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
XCTAssertFalse(self.activeChannelPromise.futureResult.isFulfilled)
self.activeChannelPromise.succeed(context.channel)
}
public func channelInactive(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelInactive", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelRegistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelRegistered", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelUnregistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelUnregistered", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func register(context: ChannelHandlerContext, promise: EventLoopPromise<Void>?) {
XCTAssertNil(self.registerPromise)
let p = promise ?? context.eventLoop.makePromise()
p.futureResult.whenSuccess {
XCTAssertFalse(context.channel.isActive)
}
self.registerPromise = p
context.register(promise: p)
}
public func connect(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTFail("connect(...) should not be called")
context.connect(to: address, promise: promise)
}
public func bind(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTFail("bind(...) should not be called")
context.bind(to: address, promise: promise)
}
public func close(context: ChannelHandlerContext, mode: CloseMode, promise: EventLoopPromise<Void>?) {
XCTFail("close(...) should not be called")
context.close(mode: mode, promise: promise)
}
}
class ServerSocketChannelLifecycleVerificationHandler: ChannelDuplexHandler {
typealias InboundIn = Any
typealias OutboundIn = Any
private var registerPromise: EventLoopPromise<Void>?
private var bindPromise: EventLoopPromise<Void>?
private var closePromise: EventLoopPromise<Void>?
public func channelActive(context: ChannelHandlerContext) {
XCTAssertTrue(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelActive", setter: "register")
XCTAssertNil(self.closePromise)
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelInactive(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelInactive", setter: "register")
assertFulfilled(promise: self.closePromise, promiseName: "closePromise", trigger: "channelInactive", setter: "close")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelRegistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
XCTAssertNil(closePromise)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelRegistered", setter: "register")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func channelUnregistered(context: ChannelHandlerContext) {
XCTAssertFalse(context.channel.isActive)
assertFulfilled(promise: self.registerPromise, promiseName: "registerPromise", trigger: "channelUnregistered", setter: "register")
assertFulfilled(promise: self.closePromise, promiseName: "closePromise", trigger: "channelInactive", setter: "close")
XCTAssertFalse(context.channel.closeFuture.isFulfilled)
}
public func register(context: ChannelHandlerContext, promise: EventLoopPromise<Void>?) {
XCTAssertNil(self.registerPromise)
XCTAssertNil(self.bindPromise)
XCTAssertNil(self.closePromise)
let p = promise ?? context.eventLoop.makePromise()
p.futureResult.whenSuccess {
XCTAssertFalse(context.channel.isActive)
}
self.registerPromise = p
context.register(promise: p)
}
public func connect(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTFail("connect(...) should not be called")
context.connect(to: address, promise: promise)
}
public func bind(context: ChannelHandlerContext, to address: SocketAddress, promise: EventLoopPromise<Void>?) {
XCTAssertNotNil(self.registerPromise)
XCTAssertNil(self.bindPromise)
XCTAssertNil(self.closePromise)
promise?.futureResult.whenSuccess {
XCTAssertTrue(context.channel.isActive)
}
self.bindPromise = promise
context.bind(to: address, promise: promise)
}
public func close(context: ChannelHandlerContext, mode: CloseMode, promise: EventLoopPromise<Void>?) {
XCTAssertNotNil(self.registerPromise)
XCTAssertNotNil(self.bindPromise)
XCTAssertNil(self.closePromise)
let p = promise ?? context.eventLoop.makePromise()
p.futureResult.whenSuccess {
XCTAssertFalse(context.channel.isActive)
}
self.closePromise = p
context.close(mode: mode, promise: p)
}
}
func testNotificationOrder() throws {
let group = MultiThreadedEventLoopGroup(numberOfThreads: 1)
defer {
XCTAssertNoThrow(try group.syncShutdownGracefully())
}
let acceptedChannelPromise = group.next().makePromise(of: Channel.self)
let serverChannel = try assertNoThrowWithValue(ServerBootstrap(group: group)
.serverChannelOption(ChannelOptions.socketOption(.so_reuseaddr), value: 1)
.serverChannelInitializer { channel in
channel.pipeline.addHandler(ServerSocketChannelLifecycleVerificationHandler())
}
.childChannelOption(ChannelOptions.autoRead, value: false)
.childChannelInitializer { channel in
channel.pipeline.addHandler(AcceptedSocketChannelLifecycleVerificationHandler(acceptedChannelPromise))
}
.bind(host: "127.0.0.1", port: 0).wait())
let clientChannel = try assertNoThrowWithValue(ClientBootstrap(group: group)
.channelInitializer { channel in
channel.pipeline.addHandler(SocketChannelLifecycleVerificationHandler())
}
.connect(to: serverChannel.localAddress!).wait())
XCTAssertNoThrow(try clientChannel.close().wait())
XCTAssertNoThrow(try clientChannel.closeFuture.wait())
let channel = try acceptedChannelPromise.futureResult.wait()
var buffer = channel.allocator.buffer(capacity: 8)
buffer.writeString("test")
while (try? channel.writeAndFlush(buffer).wait()) != nil {
// Just write in a loop until it fails to ensure we detect the closed connection in a timely manner.
}
XCTAssertNoThrow(try channel.closeFuture.wait())
XCTAssertNoThrow(try serverChannel.close().wait())
XCTAssertNoThrow(try serverChannel.closeFuture.wait())
}
func testActiveBeforeChannelRead() throws {
// Use two EventLoops to ensure the ServerSocketChannel and the SocketChannel are on different threads.
let group = MultiThreadedEventLoopGroup(numberOfThreads: 2)
defer {
XCTAssertNoThrow(try group.syncShutdownGracefully())
}
class OrderVerificationHandler: ChannelInboundHandler {
typealias InboundIn = ByteBuffer
private enum State {
case `init`
case active
case read
case readComplete
case inactive
}
private var state = State.`init`
private let promise: EventLoopPromise<Void>
init(_ promise: EventLoopPromise<Void>) {
self.promise = promise
}
public func channelActive(context: ChannelHandlerContext) {
XCTAssertEqual(.`init`, state)
state = .active
}
public func channelRead(context: ChannelHandlerContext, data: NIOAny) {
XCTAssertEqual(.active, state)
state = .read
}
public func channelReadComplete(context: ChannelHandlerContext) {
XCTAssertTrue(.read == state || .readComplete == state, "State should either be .read or .readComplete but was \(state)")
state = .readComplete
}
public func channelInactive(context: ChannelHandlerContext) {
XCTAssertEqual(.readComplete, state)
state = .inactive
promise.succeed(())
}
}
let promise = group.next().makePromise(of: Void.self)
let serverChannel = try assertNoThrowWithValue(ServerBootstrap(group: group)
.serverChannelOption(ChannelOptions.socketOption(.so_reuseaddr), value: 1)
.childChannelOption(ChannelOptions.autoRead, value: true)
.childChannelInitializer { channel in
channel.pipeline.addHandler(OrderVerificationHandler(promise))
}
.bind(host: "127.0.0.1", port: 0).wait())
let clientChannel = try assertNoThrowWithValue(ClientBootstrap(group: group)
.connect(to: serverChannel.localAddress!).wait())
var buffer = clientChannel.allocator.buffer(capacity: 2)
buffer.writeString("X")
XCTAssertNoThrow(try clientChannel.writeAndFlush(buffer).flatMap {
clientChannel.close()
}.wait())
XCTAssertNoThrow(try promise.futureResult.wait())
XCTAssertNoThrow(try clientChannel.closeFuture.wait())
XCTAssertNoThrow(try serverChannel.close().wait())
XCTAssertNoThrow(try serverChannel.closeFuture.wait())
}
}
|
