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
|
/*
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
@testable import SwiftDocC
class DocumentationServer_DefaultTests: XCTestCase {
func testCreatesDefaultServerWithSpecifiedQualityOfService() {
XCTAssertEqual(
DocumentationServer.createDefaultServer(
qualityOfService: .userInitiated,
peer: nil
).synchronizationQueue.qos,
.userInitiated
)
}
/// Tests that the documentation server handles "convert" requests.
///
/// This test verifies that when a "convert" request with no payload is sent, the conversion services responds with
/// a "missing-payload" error. For more thorough testing for the conversion service, see ``ConvertServiceTests``.
func testRespondsToConvertRequests() throws {
let message = DocumentationServer.Message(
type: "convert",
identifier: "test-identifier",
payload: nil
)
let expectation = XCTestExpectation(description: "Receives response")
DocumentationServer
.createDefaultServer(qualityOfService: .userInitiated, peer: nil)
.process(try JSONEncoder().encode(message)) { data in
do {
let response = try JSONDecoder().decode(
DocumentationServer.Message.self, from: data)
let payload = try JSONDecoder().decode(
ConvertServiceError.self, from: try XCTUnwrap(response.payload))
XCTAssertEqual(payload.identifier, "missing-payload")
} catch {
XCTFail(error.localizedDescription)
}
expectation.fulfill()
}
wait(for: [expectation], timeout: 1.0)
}
func testQueriesLinkResolutionServer() throws {
let symbolGraphFile = Bundle.module.url(
forResource: "mykit-one-symbol",
withExtension: "symbols.json",
subdirectory: "Test Resources"
)!
let symbolGraph = try Data(contentsOf: symbolGraphFile)
let request = ConvertRequest(
bundleInfo: DocumentationBundle.Info(
displayName: "TestBundle",
identifier: "identifier",
version: "1.0.0"
),
externalIDsToConvert: ["s:5MyKit0A5ClassC10myFunctionyyF"],
symbolGraphs: [symbolGraph],
markupFiles: [],
miscResourceURLs: []
)
let message = DocumentationServer.Message(
type: "convert",
identifier: "test-identifier",
payload: try JSONEncoder().encode(request)
)
let receivesResponseExpectation = XCTestExpectation(description: "Receives response")
// Instead of using an `XCTestExpectation`, use a Boolean due to a bug in
// swift-corelibs-xctest on Linux for expectations that get over-fulfilled
// https://github.com/apple/swift/issues/55020.
var hasLinkResolverBeenCalled = false
let peerServer = DocumentationServer()
peerServer.register(service: LinkResolvingService { message in
defer { hasLinkResolverBeenCalled = true }
do {
return DocumentationServer.Message(
type: "resolve-reference-response",
payload: try JSONEncoder().encode(
OutOfProcessReferenceResolver.Response.errorMessage("Error"))
)
} catch {
XCTFail(error.localizedDescription)
return nil
}
})
DocumentationServer
.createDefaultServer(qualityOfService: .userInitiated, peer: peerServer)
.process(try JSONEncoder().encode(message)) { data in
do {
let response = try JSONDecoder().decode(
DocumentationServer.Message.self, from: data)
XCTAssertEqual(response.type, "convert-response")
} catch {
XCTFail(error.localizedDescription)
}
receivesResponseExpectation.fulfill()
}
wait(for: [receivesResponseExpectation], timeout: 5.0)
XCTAssert(hasLinkResolverBeenCalled)
}
struct LinkResolvingService: DocumentationService {
static var handlingTypes: [DocumentationServer.MessageType] = ["resolve-reference"]
var processHandler: (DocumentationServer.Message) -> DocumentationServer.Message?
func process(
_ message: DocumentationServer.Message,
completion: @escaping (DocumentationServer.Message) -> ()
) {
if let response = processHandler(message) {
completion(response)
}
}
}
}
|
