[SwiftTool] Add interrupt handler and process set to SwiftTool

Author: aciidgh

Sources/Commands/SwiftTool.swift

@@ -15,8 +15,10 @@ import PackageLoading
 import PackageGraph
 import PackageModel
 import POSIX
+import SourceControl
 import Utility
 import Workspace
+import libc
 
 private class ToolWorkspaceDelegate: WorkspaceDelegate {
     func fetchingMissingRepositories(_ urls: Set<String>) {
@@ -75,8 +77,16 @@ public class SwiftTool<Options: ToolOptions> {
     /// Path to the build directory.
     let buildPath: AbsolutePath
 
+    /// Reference to the argument parser.
     let parser: ArgumentParser
 
+    /// The process set to hold the launched processes. These will be terminated on any signal
+    /// received by the swift tools.
+    let processSet: ProcessSet
+
+    /// The interrupt handler.
+    let interruptHandler: InterruptHandler
+
     /// Create an instance of this tool.
     ///
     /// - parameter args: The command line arguments to be passed to this tool.
@@ -150,8 +160,28 @@ public class SwiftTool<Options: ToolOptions> {
             if let dir = options.chdir {
                 // FIXME: This should be an API which takes AbsolutePath and maybe
                 // should be moved to file system APIs with currentWorkingDirectory.
-                try chdir(dir.asString)
+                try POSIX.chdir(dir.asString)
             }
+
+            let processSet = ProcessSet()
+            interruptHandler = try InterruptHandler {
+                // Terminate all processes on receiving an interrupt signal.
+                processSet.terminate()
+
+                // Install the default signal handler.
+                var action = sigaction()
+              #if os(macOS)
+                action.__sigaction_u.__sa_handler = SIG_DFL
+              #else
+                action.__sigaction_handler = unsafeBitCast(SIG_DFL, to: sigaction.__Unnamed_union___sigaction_handler.self)
+              #endif
+                sigaction(SIGINT, &action, nil)
+
+                // Die with sigint.
+                kill(getpid(), SIGINT)
+            }
+            self.processSet = processSet
+
         } catch {
             handle(error: error)
         }
@@ -182,12 +212,14 @@ public class SwiftTool<Options: ToolOptions> {
         }
         let delegate = ToolWorkspaceDelegate()
         let rootPackage = try getPackageRoot()
+        let provider = GitRepositoryProvider(processSet: processSet)
         let workspace = try Workspace(
             dataPath: buildPath,
             editablesPath: rootPackage.appending(component: "Packages"),
             pinsFile: rootPackage.appending(component: "Package.pins"),
             manifestLoader: manifestLoader,
-            delegate: delegate
+            delegate: delegate,
+            repositoryProvider: provider
         )
         workspace.registerPackage(at: rootPackage)
         _workspace = workspace
@@ -266,7 +298,7 @@ private func findPackageRoot() -> AbsolutePath? {
 
 private func getEnvBuildPath() -> AbsolutePath? {
     // Don't rely on build path from env for SwiftPM's own tests.
-    guard getenv("IS_SWIFTPM_TEST") == nil else { return nil }
-    guard let env = getenv("SWIFT_BUILD_PATH") else { return nil }
+    guard POSIX.getenv("IS_SWIFTPM_TEST") == nil else { return nil }
+    guard let env = POSIX.getenv("SWIFT_BUILD_PATH") else { return nil }
     return AbsolutePath(env, relativeTo: currentWorkingDirectory)
 }

Tests/FunctionalTests/MiscellaneousTests.swift

@@ -12,11 +12,13 @@ import XCTest
 import TestSupport
 import Basic
 import PackageModel
+import Utility
+import libc
+import class Foundation.ProcessInfo
 
-import class Utility.Git
-import func libc.sleep
 import enum POSIX.Error
 import func POSIX.popen
+typealias ProcessID = Utility.Process.ProcessID
 
 class MiscellaneousTestCase: XCTestCase {
     func testPrintsSelectedDependencyVersion() {
@@ -437,6 +439,55 @@ class MiscellaneousTestCase: XCTestCase {
         }
     }
 
+    func testCanKillSubprocessOnSigInt() throws {
+        fixture(name: "DependencyResolution/External/Simple") { prefix in
+
+            let fakeGit = prefix.appending(components: "bin", "git")
+            let waitFile = prefix.appending(components: "waitfile")
+
+            try localFileSystem.createDirectory(fakeGit.parentDirectory)
+
+            // Write out fake git.
+            let stream = BufferedOutputByteStream()
+            stream <<< "#!/bin/sh" <<< "\n"
+            stream <<< "set -e" <<< "\n"
+            stream <<< "printf \"$$\" >> " <<< waitFile.asString <<< "\n"
+            stream <<< "while true; do sleep 1; done" <<< "\n"
+            try localFileSystem.writeFileContents(fakeGit, bytes: stream.bytes)
+
+            // Make it executable.
+            _ = try Process.popen(args: "chmod", "+x", fakeGit.asString)
+
+            // Put fake git in PATH.
+            var env = ProcessInfo.processInfo.environment
+            let oldPath = env["PATH"]
+            env["PATH"] = fakeGit.parentDirectory.asString
+            if let oldPath = oldPath {
+                env["PATH"] = env["PATH"]! + ":" + oldPath
+            }
+
+            // Launch swift-build.
+            let app = prefix.appending(component: "Bar")
+            let process = Process(args: SwiftPMProduct.SwiftBuild.path.asString, "--chdir", app.asString, environment: env)
+            try process.launch()
+
+            guard waitForFile(waitFile) else {
+                return XCTFail("Couldn't launch the process")
+            }
+            // Interrupt the process.
+            process.signal(SIGINT)
+            let result = try process.waitUntilExit()
+
+            // We should not have exited with zero.
+            XCTAssert(result.exitStatus != .terminated(code: 0))
+
+            // Process and subprocesses should be dead.
+            let contents = try localFileSystem.readFileContents(waitFile).asString!
+            XCTAssertFalse(try Process.running(process.processID))
+            XCTAssertFalse(try Process.running(ProcessID(contents)!))
+        }
+    }
+
     static var allTests = [
         ("testExecutableAsBuildOrderDependency", testExecutableAsBuildOrderDependency),
         ("testPrintsSelectedDependencyVersion", testPrintsSelectedDependencyVersion),
@@ -470,5 +521,6 @@ class MiscellaneousTestCase: XCTestCase {
         ("testInitPackageNonc99Directory", testInitPackageNonc99Directory),
         ("testOverridingSwiftcArguments", testOverridingSwiftcArguments),
         ("testPkgConfigClangModules", testPkgConfigClangModules),
+        ("testCanKillSubprocessOnSigInt", testCanKillSubprocessOnSigInt),
     ]
 }