Shell escape arguments when printing jobs with -###

Author: owenv

Sources/SwiftDriverExecution/SwiftDriverExecutor.swift

@@ -82,7 +82,7 @@ public final class SwiftDriverExecutor: DriverExecutor {
 
   public func description(of job: Job, forceResponseFiles: Bool) throws -> String {
     let (args, usedResponseFile) = try resolver.resolveArgumentList(for: job, forceResponseFiles: forceResponseFiles)
-    var result = args.joined(separator: " ")
+    var result = args.map { $0.spm_shellEscaped() }.joined(separator: " ")
 
     if usedResponseFile {
       // Print the response file arguments as a comment.

Tests/SwiftDriverTests/JobExecutorTests.swift

@@ -289,6 +289,21 @@ final class JobExecutorTests: XCTestCase {
     }
   }
 
+  func testShellEscapingArgsInJobDescription() throws {
+    let executor = try SwiftDriverExecutor(diagnosticsEngine: DiagnosticsEngine(),
+                                           processSet: ProcessSet(),
+                                           fileSystem: localFileSystem,
+                                           env: [:])
+    let job = Job(moduleName: "Module",
+                  kind: .compile,
+                  tool: .absolute(.init("/path/to/the tool")),
+                  commandLine: [.path(.absolute(.init("/with space"))),
+                                .path(.absolute(.init("/withoutspace")))],
+                  inputs: [], primaryInputs: [], outputs: [])
+    XCTAssertEqual(try executor.description(of: job, forceResponseFiles: false),
+                   "'/path/to/the tool' '/with space' /withoutspace")
+  }
+
   func testInputModifiedDuringMultiJobBuild() throws {
     try withTemporaryDirectory { path in
       let main = path.appending(component: "main.swift")