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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
|
//===----------------------------------------------------------------------===//
//
// 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 LSPLogging
import LSPTestSupport
import LanguageServerProtocol
@_spi(Testing) import SKCore
import SKTestSupport
import SourceKitLSP
import TSCBasic
import XCTest
final class WorkspaceTests: XCTestCase {
func testMultipleSwiftPMWorkspaces() async throws {
// The package manifest is the same for both packages we open.
let packageManifest = """
// swift-tools-version: 5.7
import PackageDescription
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "MyLibrary"),
.executableTarget(name: "MyExec", dependencies: ["MyLibrary"])
]
)
"""
let project = try await MultiFileTestProject(
files: [
// PackageA
"PackageA/Sources/MyLibrary/libA.swift": """
public struct FancyLib {
public init() {}
public func sayHello() {}
}
""",
"PackageA/Sources/MyExec/execA.swift": """
import MyLibrary
FancyLib().1️⃣sayHello()
""",
"PackageA/Package.swift": packageManifest,
// PackageB
"PackageB/Sources/MyLibrary/libB.swift": """
public struct Lib {
public init() {}
public func foo() {}
}
""",
"PackageB/Sources/MyExec/execB.swift": """
import MyLibrary
Lib().2️⃣foo()
""",
"PackageB/Package.swift": packageManifest,
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageA"))),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageB"))),
]
},
enableBackgroundIndexing: true
)
_ = try await project.testClient.send(PollIndexRequest())
let (bUri, bPositions) = try project.openDocument("execB.swift")
let completions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(bUri), position: bPositions["2️⃣"])
)
XCTAssertEqual(
completions.items,
[
CompletionItem(
label: "foo()",
kind: .method,
detail: "Void",
deprecated: false,
sortText: nil,
filterText: "foo()",
insertText: "foo()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(bPositions["2️⃣"]), newText: "foo()")
)
),
CompletionItem(
label: "self",
kind: .keyword,
detail: "Lib",
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(bPositions["2️⃣"]), newText: "self")
)
),
]
)
let (aUri, aPositions) = try project.openDocument("execA.swift")
let otherCompletions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(aUri), position: aPositions["1️⃣"])
)
XCTAssertEqual(
otherCompletions.items,
[
CompletionItem(
label: "sayHello()",
kind: .method,
detail: "Void",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "sayHello()",
insertText: "sayHello()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(aPositions["1️⃣"]), newText: "sayHello()")
)
),
CompletionItem(
label: "self",
kind: LanguageServerProtocol.CompletionItemKind(rawValue: 14),
detail: "FancyLib",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(aPositions["1️⃣"]), newText: "self")
)
),
]
)
}
func testOpenPackageManifestInMultiSwiftPMWorkspaceSetup() async throws {
let project = try await MultiFileTestProject(
files: [
// PackageA
"PackageA/Sources/MyLibrary/libA.swift": "",
"PackageA/Package.swift": SwiftPMTestProject.defaultPackageManifest,
// PackageB
"PackageB/Sources/MyLibrary/libB.swift": "",
"PackageB/Package.swift": SwiftPMTestProject.defaultPackageManifest,
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir)),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageA"))),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageB"))),
]
}
)
let bPackageManifestUri = DocumentURI(
project.scratchDirectory.appendingPathComponent("PackageB").appendingPathComponent("Package.swift")
)
project.testClient.openDocument(SwiftPMTestProject.defaultPackageManifest, uri: bPackageManifestUri)
// Ensure that we get proper build settings for Package.swift and no error about `No such module: PackageDescription`
let diags = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(bPackageManifestUri))
)
XCTAssertEqual(diags, .full(RelatedFullDocumentDiagnosticReport(items: [])))
}
func testCorrectWorkspaceForPackageSwiftInMultiSwiftPMWorkspaceSetup() async throws {
let project = try await MultiFileTestProject(
files: [
// PackageA
"PackageA/Sources/MyLibrary/libA.swift": "",
"PackageA/Package.swift": SwiftPMTestProject.defaultPackageManifest,
// PackageB
"PackageB/Sources/MyLibrary/libB.swift": "",
"PackageB/Package.swift": SwiftPMTestProject.defaultPackageManifest,
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir)),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageA"))),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageB"))),
]
}
)
let pkgA = DocumentURI(
project.scratchDirectory
.appendingPathComponent("PackageA")
.appendingPathComponent("Package.swift")
)
let pkgB = DocumentURI(
project.scratchDirectory
.appendingPathComponent("PackageB")
.appendingPathComponent("Package.swift")
)
assertEqual(
await project.testClient.server.workspaceForDocument(uri: pkgA)?.rootUri,
DocumentURI(project.scratchDirectory.appendingPathComponent("PackageA"))
)
assertEqual(
await project.testClient.server.workspaceForDocument(uri: pkgB)?.rootUri,
DocumentURI(project.scratchDirectory.appendingPathComponent("PackageB"))
)
}
func testSwiftPMPackageInSubfolder() async throws {
let packageManifest = """
// swift-tools-version: 5.7
import PackageDescription
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "MyLibrary"),
.executableTarget(name: "MyExec", dependencies: ["MyLibrary"])
]
)
"""
let project = try await MultiFileTestProject(
files: [
// PackageA
"PackageA/Sources/MyLibrary/libA.swift": """
public struct FancyLib {
public init() {}
public func sayHello() {}
}
""",
"PackageA/Sources/MyExec/execA.swift": """
import MyLibrary
FancyLib().1️⃣sayHello()
""",
"PackageA/Package.swift": packageManifest,
],
enableBackgroundIndexing: true
)
let (uri, positions) = try project.openDocument("execA.swift")
_ = try await project.testClient.send(PollIndexRequest())
let otherCompletions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"])
)
XCTAssertEqual(
otherCompletions.items,
[
CompletionItem(
label: "sayHello()",
kind: .method,
detail: "Void",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "sayHello()",
insertText: "sayHello()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(positions["1️⃣"]), newText: "sayHello()")
)
),
CompletionItem(
label: "self",
kind: LanguageServerProtocol.CompletionItemKind(rawValue: 14),
detail: "FancyLib",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(positions["1️⃣"]), newText: "self")
)
),
]
)
}
func testNestedSwiftPMWorkspacesWithoutDedicatedWorkspaceFolder() async throws {
// The package manifest is the same for both packages we open.
let packageManifest = """
// swift-tools-version: 5.7
import PackageDescription
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "MyLibrary"),
.executableTarget(name: "MyExec", dependencies: ["MyLibrary"])
]
)
"""
let project = try await MultiFileTestProject(
files: [
// PackageA
"PackageA/Sources/MyLibrary/libA.swift": """
public struct FancyLib {
public init() {}
public func sayHello() {}
}
""",
"PackageA/Sources/MyExec/execA.swift": """
import MyLibrary
FancyLib().1️⃣sayHello()
""",
"PackageA/Package.swift": packageManifest,
// PackageB
"Sources/MyLibrary/libB.swift": """
public struct Lib {
public init() {}
public func foo() {}
}
""",
"Sources/MyExec/execB.swift": """
import MyLibrary
Lib().2️⃣foo()
""",
"Package.swift": packageManifest,
],
enableBackgroundIndexing: true
)
_ = try await project.testClient.send(PollIndexRequest())
let (bUri, bPositions) = try project.openDocument("execB.swift")
let completions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(bUri), position: bPositions["2️⃣"])
)
XCTAssertEqual(
completions.items,
[
CompletionItem(
label: "foo()",
kind: .method,
detail: "Void",
deprecated: false,
sortText: nil,
filterText: "foo()",
insertText: "foo()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(bPositions["2️⃣"]), newText: "foo()")
)
),
CompletionItem(
label: "self",
kind: .keyword,
detail: "Lib",
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(bPositions["2️⃣"]), newText: "self")
)
),
]
)
let (aUri, aPositions) = try project.openDocument("execA.swift")
_ = try await project.testClient.send(PollIndexRequest())
let otherCompletions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(aUri), position: aPositions["1️⃣"])
)
XCTAssertEqual(
otherCompletions.items,
[
CompletionItem(
label: "sayHello()",
kind: .method,
detail: "Void",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "sayHello()",
insertText: "sayHello()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(aPositions["1️⃣"]), newText: "sayHello()")
)
),
CompletionItem(
label: "self",
kind: LanguageServerProtocol.CompletionItemKind(rawValue: 14),
detail: "FancyLib",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(range: Range(aPositions["1️⃣"]), newText: "self")
)
),
]
)
}
func testMultipleClangdWorkspaces() async throws {
let project = try await MultiFileTestProject(
files: [
"WorkspaceA/main.cpp": """
#if FOO
void 1️⃣foo2️⃣() {}
#else
void foo() {}
#endif
int main() {
3️⃣foo4️⃣();
}
""",
"WorkspaceA/compile_flags.txt": """
-DFOO
""",
"WorkspaceB/test.m": "",
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("WorkspaceA"))),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("WorkspaceB"))),
]
},
usePullDiagnostics: false
)
_ = try project.openDocument("test.m")
let diags = try await project.testClient.nextDiagnosticsNotification()
XCTAssertEqual(diags.diagnostics.count, 0)
let (mainUri, positions) = try project.openDocument("main.cpp")
let highlightRequest = DocumentHighlightRequest(
textDocument: TextDocumentIdentifier(mainUri),
position: positions["3️⃣"]
)
let highlightResponse = try await project.testClient.send(highlightRequest)
XCTAssertEqual(
highlightResponse,
[
DocumentHighlight(range: positions["1️⃣"]..<positions["2️⃣"], kind: .text),
DocumentHighlight(range: positions["3️⃣"]..<positions["4️⃣"], kind: .text),
]
)
}
func testRecomputeFileWorkspaceMembershipOnPackageSwiftChange() async throws {
let project = try await MultiFileTestProject(
files: [
"PackageA/Sources/MyLibrary/libA.swift": "",
"PackageA/Package.swift": SwiftPMTestProject.defaultPackageManifest,
"PackageB/Sources/MyLibrary/libB.swift": """
public struct Lib {
public func foo() {}
public init() {}
}
""",
"PackageB/Sources/MyExec/main.swift": """
import MyLibrary
Lib().1️⃣
""",
"PackageB/Package.swift": SwiftPMTestProject.defaultPackageManifest,
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageA"))),
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("PackageB"))),
]
}
)
let (mainUri, _) = try project.openDocument("main.swift")
// We open PackageA first. Thus, MyExec/main (which is a file in PackageB that hasn't been added to Package.swift
// yet) will belong to PackageA by default (because it provides fallback build settings for it).
assertEqual(
await project.testClient.server.workspaceForDocument(uri: mainUri)?.rootUri,
DocumentURI(project.scratchDirectory.appendingPathComponent("PackageA"))
)
// Add the MyExec target to PackageB/Package.swift
let newPackageManifest = """
// swift-tools-version: 5.7
import PackageDescription
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "MyLibrary"),
.executableTarget(name: "MyExec", dependencies: ["MyLibrary"])
]
)
"""
let packageBManifestPath = project.scratchDirectory
.appendingPathComponent("PackageB")
.appendingPathComponent("Package.swift")
try newPackageManifest.write(
to: packageBManifestPath,
atomically: true,
encoding: .utf8
)
project.testClient.send(
DidChangeWatchedFilesNotification(changes: [
FileEvent(uri: DocumentURI(packageBManifestPath), type: .changed)
])
)
// Ensure that the DidChangeWatchedFilesNotification is handled before we continue.
_ = try await project.testClient.send(BarrierRequest())
// After updating PackageB/Package.swift, PackageB can provide proper build settings for MyExec/main.swift and
// thus workspace membership should switch to PackageB.
// Updating the build settings takes a few seconds. Send code completion requests every second until we receive correct results.
var didReceiveCorrectWorkspaceMembership = false
// Updating the build settings takes a few seconds. Send code completion requests every second until we receive correct results.
let packageBRootUri = DocumentURI(project.scratchDirectory.appendingPathComponent("PackageB"))
for _ in 0..<30 {
let workspace = await project.testClient.server.workspaceForDocument(uri: mainUri)
if workspace?.rootUri == packageBRootUri {
didReceiveCorrectWorkspaceMembership = true
break
}
logger.log("Received incorrect workspace \(workspace?.rootUri?.pseudoPath ?? "<nil>"). Trying again in 1s")
try await Task.sleep(nanoseconds: 1_000_000_000)
}
XCTAssert(didReceiveCorrectWorkspaceMembership)
}
func testMixedPackage() async throws {
let project = try await SwiftPMTestProject(
files: [
"clib/include/clib.h": """
#ifndef CLIB_H
#define CLIB_H
void clib_func(void);
void clib_other(void);
#endif // CLIB_H
""",
"clib/clib.c": """
#include "clib.h"
void clib_func(void) {1️⃣}
""",
"lib/lib.swift": """
public struct Lib {
public func foo() {}
public init() {}
}
2️⃣
""",
],
manifest: """
let package = Package(
name: "MyLibrary",
targets: [
.target(name: "lib", dependencies: []),
.target(name: "clib", dependencies: []),
]
)
"""
)
let (swiftUri, swiftPositions) = try project.openDocument("lib.swift")
let (cUri, cPositions) = try project.openDocument("clib.c")
let cCompletions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(cUri), position: cPositions["1️⃣"])
)
XCTAssertGreaterThanOrEqual(cCompletions.items.count, 0)
let swiftCompletions = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(swiftUri), position: swiftPositions["2️⃣"])
)
XCTAssertGreaterThanOrEqual(swiftCompletions.items.count, 0)
}
func testChangeWorkspaceFolders() async throws {
let project = try await MultiFileTestProject(
files: [
"subdir/Sources/otherPackage/otherPackage.swift": """
import package
func test() {
Package().1️⃣helloWorld()
}
""",
"subdir/Sources/package/package.swift": """
public struct Package {
public init() {}
public func helloWorld() {
print("Hello world!")
}
}
""",
"subdir/Package.swift": """
// swift-tools-version: 5.5
import PackageDescription
let package = Package(
name: "package",
products: [
.library(name: "package", targets: ["package"]),
.library(name: "otherPackage", targets: ["otherPackage"]),
],
targets: [
.target(
name: "package",
dependencies: []
),
.target(
name: "otherPackage",
dependencies: ["package"]
),
]
)
""",
],
workspaces: { scratchDir in
return [
WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("fake")))
]
}
)
let packageDir = try project.uri(for: "Package.swift").fileURL!.deletingLastPathComponent()
try await TSCBasic.Process.checkNonZeroExit(arguments: [
ToolchainRegistry.forTesting.default!.swift!.pathString,
"build",
"--package-path", packageDir.path,
"-Xswiftc", "-index-ignore-system-modules",
"-Xcc", "-index-ignore-system-symbols",
])
let (otherPackageUri, positions) = try project.openDocument("otherPackage.swift")
let testPosition = positions["1️⃣"]
let preChangeWorkspaceResponse = try await project.testClient.send(
CompletionRequest(
textDocument: TextDocumentIdentifier(otherPackageUri),
position: testPosition
)
)
XCTAssertEqual(
preChangeWorkspaceResponse.items,
[],
"Should not receive cross-module code completion results when opening an unrelated directory as workspace root"
)
project.testClient.send(
DidChangeWorkspaceFoldersNotification(
event: WorkspaceFoldersChangeEvent(added: [
WorkspaceFolder(uri: DocumentURI(packageDir))
])
)
)
let postChangeWorkspaceResponse = try await project.testClient.send(
CompletionRequest(
textDocument: TextDocumentIdentifier(otherPackageUri),
position: testPosition
)
)
XCTAssertEqual(
postChangeWorkspaceResponse.items,
[
CompletionItem(
label: "helloWorld()",
kind: .method,
detail: "Void",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "helloWorld()",
insertText: "helloWorld()",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(
range: Range(testPosition),
newText: "helloWorld()"
)
)
),
CompletionItem(
label: "self",
kind: .keyword,
detail: "Package",
documentation: nil,
deprecated: false,
sortText: nil,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(
TextEdit(
range: Range(testPosition),
newText: "self"
)
)
),
]
)
}
func testIntegrationTest() async throws {
// This test is doing the same as `test-sourcekit-lsp` in the `swift-integration-tests` repo.
let project = try await SwiftPMTestProject(
files: [
"Sources/clib/include/clib.h": """
#ifndef CLIB_H
#define CLIB_H
void clib_func(void);
void clib_other(void);
#endif // CLIB_H
""",
"Sources/clib/clib.c": """
#include "clib.h"
void 1️⃣clib_func(void) {2️⃣}
""",
"Sources/exec/main.swift": """
import lib
import clib
Lib().3️⃣foo()
4️⃣clib_func()
""",
"Sources/lib/lib.swift": """
public struct Lib {
public func 5️⃣foo() {}
public init() {}
}
""",
],
manifest: """
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "pkg",
targets: [
.target(name: "exec", dependencies: ["lib", "clib"]),
.target(name: "lib", dependencies: []),
.target(name: "clib", dependencies: []),
]
)
""",
enableBackgroundIndexing: true
)
let (mainUri, mainPositions) = try project.openDocument("main.swift")
let fooDefinitionResponse = try await project.testClient.send(
DefinitionRequest(textDocument: TextDocumentIdentifier(mainUri), position: mainPositions["3️⃣"])
)
XCTAssertEqual(
fooDefinitionResponse,
.locations([
Location(uri: try project.uri(for: "lib.swift"), range: try Range(project.position(of: "5️⃣", in: "lib.swift")))
])
)
let clibFuncDefinitionResponse = try await project.testClient.send(
DefinitionRequest(textDocument: TextDocumentIdentifier(mainUri), position: mainPositions["4️⃣"])
)
XCTAssertEqual(
clibFuncDefinitionResponse,
.locations([
Location(uri: try project.uri(for: "clib.c"), range: try Range(project.position(of: "1️⃣", in: "clib.c")))
])
)
let swiftCompletionResponse = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(mainUri), position: mainPositions["3️⃣"])
)
XCTAssertEqual(
swiftCompletionResponse.items,
[
CompletionItem(
label: "foo()",
kind: .method,
detail: "Void",
deprecated: false,
filterText: "foo()",
insertText: "foo()",
insertTextFormat: .plain,
textEdit: .textEdit(TextEdit(range: Range(mainPositions["3️⃣"]), newText: "foo()"))
),
CompletionItem(
label: "self",
kind: .keyword,
detail: "Lib",
deprecated: false,
filterText: "self",
insertText: "self",
insertTextFormat: .plain,
textEdit: .textEdit(TextEdit(range: Range(mainPositions["3️⃣"]), newText: "self"))
),
]
)
let (clibcUri, clibcPositions) = try project.openDocument("clib.c")
let cCompletionResponse = try await project.testClient.send(
CompletionRequest(textDocument: TextDocumentIdentifier(clibcUri), position: clibcPositions["2️⃣"])
)
// rdar://73762053: This should also suggest clib_other
XCTAssert(cCompletionResponse.items.contains(where: { $0.insertText == "clib_func" }))
}
func testWorkspaceOptions() async throws {
let project = try await SwiftPMTestProject(
files: [
"/.sourcekit-lsp/config.json": """
{
"swiftPM": {
"swiftCompilerFlags": ["-D", "TEST"]
}
}
""",
"Test.swift": """
func test() {
#if TEST
let x: String = 1
#endif
}
""",
]
)
let (uri, _) = try project.openDocument("Test.swift")
let diagnostics = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
)
guard case .full(let diagnostics) = diagnostics else {
XCTFail("Expected full diagnostics")
return
}
XCTAssertEqual(diagnostics.items.map(\.message), ["Cannot convert value of type 'Int' to specified type 'String'"])
}
func testOptionsInInitializeRequest() async throws {
let project = try await SwiftPMTestProject(
files: [
"Test.swift": """
func test() {
#if TEST
let x: String = 1
#endif
}
"""
],
initializationOptions: SourceKitLSPOptions(
swiftPM: SourceKitLSPOptions.SwiftPMOptions(swiftCompilerFlags: ["-D", "TEST"])
).asLSPAny
)
let (uri, _) = try project.openDocument("Test.swift")
let diagnostics = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
)
guard case .full(let diagnostics) = diagnostics else {
XCTFail("Expected full diagnostics")
return
}
XCTAssertEqual(diagnostics.items.map(\.message), ["Cannot convert value of type 'Int' to specified type 'String'"])
}
func testWorkspaceOptionsOverrideGlobalOptions() async throws {
let project = try await SwiftPMTestProject(
files: [
"/.sourcekit-lsp/config.json": """
{
"swiftPM": {
"swiftCompilerFlags": ["-D", "TEST"]
}
}
""",
"Test.swift": """
func test() {
#if TEST
let x: String = 1
#endif
#if OTHER
let x: String = 1.0
#endif
}
""",
],
initializationOptions: SourceKitLSPOptions(
swiftPM: SourceKitLSPOptions.SwiftPMOptions(swiftCompilerFlags: ["-D", "OTHER"])
).asLSPAny
)
let (uri, _) = try project.openDocument("Test.swift")
let diagnostics = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
)
guard case .full(let diagnostics) = diagnostics else {
XCTFail("Expected full diagnostics")
return
}
XCTAssertEqual(diagnostics.items.map(\.message), ["Cannot convert value of type 'Int' to specified type 'String'"])
}
}
|