Merge pull request swiftlang#78 from benlangmuir/fix-build-path-config-better

Change configuration build path to be absolute

Author: benlangmuir

Sources/SKCore/BuildSetup.swift

@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Foundation
+import Basic
 import Utility
 import SKSupport
 
@@ -19,19 +19,19 @@ public struct BuildSetup {
 
   /// Default configuration
   public static let `default` = BuildSetup(configuration: .debug,
-                                           path: ".build",
+                                           path: nil,
                                            flags: BuildFlags())
 
-  /// Build configuration
+  /// Build configuration (debug|release).
   public let configuration: BuildConfiguration
 
-  /// Build artefacts directory path
-  public let path: String
+  /// Build artefacts directory path. If nil, the build system may choose a default value.
+  public let path: AbsolutePath?
 
   /// Additional build flags
   public let flags: BuildFlags
 
-  public init(configuration: BuildConfiguration, path: String, flags: BuildFlags) {
+  public init(configuration: BuildConfiguration, path: AbsolutePath?, flags: BuildFlags) {
     self.configuration = configuration
     self.path = path
     self.flags = flags

Sources/SKSupport/BuildConfiguration.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Foundation
 import Utility
 
 public enum BuildConfiguration: String {

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift

@@ -113,13 +113,7 @@ public final class SwiftPMWorkspace {
     swiftPMToolchain.extraSwiftCFlags = extraSwiftFlags
     swiftPMToolchain.extraCPPFlags = extraClangFlags
 
-
-    let buildPath: AbsolutePath
-    if let absoluteBuildPath = try? AbsolutePath(validating: buildSetup.path) {
-      buildPath = absoluteBuildPath
-    } else {
-      buildPath = packageRoot.appending(component: buildSetup.path)
-    }
+    let buildPath: AbsolutePath = buildSetup.path ?? packageRoot.appending(component: ".build")
 
     self.workspace = Workspace(
       dataPath: buildPath,

Sources/SKTestSupport/TestServer.swift

@@ -35,7 +35,7 @@ public struct TestSourceKitServer {
   }
 
   public static let buildSetup: BuildSetup = BuildSetup(configuration: .debug,
-                                                        path: ".build",
+                                                        path: nil,
                                                         flags: BuildFlags())
 
   public let client: TestClient

Sources/sourcekit-lsp/main.swift

@@ -17,6 +17,7 @@ import SKSupport
 import SKCore
 import SPMLibc
 import Dispatch
+import Basic
 import Utility
 import Foundation
 import sourcekitd // Not needed here, but fixes debugging...
@@ -26,7 +27,7 @@ func parseArguments() throws -> BuildSetup {
   let parser = ArgumentParser(usage: "[options]", overview: "Language Server Protocol implementation for Swift and C-based languages")
   let loggingOption = parser.add(option: "--log-level", kind: LogLevel.self, usage: "Set the logging level (debug|info|warning|error) [default: \(LogLevel.default)]")
   let buildConfigurationOption = parser.add(option: "--configuration", shortName: "-c", kind: BuildConfiguration.self, usage: "Build with configuration (debug|release) [default: debug]")
-  let buildPathOption = parser.add(option: "--build-path", kind: String.self, usage: "Specify build/cache directory [default: ./.build]")
+  let buildPathOption = parser.add(option: "--build-path", kind: PathArgument.self, usage: "Specify build/cache directory")
   let buildFlagsCc = parser.add(option: "-Xcc", kind: [String].self, strategy: .oneByOne, usage: "Pass flag through to all C compiler invocations")
   let buildFlagsCxx = parser.add(option: "-Xcxx", kind: [String].self, strategy: .oneByOne, usage: "Pass flag through to all C++ compiler invocations")
   let buildFlagsLinker = parser.add(option: "-Xlinker", kind: [String].self, strategy: .oneByOne, usage: "Pass flag through to all linker invocations")
@@ -46,9 +47,10 @@ func parseArguments() throws -> BuildSetup {
     Logger.shared.setLogLevel(environmentVariable: "SOURCEKIT_LOGGING")
   }
 
-  return BuildSetup(configuration: parsedArguments.get(buildConfigurationOption) ?? BuildSetup.default.configuration,
-                    path: parsedArguments.get(buildPathOption) ?? BuildSetup.default.path,
-                    flags: buildFlags)
+  return BuildSetup(
+    configuration: parsedArguments.get(buildConfigurationOption) ?? BuildSetup.default.configuration,
+    path: parsedArguments.get(buildPathOption)?.path,
+    flags: buildFlags)
 }
 
 let clientConnection = JSONRPCConection(inFD: STDIN_FILENO, outFD: STDOUT_FILENO, closeHandler: {

Tests/SKSwiftPMWorkspaceTests/SwiftPMWorkspaceTests.swift

@@ -123,6 +123,44 @@ final class SwiftPMWorkspaceTests: XCTestCase {
     check(aswift.asString, arguments: arguments)
   }
 
+  func testBuildSetup() {
+    // 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:4.2
+          import PackageDescription
+          let package = Package(name: "a", products: [], dependencies: [],
+            targets: [.target(name: "lib", dependencies: [])])
+          """
+    ])
+    let packageRoot = tempDir.path.appending(component: "pkg")
+    let tr = ToolchainRegistry.shared
+
+    let config = BuildSetup(
+        configuration: .release,
+        path: packageRoot.appending(component: "non_default_build_path"),
+        flags: BuildFlags(xcc: ["-m32"], xcxx: [], xswiftc: ["-typecheck"], xlinker: []))
+
+    let ws = try! SwiftPMWorkspace(
+      workspacePath: packageRoot,
+      toolchainRegistry: tr,
+      fileSystem: fs,
+      buildSetup: config)
+
+    let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
+    let build = buildPath(root: packageRoot, config: config)
+
+    XCTAssertEqual(ws.buildPath, build)
+    let arguments = ws.settings(for: aswift.asURL, .swift)!.compilerArguments
+
+    check("-typecheck", arguments: arguments)
+    check("-Xcc", "-m32", arguments: arguments)
+    check("-O", arguments: arguments)
+  }
+
   func testManifestArgs() {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
@@ -384,18 +422,22 @@ private func check(
   }
 }
 
-private func buildPath(root: AbsolutePath) -> AbsolutePath {
-  if let absoluteBuildPath = try? AbsolutePath(validating: TestSourceKitServer.buildSetup.path) {
+private func buildPath(
+  root: AbsolutePath,
+  config: BuildSetup = TestSourceKitServer.buildSetup) -> AbsolutePath
+{
+  let buildConfig = "\(config.configuration)"
+  if let absoluteBuildPath = config.path {
     #if os(macOS)
-      return absoluteBuildPath.appending(components: "x86_64-apple-macosx", "debug")
+      return absoluteBuildPath.appending(components: "x86_64-apple-macosx", buildConfig)
     #else
-      return absoluteBuildPath.appending(components: "x86_64-unknown-linux", "debug")
+      return absoluteBuildPath.appending(components: "x86_64-unknown-linux", buildConfig)
     #endif
   } else {
     #if os(macOS)
-      return root.appending(components: TestSourceKitServer.buildSetup.path, "x86_64-apple-macosx", "debug")
+      return root.appending(components: ".build", "x86_64-apple-macosx", buildConfig)
     #else
-      return root.appending(components: TestSourceKitServer.buildSetup.path, "x86_64-unknown-linux", "debug")
+      return root.appending(components: ".build", "x86_64-unknown-linux", buildConfig)
     #endif
   }
 }

Tests/SKSwiftPMWorkspaceTests/XCTestManifests.swift

@@ -8,6 +8,7 @@ extension SwiftPMWorkspaceTests {
     static let __allTests__SwiftPMWorkspaceTests = [
         ("testBasicCXXArgs", testBasicCXXArgs),
         ("testBasicSwiftArgs", testBasicSwiftArgs),
+        ("testBuildSetup", testBuildSetup),
         ("testDeploymentTargetSwift", testDeploymentTargetSwift),
         ("testManifestArgs", testManifestArgs),
         ("testMultiFileSwift", testMultiFileSwift),