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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import BuildServerProtocol
@_spi(Testing) import BuildSystemIntegration
import LanguageServerProtocol
import SKOptions
import SKTestSupport
import SourceKitLSP
import TSCBasic
import XCTest
final class FallbackBuildSystemTests: XCTestCase {
func testSwift() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.swift", isDirectory: false)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .swift, options: .init(sdk: sdk)),
FileBuildSettings(compilerArguments: ["-sdk", sdk, source.pseudoPath], workingDirectory: nil, isFallback: true)
)
}
func testSwiftWithCustomFlags() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.swift", isDirectory: false)
let options = SourceKitLSPOptions.FallbackBuildSystemOptions(
swiftCompilerFlags: [
"-Xfrontend",
"-debug-constraints",
],
sdk: sdk
)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .swift, options: options)?.compilerArguments,
["-Xfrontend", "-debug-constraints", "-sdk", sdk, source.pseudoPath]
)
}
func testSwiftWithCustomSDKFlag() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.swift", isDirectory: false)
let options = SourceKitLSPOptions.FallbackBuildSystemOptions(
swiftCompilerFlags: ["-sdk", "/some/custom/sdk", "-Xfrontend", "-debug-constraints"],
sdk: sdk
)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .swift, options: options)?.compilerArguments,
["-sdk", "/some/custom/sdk", "-Xfrontend", "-debug-constraints", source.pseudoPath]
)
}
func testCXX() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.cpp", isDirectory: false)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .cpp, options: .init(sdk: sdk)),
FileBuildSettings(
compilerArguments: ["-isysroot", sdk, source.pseudoPath],
workingDirectory: nil,
isFallback: true
)
)
}
func testCXXWithCustomFlags() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.cpp", isDirectory: false)
let options = SourceKitLSPOptions.FallbackBuildSystemOptions(
cxxCompilerFlags: ["-v"],
sdk: sdk
)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .cpp, options: options)?.compilerArguments,
["-v", "-isysroot", sdk, source.pseudoPath]
)
}
func testCXXWithCustomIsysroot() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.cpp", isDirectory: false)
let options = SourceKitLSPOptions.FallbackBuildSystemOptions(
cxxCompilerFlags: [
"-isysroot",
"/my/custom/sdk",
"-v",
],
sdk: sdk
)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .cpp, options: options)?.compilerArguments,
["-isysroot", "/my/custom/sdk", "-v", source.pseudoPath]
)
}
func testC() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.c", isDirectory: false)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .c, options: .init(sdk: sdk))?.compilerArguments,
["-isysroot", sdk, source.pseudoPath]
)
}
func testCWithCustomFlags() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.c", isDirectory: false)
let options = SourceKitLSPOptions.FallbackBuildSystemOptions(
cCompilerFlags: ["-v"],
sdk: sdk
)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .c, options: options)?.compilerArguments,
["-v", "-isysroot", sdk, source.pseudoPath]
)
}
func testObjC() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.m", isDirectory: false)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .objective_c, options: .init(sdk: sdk))?.compilerArguments,
["-isysroot", sdk, source.pseudoPath]
)
}
func testObjCXX() throws {
let sdk = try AbsolutePath(validating: "/my/sdk").pathString
let source = DocumentURI(filePath: "/my/source.mm", isDirectory: false)
XCTAssertEqual(
fallbackBuildSettings(for: source, language: .objective_cpp, options: .init(sdk: sdk))?.compilerArguments,
["-isysroot", sdk, source.pseudoPath]
)
}
func testUnknown() throws {
let source = DocumentURI(filePath: "/my/source.mm", isDirectory: false)
XCTAssertNil(fallbackBuildSettings(for: source, language: Language(rawValue: "unknown"), options: .init()))
}
func testFallbackBuildSettingsWhileBuildSystemIsComputingBuildSettings() async throws {
let fallbackResultsReceived = WrappedSemaphore(name: "Fallback results received")
let project = try await SwiftPMTestProject(
files: [
"Test.swift": """
let x: 1️⃣String2️⃣ = 1
"""
],
hooks: Hooks(
buildSystemHooks: BuildSystemHooks(
preHandleRequest: { request in
if request is TextDocumentSourceKitOptionsRequest {
fallbackResultsReceived.waitOrXCTFail()
}
}
)
)
)
let (uri, positions) = try project.openDocument("Test.swift")
let documentHighlight = try await project.testClient.send(
DocumentHighlightRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"])
)
XCTAssertEqual(documentHighlight, [DocumentHighlight(range: positions["1️⃣"]..<positions["2️⃣"], kind: .read)])
fallbackResultsReceived.signal()
try await repeatUntilExpectedResult {
let diagsAfterBuildSettings = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
)
return diagsAfterBuildSettings.fullReport?.items.map(\.message) == [
"Cannot convert value of type 'Int' to specified type 'String'"
]
}
}
}
|
