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
|
/*
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
*/
import XCTest
import SwiftDocC
class DocumentationServerTests: XCTestCase {
func testCallsCorrectServiceForMessageType() throws {
let server = DocumentationServer()
server.register(service: TestServiceA())
server.register(service: TestServiceB())
let message1 = DocumentationServer.Message(type: "type-1", payload: nil)
let message2 = DocumentationServer.Message(type: "type-2", payload: nil)
let message3 = DocumentationServer.Message(type: "type-3", payload: nil)
processAndAssert(server, withMessage: message1) { data in
XCTAssertEqual(
try self.decode(DocumentationServer.Message.self, from: data),
TestServiceA.response
)
}
processAndAssert(server, withMessage: message2) { data in
XCTAssertEqual(
try self.decode(DocumentationServer.Message.self, from: data),
TestServiceA.response
)
}
processAndAssert(server, withMessage: message3) { data in
XCTAssertEqual(
try self.decode(DocumentationServer.Message.self, from: data),
TestServiceB.response
)
}
}
func testPassesTheMessageToTheService() throws {
let server = DocumentationServer()
let expectedMessage = DocumentationServer.Message(
type: .init(rawValue: "type-1"),
payload: "payload".data(using: .utf8)!
)
XCTAssertTrue(TestServiceA.handlingTypes.contains(expectedMessage.type))
let messageExpectation = XCTestExpectation(description: "service received message")
let responseExpectation = XCTestExpectation(description: "server received response")
server.register(service: TestServiceA(onProcess: { message in
XCTAssertEqual(message, expectedMessage)
messageExpectation.fulfill()
}))
processAndAssert(server, withMessage: expectedMessage, satisfies: { data in
responseExpectation.fulfill()
})
wait(for: [messageExpectation, responseExpectation], timeout: 1.0)
}
func testReturnsInvalidMessageErrorWhenGivenAnInvalidMessage() throws {
let server = DocumentationServer()
processAndAssert(
server,
withMessageData: "this is not a valid message".data(using: .utf8)!,
satisfies: { data in
self.assertIsErrorMessageWithIdentifier("invalid-message", messageData: data)
})
}
func testSynchronizationQueueHasGivenQualityOfService() {
let server = DocumentationServer(qualityOfService: .userInitiated)
XCTAssertEqual(server.synchronizationQueue.qos, .userInitiated)
}
func processAndAssert(
_ server: DocumentationServer,
withMessage message: DocumentationServer.Message,
satisfies assertion: @escaping (Data) throws -> ()
) {
processAndAssert(
server,
withMessageData: try! JSONEncoder().encode(message),
satisfies: { data in
try assertion(data)
}
)
}
func processAndAssert(
_ server: DocumentationServer,
withMessageData message: Data,
satisfies assertion: @escaping (Data) throws -> ()
) {
let expectation = XCTestExpectation(description: "Completion closure called")
server.process(message, completion: { data in
defer {
expectation.fulfill()
}
do {
try assertion(data)
} catch {
XCTFail(error.localizedDescription)
}
})
wait(for: [expectation], timeout: 1.0)
}
func assertIsErrorMessageWithIdentifier(_ identifier: String, messageData: Data) {
do {
let message = try self.decode(DocumentationServer.Message.self, from: messageData)
XCTAssertEqual(message.type.rawValue, "error")
guard let payload = message.payload else {
XCTFail("Unexpectedly received nil payload")
return
}
let errorPayload = try self.decode(DocumentationServerError.self, from: payload)
XCTAssertEqual(errorPayload.identifier, "invalid-message")
} catch {
XCTFail("Unable to decode message data")
}
}
func decode<Message : Decodable>(_ type: Message.Type, from data: Data) throws -> Message {
try JSONDecoder().decode(type, from: data)
}
struct TestServiceA: DocumentationService {
static var handlingTypes: [DocumentationServer.MessageType] = ["type-1", "type-2"]
static let response = DocumentationServer.Message(
type: "response", payload: "TestServiceA response".data(using: .utf8)!)
var onProcess: ((DocumentationServer.Message) -> ())?
func process(
_ message: DocumentationServer.Message,
completion: (DocumentationServer.Message) -> ()
) {
onProcess?(message)
completion(Self.response)
}
}
struct TestServiceB: DocumentationService {
static var handlingTypes: [DocumentationServer.MessageType] = ["type-3"]
static let response = DocumentationServer.Message(
type: "response", payload: "TestServiceB response".data(using: .utf8)!)
func process(
_ message: DocumentationServer.Message,
completion: (DocumentationServer.Message) -> ()
) {
completion(Self.response)
}
}
}
|
