File: ProcessRunner.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (127 lines) | stat: -rw-r--r-- 3,875 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

import Foundation

/// Provides convenience APIs for launching and gathering output from a subprocess
public class ProcessRunner {
  private static let serialQueue = DispatchQueue(label: "\(ProcessRunner.self)")

  let process: Process
  var launched = false

  public init(launchPath: String, arguments: [String],
              environment: [String: String] = [:]) {
    process = Process()
    process.launchPath = launchPath
    process.arguments = arguments
    process.environment = environment.merging(ProcessInfo.processInfo.environment) { (current, _) in current }
  }

  public func run(input: String? = nil,
                  captureStdout: Bool = true,
                  captureStderr: Bool = true) -> ProcessResult {
    let group = DispatchGroup()

    let inPipe = Pipe()
    if input != nil {
      process.standardInput = inPipe
    }

    var outData = Data()
    if captureStdout {
      let outPipe = Pipe()
      process.standardOutput = outPipe
      addHandler(pipe: outPipe, group: group) { outData.append($0) }
    }

    var errData = Data()
    if captureStderr {
      let errPipe = Pipe()
      process.standardError = errPipe
      addHandler(pipe: errPipe, group: group) { errData.append($0) }
    }

    ProcessRunner.serialQueue.sync {
      process.launch()
      launched = true
    }

    if let input = input {
      guard let data = input.data(using: .utf8) else {
        return ProcessResult(status: 1,
                             stdout: Data(),
                             stderr: "Invalid input".data(using: .utf8)!)
      }
      inPipe.fileHandleForWriting.write(data)
      inPipe.fileHandleForWriting.closeFile()
    }

    process.waitUntilExit()
    if captureStdout || captureStderr {
      // Make sure we've received all stdout/stderr
      group.wait()
    }

    return ProcessResult(status: process.terminationStatus,
                         stdout: outData, stderr: errData)
  }

  public func terminate() {
    ProcessRunner.serialQueue.sync {
      if launched {
        process.terminate()
      }
    }
  }

  private func addHandler(pipe: Pipe, group: DispatchGroup,
                          addData: @escaping (Data) -> Void) {
    group.enter()
    pipe.fileHandleForReading.readabilityHandler = { fileHandle in
      // Apparently using availableData can cause various issues
      let newData = fileHandle.readData(ofLength: Int.max)
      if newData.count == 0 {
        pipe.fileHandleForReading.readabilityHandler = nil;
        group.leave()
      } else {
        addData(newData)
      }
    }
  }
}

/// The exit code and output (if redirected) from a subprocess that has
/// terminated
public struct ProcessResult {
  public let status: Int32
  public let stdout: Data
  public let stderr: Data

  public var stdoutStr: String? {
    return String(data: stdout, encoding: .utf8)
  }
  public var stderrStr: String? {
    return String(data: stderr, encoding: .utf8)
  }
}

public func pathFromXcrun(for tool: String, in toolchain: String? = nil) -> String? {
  var args = ["-f", tool]
  if let toolchain = toolchain {
    args += ["--toolchain", toolchain]
  }
  let result = ProcessRunner(launchPath: "/usr/bin/xcrun", arguments: args).run()
  guard result.status == EXIT_SUCCESS else { return nil }

  return result.stdoutStr?.trimmingCharacters(in: .whitespacesAndNewlines)
}