Remove swiftpm-xctest-helper (#6869)

A while ago, the canonical version of the helper tool was moved to Xcode itself, but in OSS toolchains and local builds, we were still using the prior version of the tool. This removes the previous tool and adjusts the code for finding the correct tool in the user's Xcode installation.

rdar://74658052

(cherry picked from commit b7116db)

Author: neonichu

Package.swift

@@ -519,13 +519,6 @@ let package = Package(
             name: "swift-package-registry",
             dependencies: ["Commands", "PackageRegistryTool"]
         ),
-        .executableTarget(
-            /** Shim tool to find test names on OS X */
-            name: "swiftpm-xctest-helper",
-            dependencies: [],
-            linkerSettings: [
-                .unsafeFlags(["-Xlinker", "-rpath", "-Xlinker", "@executable_path/../../../lib/swift/macosx"], .when(platforms: [.macOS])),
-            ]),
 
         // MARK: Support for Swift macros, should eventually move to a plugin-based solution
 

Sources/Commands/Utilities/TestingSupport.swift

@@ -29,21 +29,34 @@ enum TestingSupport {
     ///
     /// - Returns: Path to XCTestHelper tool.
     static func xctestHelperPath(swiftTool: SwiftTool) throws -> AbsolutePath {
-        let xctestHelperBin = "swiftpm-xctest-helper"
-        let binDirectory = try AbsolutePath(validating: CommandLine.arguments.first!,
-            relativeTo: swiftTool.originalWorkingDirectory).parentDirectory
-        // XCTestHelper tool is installed in libexec.
-        let maybePath = binDirectory.parentDirectory.appending(components: "libexec", "swift", "pm", xctestHelperBin)
-        if swiftTool.fileSystem.isFile(maybePath) {
-            return maybePath
+        var triedPaths = [AbsolutePath]()
+
+        func findXCTestHelper(swiftBuildPath: AbsolutePath) -> AbsolutePath? {
+            // XCTestHelper tool is installed in libexec.
+            let maybePath = swiftBuildPath.parentDirectory.parentDirectory.appending(components: "libexec", "swift", "pm", "swiftpm-xctest-helper")
+            if swiftTool.fileSystem.isFile(maybePath) {
+                return maybePath
+            } else {
+                triedPaths.append(maybePath)
+                return nil
+            }
         }
-        // This will be true during swiftpm development.
-        // FIXME: Factor all of the development-time resource location stuff into a common place.
-        let path = binDirectory.appending(component: xctestHelperBin)
-        if swiftTool.fileSystem.isFile(path) {
-            return path
+
+        if let firstCLIArgument = CommandLine.arguments.first {
+            let runningSwiftBuildPath = try AbsolutePath(validating: firstCLIArgument, relativeTo: swiftTool.originalWorkingDirectory)
+            if let xctestHelperPath = findXCTestHelper(swiftBuildPath: runningSwiftBuildPath) {
+                return xctestHelperPath
+            }
         }
-        throw InternalError("XCTestHelper binary not found.")
+
+        // This will be true during swiftpm development or when using swift.org toolchains.
+        let xcodePath = try TSCBasic.Process.checkNonZeroExit(args: "/usr/bin/xcode-select", "--print-path").spm_chomp()
+        let installedSwiftBuildPath = try TSCBasic.Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--find", "swift-build", environment: ["DEVELOPER_DIR": xcodePath]).spm_chomp()
+        if let xctestHelperPath = findXCTestHelper(swiftBuildPath: try AbsolutePath(validating: installedSwiftBuildPath)) {
+            return xctestHelperPath
+        }
+
+        throw InternalError("XCTestHelper binary not found, tried \(triedPaths.map { $0.pathString }.joined(separator: ", "))")
     }
 
     static func getTestSuites(in testProducts: [BuiltTestProduct], swiftTool: SwiftTool, enableCodeCoverage: Bool, sanitizers: [Sanitizer]) throws -> [AbsolutePath: [TestSuite]] {

Sources/SPMTestSupport/SwiftPMProduct.swift

@@ -20,7 +20,6 @@ public enum SwiftPMProduct: Product {
     case SwiftPackageRegistry
     case SwiftTest
     case SwiftRun
-    case XCTestHelper
 
     /// Executable name.
     public var exec: RelativePath {
@@ -35,8 +34,6 @@ public enum SwiftPMProduct: Product {
             return RelativePath("swift-test")
         case .SwiftRun:
             return RelativePath("swift-run")
-        case .XCTestHelper:
-            return RelativePath("swiftpm-xctest-helper")
         }
     }
 }

Sources/swiftpm-xctest-helper/main.swift

@@ -430,11 +430,6 @@ def install_swiftpm(prefix, args):
         note("Creating tool symlink from %s to %s" % (src, dest))
         symlink_force(src, dest)
 
-    # On Darwin, also install the swiftpm-xctest-helper tool.
-    if platform.system() == 'Darwin':
-        dest = os.path.join(prefix, "libexec", "swift", "pm")
-        install_binary(args, "swiftpm-xctest-helper", dest)
-
     # Install the PackageDescription/CompilerPluginSupport libraries and associated modules.
     dest = os.path.join(prefix, "lib", "swift", "pm", "ManifestAPI")
     install_dylib(args, "PackageDescription", dest, ["PackageDescription", "CompilerPluginSupport"])