Parse module name for obj-c targets

Parse the obj-c module name for targets by looking at the `-fmodule-name`
flag.

Author: plemarquand

Sources/SKCore/BuildSystemManager.swift

@@ -14,6 +14,7 @@ import BuildServerProtocol
 import Dispatch
 import LSPLogging
 import LanguageServerProtocol
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 
@@ -156,14 +157,33 @@ extension BuildSystemManager {
 
   /// Returns the target's module name as parsed from the `ConfiguredTarget`'s compiler arguments.
   public func moduleName(for document: DocumentURI, in target: ConfiguredTarget) async -> String? {
-    guard let buildSettings = await buildSettings(for: document, in: target, language: .swift),
-      let moduleNameFlagIndex = buildSettings.compilerArguments.firstIndex(of: "-module-name")
+    guard let language = await self.defaultLanguage(for: document),
+      let buildSettings = await buildSettings(for: document, in: target, language: language)
     else {
       return nil
     }
 
-    let moduleNameIndex = buildSettings.compilerArguments.index(after: moduleNameFlagIndex)
-    return buildSettings.compilerArguments[moduleNameIndex]
+    switch language {
+    case .swift:
+      // Module name is specified in the form -module-name MyLibrary
+      guard let moduleNameFlagIndex = buildSettings.compilerArguments.firstIndex(of: "-module-name") else {
+        return nil
+      }
+      return buildSettings.compilerArguments[safe: moduleNameFlagIndex + 1]
+    case .objective_c:
+      // Specified in the form -fmodule-name=MyLibrary
+      guard
+        let moduleNameArgument = buildSettings.compilerArguments.first(where: {
+          $0.starts(with: "-fmodule-name=")
+        }),
+        let moduleName = moduleNameArgument.split(separator: "=").last
+      else {
+        return nil
+      }
+      return String(moduleName)
+    default:
+      return nil
+    }
   }
 
   /// Returns the build settings for `document` from `buildSystem`.

Sources/SourceKitLSP/TestDiscovery.swift

@@ -480,38 +480,26 @@ fileprivate extension Array<AnnotatedTestItem> {
 
   func prefixTestsWithModuleName(workspace: Workspace) async -> Self {
     return await self.asyncMap({
-      // If the module name can't be determined we return the test item without a prefixed id.
-      guard let moduleName = await self.moduleName(from: workspace, for: $0.testItem.location.uri) else {
-        return $0
-      }
-      var newTest = $0.testItem
-      newTest.id = "\(moduleName).\(newTest.id)"
-      newTest.children = await prefixTestsWithModuleName(workspace: workspace, newTest.children)
-      return AnnotatedTestItem(testItem: newTest, isExtension: $0.isExtension)
-    })
-  }
-
-  private func prefixTestsWithModuleName(workspace: Workspace, _ tests: [TestItem]) async -> [TestItem] {
-    return await tests.asyncMap({
-      guard let moduleName = await self.moduleName(from: workspace, for: $0.location.uri) else {
-        return $0
-      }
-
-      var newTest = $0
-      newTest.id = "\(moduleName).\(newTest.id)"
-      newTest.children = await prefixTestsWithModuleName(workspace: workspace, newTest.children)
-      return newTest
+      return AnnotatedTestItem(
+        testItem: await $0.testItem.prefixIDWithModuleName(workspace: workspace),
+        isExtension: $0.isExtension
+      )
     })
   }
+}
 
-  private func moduleName(from workspace: Workspace, for uri: DocumentURI) async -> String? {
-    guard let configuredTarget = await workspace.buildSystemManager.canonicalConfiguredTarget(for: uri) else {
-      return nil
+extension TestItem {
+  fileprivate func prefixIDWithModuleName(workspace: Workspace) async -> TestItem {
+    guard let configuredTarget = await workspace.buildSystemManager.canonicalConfiguredTarget(for: self.location.uri),
+      let moduleName = await workspace.buildSystemManager.moduleName(for: self.location.uri, in: configuredTarget)
+    else {
+      return self
     }
-    // If for whatever reason we can't get a module name from the build system, fall back
-    // to using the targetID as this would be used when there is no command line arguments
-    // to define the module name as something other than the targetID.
-    return await workspace.buildSystemManager.moduleName(for: uri, in: configuredTarget) ?? configuredTarget.targetID
+
+    var newTest = self
+    newTest.id = "\(moduleName).\(newTest.id)"
+    newTest.children = await newTest.children.asyncMap({ await $0.prefixIDWithModuleName(workspace: workspace) })
+    return newTest
   }
 }
 

Sources/SwiftExtensions/Array+Safe.swift

@@ -0,0 +1,19 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 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
+//
+//===----------------------------------------------------------------------===//
+
+extension Array {
+  /// Returns the element at the specified index if it is within the Array's
+  /// bounds, otherwise `nil`.
+  public subscript(safe index: Index) -> Element? {
+    return index > 0 && index < count ? self[index] : nil
+  }
+}

Tests/SourceKitLSPTests/WorkspaceTestDiscoveryTests.swift

@@ -655,12 +655,12 @@ final class WorkspaceTestDiscoveryTests: XCTestCase {
       tests,
       [
         TestItem(
-          id: "dummy.MyTests",
+          id: "MyTests",
           label: "MyTests",
           location: Location(uri: project.fileURI, range: Range(project.positions["1️⃣"])),
           children: [
             TestItem(
-              id: "dummy.MyTests/testSomething()",
+              id: "MyTests/testSomething()",
               label: "testSomething()",
               location: Location(uri: project.fileURI, range: Range(project.positions["2️⃣"]))
             )
@@ -712,12 +712,12 @@ final class WorkspaceTestDiscoveryTests: XCTestCase {
       tests,
       [
         TestItem(
-          id: "dummy.MyTests",
+          id: "MyTests",
           label: "MyTests",
           location: try project.location(from: "1️⃣", to: "4️⃣", in: "MyTests.swift"),
           children: [
             TestItem(
-              id: "dummy.MyTests/testSomething()",
+              id: "MyTests/testSomething()",
               label: "testSomething()",
               location: try project.location(from: "2️⃣", to: "3️⃣", in: "MyTests.swift")
             )