Merge pull request swiftlang#260 from ghvg1313/swift-working-directory

Append working directory to swift compiler args when presented in build settings

Author: benlangmuir

Sources/SKCore/FileBuildSettings.swift

@@ -32,8 +32,17 @@ public struct FileBuildSettings: Equatable {
     workingDirectory: String? = nil,
     language: Language)
   {
-    self.compilerArguments = compilerArguments
     self.workingDirectory = workingDirectory
     self.language = language
+    // For swift, sourcekit only accepts `working-directry` through compiler args.
+    // Injecting the arg here if workingDirectory presents in the settings,
+    // but not in the actual compiler args.
+    var compilerArgumentsWithWorkingDirectory = compilerArguments
+    if language == .swift,
+      let workingDirectory = workingDirectory,
+      !compilerArguments.contains("-working-directory") {
+      compilerArgumentsWithWorkingDirectory += ["-working-directory", workingDirectory]
+    }
+    self.compilerArguments = compilerArgumentsWithWorkingDirectory
   }
 }

Tests/SKCoreTests/BuildServerBuildSystemTests.swift

@@ -41,7 +41,7 @@ final class BuildServerBuildSystemTests: XCTestCase {
     let fileURL = URL(fileURLWithPath: "/path/to/some/file.swift")
     let settings = buildSystem.settings(for: DocumentURI(fileURL), Language.swift)
     XCTAssertNotNil(settings)
-    XCTAssertEqual(settings?.compilerArguments, ["-a", "-b"])
+    XCTAssertEqual(settings?.compilerArguments, ["-a", "-b", "-working-directory", "/path/to/some"])
     XCTAssertEqual(settings?.workingDirectory, fileURL.deletingLastPathComponent().path)
 
     // test error

Tests/SKCoreTests/CompilationDatabaseTests.swift

@@ -200,7 +200,7 @@ final class CompilationDatabaseTests: XCTestCase {
       let settings = buildSystem.settings(for: DocumentURI(URL(fileURLWithPath: "/a/a.swift")), .swift)
       XCTAssertNotNil(settings)
       XCTAssertEqual(settings?.workingDirectory, "/a")
-      XCTAssertEqual(settings?.compilerArguments, ["-swift-version", "4", "/a/a.swift"])
+      XCTAssertEqual(settings?.compilerArguments, ["-swift-version", "4", "/a/a.swift", "-working-directory", "/a"])
       XCTAssertNil(buildSystem.indexStorePath)
       XCTAssertNil(buildSystem.indexDatabasePath)
     }

Tests/SKCoreTests/FileBuildSettingsTests.swift

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2020 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 SKCore
+import XCTest
+
+final class FileBuildSettingsTests: XCTestCase {
+
+  func testSwiftCompilerArg() throws {
+    let swiftFileBuildSettingsWithWorkingDiectory = FileBuildSettings(compilerArguments: ["a", "b"], workingDirectory: "/path/to/root", language: .swift)
+    let swiftFileBuildSettingsWithoutWorkingDiectory = FileBuildSettings(compilerArguments: ["a", "b"], language: .swift)
+    let swiftFileBuildSettingsWithWorkingDiectoryArg = FileBuildSettings(compilerArguments: ["a", "b", "-working-directory", "/custom-root"], workingDirectory: "/path/to/root", language: .swift)
+    let objcFileBuildSettingsWithWorkingDiectory = FileBuildSettings(compilerArguments: ["a", "b"], workingDirectory: "/path/to/root", language: .objective_c)
+    XCTAssertEqual(swiftFileBuildSettingsWithWorkingDiectory.compilerArguments, ["a", "b", "-working-directory", "/path/to/root"])
+    XCTAssertEqual(swiftFileBuildSettingsWithoutWorkingDiectory.compilerArguments, ["a", "b"])
+    XCTAssertEqual(swiftFileBuildSettingsWithWorkingDiectoryArg.compilerArguments, ["a", "b", "-working-directory", "/custom-root"])
+    XCTAssertEqual(objcFileBuildSettingsWithWorkingDiectory.compilerArguments, ["a", "b"])
+  }
+}

Tests/SKCoreTests/XCTestManifests.swift

@@ -77,6 +77,15 @@ extension FallbackBuildSystemTests {
     ]
 }
 
+extension FileBuildSettingsTests {
+    // DO NOT MODIFY: This is autogenerated, use:
+    //   `swift test --generate-linuxmain`
+    // to regenerate.
+    static let __allTests__FileBuildSettingsTests = [
+        ("testSwiftCompilerArg", testSwiftCompilerArg),
+    ]
+}
+
 extension ToolchainRegistryTests {
     // DO NOT MODIFY: This is autogenerated, use:
     //   `swift test --generate-linuxmain`
@@ -108,6 +117,7 @@ public func __allTests() -> [XCTestCaseEntry] {
         testCase(CompilationDatabasePerfTests.__allTests__CompilationDatabasePerfTests),
         testCase(CompilationDatabaseTests.__allTests__CompilationDatabaseTests),
         testCase(FallbackBuildSystemTests.__allTests__FallbackBuildSystemTests),
+        testCase(FileBuildSettingsTests.__allTests__FileBuildSettingsTests),
         testCase(ToolchainRegistryTests.__allTests__ToolchainRegistryTests),
     ]
 }