Merge pull request #753 from artemcm/55SilenceTheExecutors

[5.5] Add `.silent` mode to the ToolExecutionDelegate to be used in integrated driver mode

Author: artemcm

Package.resolved

@@ -1074,11 +1074,14 @@ extension Driver {
   mutating func createToolExecutionDelegate() -> ToolExecutionDelegate {
     var mode: ToolExecutionDelegate.Mode = .regular
 
-    // FIXME: Old driver does _something_ if both are passed. Not sure if we want to support that.
+    // FIXME: Old driver does _something_ if both -parseable-output and -v are passed.
+    // Not sure if we want to support that.
     if parsedOptions.contains(.parseableOutput) {
       mode = .parsableOutput
     } else if parsedOptions.contains(.v) {
       mode = .verbose
+    } else if integratedDriver {
+      mode = .silent
     }
 
     return ToolExecutionDelegate(

Sources/SwiftDriver/Driver/Driver.swift

@@ -37,6 +37,7 @@ import Glibc
     case verbose
     case parsableOutput
     case regular
+    case silent
   }
 
   public let mode: Mode
@@ -70,7 +71,7 @@ import Glibc
       diagnosticEngine.emit(.remark_job_lifecycle("Starting", job))
     }
     switch mode {
-    case .regular:
+    case .regular, .silent:
       break
     case .verbose:
       stdoutStream <<< arguments.map { $0.spm_shellEscaped() }.joined(separator: " ") <<< "\n"
@@ -100,6 +101,9 @@ import Glibc
     #endif
 
     switch mode {
+    case .silent:
+      break
+
     case .regular, .verbose:
       let output = (try? result.utf8Output() + result.utf8stderrOutput()) ?? ""
       if !output.isEmpty {
@@ -139,7 +143,7 @@ import Glibc
       diagnosticEngine.emit(.remark_job_lifecycle("Skipped", job))
     }
     switch mode {
-    case .regular, .verbose:
+    case .regular, .verbose, .silent:
       break
     case .parsableOutput:
       let skippedMessage = SkippedMessage(inputs: job.displayInputs.map{ $0.file.name })

Sources/SwiftDriver/Driver/ToolExecutionDelegate.swift

@@ -344,6 +344,32 @@ final class ParsableMessageTests: XCTestCase {
     }
   }
 
+  func testSilentIntegratedMode() throws {
+    do {
+      try withTemporaryDirectory { path in
+        try withHijackedBufferedErrorStream(in: path) { errorBuffer in
+          let main = path.appending(component: "main.swift")
+          let output = path.appending(component: "main.o")
+          try localFileSystem.writeFileContents(main) {
+            $0 <<< "nonexistentPrint(\"hello, compilation error!\")"
+          }
+          let diags = DiagnosticsEngine()
+          let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
+          var driver = try Driver(args: ["swiftc", main.pathString,
+                                         "-o", output.pathString] + sdkArgumentsForTesting,
+                                  env: ProcessEnv.vars,
+                                  diagnosticsEngine: diags,
+                                  fileSystem: localFileSystem,
+                                  integratedDriver: true)
+          let jobs = try driver.planBuild()
+          XCTAssertThrowsError(try driver.run(jobs: jobs))
+          let invocationErrorOutput = try localFileSystem.readFileContents(errorBuffer).description
+          XCTAssertFalse(invocationErrorOutput.contains("error: cannot find 'nonexistentPrint' in scope"))
+        }
+      }
+    }
+  }
+
   func testFrontendMessages() throws {
     do {
       try withTemporaryDirectory { path in
@@ -360,7 +386,8 @@ final class ParsableMessageTests: XCTestCase {
                                          "-o", output.pathString] + sdkArgumentsForTesting,
                                   env: ProcessEnv.vars,
                                   diagnosticsEngine: diags,
-                                  fileSystem: localFileSystem)
+                                  fileSystem: localFileSystem,
+                                  integratedDriver: false)
           let jobs = try driver.planBuild()
           XCTAssertEqual(jobs.removingAutolinkExtractJobs().map(\.kind), [.compile, .link])
           XCTAssertEqual(jobs[0].outputs.count, 1)

Tests/SwiftDriverTests/ParsableMessageTests.swift

@@ -21,7 +21,8 @@ extension Driver {
     args: [String],
     env: [String: String] = ProcessEnv.vars,
     diagnosticsEngine: DiagnosticsEngine = DiagnosticsEngine(handlers: [Driver.stderrDiagnosticsHandler]),
-    fileSystem: FileSystem = localFileSystem
+    fileSystem: FileSystem = localFileSystem,
+    integratedDriver: Bool = true
   ) throws {
     let executor = try SwiftDriverExecutor(diagnosticsEngine: diagnosticsEngine,
                                        processSet: ProcessSet(),
@@ -31,7 +32,8 @@ extension Driver {
                   env: env,
                   diagnosticsEngine: diagnosticsEngine,
                   fileSystem: fileSystem,
-                  executor: executor)
+                  executor: executor,
+                  integratedDriver: integratedDriver)
   }
 
   /// For tests that need to set the sdk path.