File: ServerTestUtils.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (108 lines) | stat: -rw-r--r-- 4,073 bytes parent folder | download
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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

#if canImport(NIOHTTP1)
import Foundation
import NIO
import NIOHTTP1
import XCTest
@testable import SwiftDocCUtilities

/// Makes a request head part with the given URI and headers.
func makeRequestHead(uri: String, headers: [(String, String)]? = nil) -> HTTPRequestHead {
    var head = HTTPRequestHead(version: .init(major: 1, minor: 1), method: .GET, uri: uri)
    if let headers {
        for header in headers {
            head.headers.add(name: header.0, value: header.1)
        }
    }
    return head
}

/// A testing handler that, when gets a request,
/// triggers a predefined handler with a predefined request head.
final class MockHandler: ChannelInboundHandler {
    typealias InboundIn = HTTPServerRequestPart
    typealias OutboundOut = HTTPServerResponsePart

    let requestHead: HTTPRequestHead
    let requestHandler: RequestHandlerFactory
    
    var requestError: RequestError?
    
    init(requestHead: HTTPRequestHead, requestHandler: RequestHandlerFactory) {
        self.requestHead = requestHead
        self.requestHandler = requestHandler
    }
    
    /// The received request doesn't matter - we always give the handler
    /// the preset request head.
    func channelRead(context: ChannelHandlerContext, data: NIOAny) {
        switch unwrapInboundIn(data) {
        case .end:
            // Trigger the preset handler
            let handler = requestHandler.create(channelHandler: self)
            do {
                try handler(context, requestHead)
            } catch let error as RequestError {
                requestError = error
            } catch { }
            context.flush()
        default: return
        }
    }
}

/// A testing channel handler that records the written response head, body, and error if any.
final class Response: ChannelOutboundHandler {
    typealias OutboundIn = HTTPServerResponsePart
    
    var head: HTTPResponseHead?
    var body: String?
    
    var requestError: RequestError?
    
    func write(context: ChannelHandlerContext, data: NIOAny, promise: EventLoopPromise<Void>?) {
        switch unwrapOutboundIn(data) {
        case .head(let head):
            self.head = head
        case .body(let data):
            switch data {
            case .byteBuffer(let buffer):
                self.body = buffer.getString(at: 0, length: buffer.writerIndex)
            default: break
            }
        default: break
        }
        context.write(data, promise: promise)
    }
}

/// Builds up a local host server channel pipeline, fire the preset request and returns the response.
func responseWithPipeline(request: HTTPRequestHead, handler factory: RequestHandlerFactory, file: StaticString = #file, line: UInt = #line) throws -> Response {
    let channel = EmbeddedChannel()
    let channelHandler = MockHandler(requestHead: request, requestHandler: factory)

    let response = Response()
    
    XCTAssertNoThrow(try channel.pipeline.addHandler(HTTPResponseEncoder()).wait(), file: (file), line: line)
    XCTAssertNoThrow(try channel.pipeline.addHandler(response).wait(), file: (file), line: line)
    XCTAssertNoThrow(try channel.pipeline.addHandler(channelHandler).wait(), file: (file), line: line)
    XCTAssertNoThrow(try channel.pipeline.addHandler(HTTPServerPipelineHandler()).wait(), file: (file), line: line)

    XCTAssertNoThrow(try channel.connect(to: SocketAddress(ipAddress: "127.0.0.1", port: 1)).wait(), file: (file), line: line)

    XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)), file: (file), line: line)
    XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)), file: (file), line: line)

    response.requestError = channelHandler.requestError
    return response
}
#endif