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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 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 Foundation
import LanguageServerProtocol
import SKLogging
import SKTestSupport
import SKUtilities
import SourceKitLSP
import SwiftExtensions
import XCTest
final class SwiftInterfaceTests: XCTestCase {
func testSystemModuleInterface() async throws {
let testClient = try await TestSourceKitLSPClient()
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
let uri = DocumentURI(url)
testClient.openDocument("import Foundation", uri: uri)
let resp = try await testClient.send(
DefinitionRequest(
textDocument: TextDocumentIdentifier(url),
position: Position(line: 0, utf16index: 10)
)
)
let location = try XCTUnwrap(resp?.locations?.only)
XCTAssertTrue(location.uri.pseudoPath.hasSuffix("Foundation.swiftinterface"))
let fileContents = try XCTUnwrap(location.uri.fileURL.flatMap({ try String(contentsOf: $0, encoding: .utf8) }))
// Sanity-check that the generated Swift Interface contains Swift code
XCTAssert(
fileContents.hasPrefix("import "),
"Expected that the foundation swift interface starts with 'import ' but got '\(fileContents.prefix(100))'"
)
}
func testDefinitionInSystemModuleInterface() async throws {
let project = try await IndexedSingleSwiftFileTestProject(
"""
public func libFunc() async {
let a: 1️⃣String = "test"
let i: 2️⃣Int = 2
await 3️⃣withTaskGroup(of: Void.self) { group in
group.addTask {
print(a)
print(i)
}
}
}
""",
indexSystemModules: true
)
// Test stdlib with one submodule
try await assertSystemSwiftInterface(
uri: project.fileURI,
position: project.positions["1️⃣"],
testClient: project.testClient,
swiftInterfaceFile: "Swift.String.swiftinterface",
linePrefix: "@frozen public struct String"
)
// Test stdlib with two submodules
try await assertSystemSwiftInterface(
uri: project.fileURI,
position: project.positions["2️⃣"],
testClient: project.testClient,
swiftInterfaceFile: "Swift.Math.Integers.swiftinterface",
linePrefix: "@frozen public struct Int"
)
// Test concurrency
try await assertSystemSwiftInterface(
uri: project.fileURI,
position: project.positions["3️⃣"],
testClient: project.testClient,
swiftInterfaceFile: "_Concurrency.swiftinterface",
linePrefix: "@inlinable public func withTaskGroup"
)
}
func testSwiftInterfaceAcrossModules() async throws {
let project = try await SwiftPMTestProject(
files: [
"MyLibrary/MyLibrary.swift": """
public struct Lib {
public func foo() {}
public init() {}
}
""",
"Exec/main.swift": "import 1️⃣MyLibrary",
],
manifest: """
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "MyLibrary"),
.executableTarget(name: "Exec", dependencies: ["MyLibrary"])
]
)
""",
enableBackgroundIndexing: true
)
let (mainUri, mainPositions) = try project.openDocument("main.swift")
let response =
try await project.testClient.send(
DefinitionRequest(
textDocument: TextDocumentIdentifier(mainUri),
position: mainPositions["1️⃣"]
)
)
let location = try XCTUnwrap(response?.locations?.only)
XCTAssertTrue(location.uri.pseudoPath.hasSuffix("MyLibrary.swiftinterface"))
let fileContents = try XCTUnwrap(location.uri.fileURL.flatMap({ try String(contentsOf: $0, encoding: .utf8) }))
XCTAssertTrue(
fileContents.contains(
"""
public struct Lib {
public func foo()
public init()
}
"""
),
"Generated interface did not contain expected text.\n\(fileContents)"
)
}
func testJumpToSynthesizedExtensionMethodInSystemModuleWithoutIndex() async throws {
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
let positions = testClient.openDocument(
"""
func test(x: [String]) {
let rows = x.1️⃣filter { !$0.isEmpty }
}
""",
uri: uri
)
try await assertSystemSwiftInterface(
uri: uri,
position: positions["1️⃣"],
testClient: testClient,
swiftInterfaceFile: "Swift.Collection.Array.swiftinterface",
linePrefix: "@inlinable public func filter(_ isIncluded: (Element) throws -> Bool) rethrows -> [Element]"
)
}
func testJumpToSynthesizedExtensionMethodInSystemModuleWithIndex() async throws {
let project = try await IndexedSingleSwiftFileTestProject(
"""
func test(x: [String]) {
let rows = x.1️⃣filter { !$0.isEmpty }
}
""",
indexSystemModules: true
)
try await assertSystemSwiftInterface(
uri: project.fileURI,
position: project.positions["1️⃣"],
testClient: project.testClient,
swiftInterfaceFile: "Swift.Collection.Array.swiftinterface",
linePrefix: "@inlinable public func filter(_ isIncluded: (Element) throws -> Bool) rethrows -> [Element]"
)
}
}
private func assertSystemSwiftInterface(
uri: DocumentURI,
position: Position,
testClient: TestSourceKitLSPClient,
swiftInterfaceFile: String,
linePrefix: String,
line: UInt = #line
) async throws {
let definition = try await testClient.send(
DefinitionRequest(
textDocument: TextDocumentIdentifier(uri),
position: position
)
)
let location = try XCTUnwrap(definition?.locations?.only)
XCTAssertEqual(
location.uri.fileURL?.lastPathComponent,
swiftInterfaceFile,
"Path was: '\(location.uri.pseudoPath)'",
line: line
)
// load contents of swiftinterface
let contents = try XCTUnwrap(location.uri.fileURL.flatMap({ try String(contentsOf: $0, encoding: .utf8) }))
let lineTable = LineTable(contents)
let destinationLine = try XCTUnwrap(lineTable.line(at: location.range.lowerBound.line))
.trimmingCharacters(in: .whitespaces)
XCTAssert(destinationLine.hasPrefix(linePrefix), "Full line was: '\(destinationLine)'", line: line)
}
|
