Merge pull request swiftlang#29 from benlangmuir/update-recommended-toolchain

Update recommended toolchain to 2018-12-02-a

Author: benlangmuir

README.md

@@ -7,7 +7,7 @@ SourceKit-LSP is an implementation of the [Language Server Protocol](https://mic
 
 SourceKit-LSP is under heavy development! The best way to try it out is to build it from source. You will also need a Swift development toolchain and an editor that supports LSP.
 
-1. Install the `swift-DEVELOPMENT-SNAPSHOT-2018-11-25-a` toolchain snapshot from https://swift.org/download/#snapshots. Set the environment variable `SOURCEKIT_TOOLCHAIN_PATH` to the absolute path to the toolchain or otherwise configure your editor to use this toolchain. See [Toolchains](#toolchains) for more information.
+1. Install the `swift-DEVELOPMENT-SNAPSHOT-2018-12-02-a` toolchain snapshot from https://swift.org/download/#snapshots. Set the environment variable `SOURCEKIT_TOOLCHAIN_PATH` to the absolute path to the toolchain or otherwise configure your editor to use this toolchain. See [Toolchains](#toolchains) for more information.
 
 2. Build the language server executable `sourcekit-lsp` using `swift build`. See [Building](#building-sourcekit-lsp) for more information.
 
@@ -73,7 +73,7 @@ SourceKit-LSP depends on tools such as `sourcekitd` and `clangd`, which it loads
 
 ### Recommended Toolchain
 
-Use the `swift-DEVELOPMENT-SNAPSHOT-2018-11-25-a` toolchain snapshot from https://swift.org/download/#snapshots. SourceKit-LSP is still early in its development and we are actively adding functionality to the toolchain to support it.
+Use the `swift-DEVELOPMENT-SNAPSHOT-2018-12-02-a` toolchain snapshot from https://swift.org/download/#snapshots. SourceKit-LSP is still early in its development and we are actively adding functionality to the toolchain to support it.
 
 ### Selecting the Toolchain
 

Sources/SKCore/ToolchainRegistry.swift

@@ -36,6 +36,14 @@ public final class ToolchainRegistry {
   /// Mutex for registering and accessing toolchains.
   var queue: DispatchQueue = DispatchQueue(label: "toolchain-registry-queue")
 
+  /// The currently selected toolchain identifier on Darwin.
+  public internal(set) lazy var darwinToolchainOverride: String? = {
+    if let id = getenv("TOOLCHAINS"), !id.isEmpty, id != "default" {
+      return id
+    }
+    return nil
+  }()
+
   /// Creates an empty toolchain registry.
   public init() {}
 }
@@ -75,16 +83,16 @@ extension ToolchainRegistry {
 
   /// The default toolchain.
   ///
-  /// On Darwin, this is typically the toolchain with the identifier
-  /// `darwinDefaultToolchainIdentifier`, i.e. the default toolchain of the active Xcode. Otherwise
-  /// it is the first toolchain that was registered, if any.
+  /// On Darwin, this is typically the toolchain with the identifier `darwinToolchainIdentifier`,
+  /// i.e. the default toolchain of the active Xcode. Otherwise it is the first toolchain that was
+  /// registered, if any.
   ///
   /// The default toolchain must be only of the registered toolchains.
   public var `default`: Toolchain? {
     get {
       return queue.sync {
         if _default == nil {
-          if let tc = toolchainIdentifiers[ToolchainRegistry.darwinDefaultToolchainIdentifier] {
+          if let tc = toolchainIdentifiers[darwinToolchainIdentifier] {
             _default = tc
           } else {
             _default = _toolchains.first
@@ -108,10 +116,16 @@ extension ToolchainRegistry {
   }
 
   /// The standard default toolchain identifier on Darwin.
+  public static let darwinDefaultToolchainIdentifier: String = "com.apple.dt.toolchain.XcodeDefault"
+
+  /// The current toolchain identifier on Darwin, which is either specified byt the `TOOLCHAINS`
+  /// environment variable, or defaults to `darwinDefaultToolchainIdentifier`.
   ///
   /// The value of `default.identifier` may be different if the default toolchain has been
-  /// explicitly overridden, or if there is no toolchain with this identifier.
-  public static let darwinDefaultToolchainIdentifier: String = "com.apple.dt.toolchain.XcodeDefault"
+  /// explicitly overridden in code, or if there is no toolchain with this identifier.
+  public var darwinToolchainIdentifier: String {
+    return darwinToolchainOverride ?? ToolchainRegistry.darwinDefaultToolchainIdentifier
+  }
 
   /// All toolchains, in the order they were added.
   public var toolchains: [Toolchain] {

Tests/SKCoreTests/ToolchainRegistryTests.swift

@@ -37,6 +37,7 @@ final class ToolchainRegistryTests: XCTestCase {
     Platform.currentPlatform = .darwin
 
     let tr = ToolchainRegistry()
+    tr.darwinToolchainOverride = nil
     XCTAssertNil(tr.default)
     let a = Toolchain(identifier: "a", displayName: "a", path: nil)
     try! tr.registerToolchain(a)
@@ -69,6 +70,7 @@ final class ToolchainRegistryTests: XCTestCase {
 #if os(macOS)
     let fs = InMemoryFileSystem()
     let tr1 = ToolchainRegistry(fs)
+    tr1.darwinToolchainOverride = nil
 
     let xcodeDeveloper = ToolchainRegistry.currentXcodeDeveloperPath!
     let toolchains = xcodeDeveloper.appending(components: "Toolchains")
@@ -90,6 +92,7 @@ final class ToolchainRegistryTests: XCTestCase {
     XCTAssertEqual(tr1.toolchains.count, 1)
 
     let tr = ToolchainRegistry(fs)
+    tr.darwinToolchainOverride = nil
 
     XCTAssertEqual(tr.default?.identifier, ToolchainRegistry.darwinDefaultToolchainIdentifier)
     XCTAssertEqual(tr.default?.path, toolchains.appending(component: "XcodeDefault.xctoolchain"))
@@ -161,6 +164,11 @@ final class ToolchainRegistryTests: XCTestCase {
     let tc = Toolchain(path, fs)
     XCTAssertNotNil(tc)
     XCTAssertEqual(tc?.identifier, "org.fake.explicit")
+
+    let overrideReg = ToolchainRegistry(fs)
+    overrideReg.darwinToolchainOverride = "org.fake.global.B"
+    XCTAssertEqual(overrideReg.darwinToolchainIdentifier, "org.fake.global.B")
+    XCTAssertEqual(overrideReg.default?.identifier, "org.fake.global.B")
 #endif
   }
 

Tests/SKSwiftPMWorkspaceTests/SwiftPMWorkspaceTests.swift

@@ -187,6 +187,37 @@ final class SwiftPMWorkspaceTests: XCTestCase {
     checkNot(bcxx.asString, arguments: arguments)
     check("-o", build.appending(components: "lib.build", "a.cpp.o").asString, arguments: arguments)
   }
+
+  func testDeploymentTargetSwift() {
+    // FIXME: should be possible to use InMemoryFileSystem.
+    let fs = localFileSystem
+    let tempDir = try! TemporaryDirectory(removeTreeOnDeinit: true)
+    try! fs.createFiles(root: tempDir.path, files: [
+      "pkg/Sources/lib/a.swift": "",
+      "pkg/Package.swift": """
+          // swift-tools-version:5.0
+          import PackageDescription
+          let package = Package(name: "a",
+            platforms: [.macOS(.v10_13)],
+            products: [], dependencies: [],
+            targets: [.target(name: "lib", dependencies: [])])
+          """
+    ])
+    let packageRoot = tempDir.path.appending(component: "pkg")
+    let ws = try! SwiftPMWorkspace(
+      workspacePath: packageRoot,
+      toolchainRegistry: ToolchainRegistry.shared,
+      fileSystem: fs)!
+
+    let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
+    let arguments = ws.settings(for: aswift.asURL, language: .swift)!.compilerArguments
+    check("-target", arguments: arguments) // Only one!
+#if os(macOS)
+    check("-target", "x86_64-apple-macosx10.13", arguments: arguments)
+#else
+    check("-target", "x86_64-unknown-linux", arguments: arguments)
+#endif
+  }
 }
 
 private func checkNot(

Tests/SKSwiftPMWorkspaceTests/XCTestManifests.swift

@@ -2,12 +2,13 @@
 import XCTest
 
 extension SwiftPMWorkspaceTests {
-    // DO NOT MODIFY: This is autogenerated, use:
+    // DO NOT MODIFY: This is autogenerated, use: 
     //   `swift test --generate-linuxmain`
     // to regenerate.
     static let __allTests__SwiftPMWorkspaceTests = [
         ("testBasicCXXArgs", testBasicCXXArgs),
         ("testBasicSwiftArgs", testBasicSwiftArgs),
+        ("testDeploymentTargetSwift", testDeploymentTargetSwift),
         ("testMultiFileSwift", testMultiFileSwift),
         ("testMultiTargetSwift", testMultiTargetSwift),
     ]