Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 56 additions & 20 deletions Sources/Zero/Core/CommandRunner.swift
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
import Foundation

enum CommandRunnerError: LocalizedError {
case commandFailed(command: String, arguments: [String], exitCode: Int, output: String)
case commandFailed(command: String, arguments: [String], exitCode: Int, stdout: String, stderr: String)

var errorDescription: String? {
switch self {
case .commandFailed(_, _, let exitCode, let output):
let trimmedOutput = output.trimmingCharacters(in: .whitespacesAndNewlines)
if trimmedOutput.isEmpty {
case .commandFailed(_, _, let exitCode, let stdout, let stderr):
let trimmedStderr = stderr.trimmingCharacters(in: .whitespacesAndNewlines)
if !trimmedStderr.isEmpty {
return trimmedStderr
}

let trimmedStdout = stdout.trimmingCharacters(in: .whitespacesAndNewlines)
if trimmedStdout.isEmpty {
return "Command failed with exit code \(exitCode)."
}
return trimmedOutput
return trimmedStdout
}
}
}
Expand All @@ -31,14 +36,16 @@ final class CommandRunner: CommandRunning {

func executeStreaming(command: String, arguments: [String] = [], onOutput: @escaping (String) -> Void) throws -> String {
let process = Process()
let pipe = Pipe()
let stdoutPipe = Pipe()
let stderrPipe = Pipe()
let dataLock = NSLock()
var outputData = Data()
var stdoutData = Data()
var stderrData = Data()

process.executableURL = URL(fileURLWithPath: command)
process.arguments = arguments
process.standardOutput = pipe
process.standardError = pipe
process.standardOutput = stdoutPipe
process.standardError = stderrPipe

processLock.lock()
currentProcess = process
Expand All @@ -51,13 +58,28 @@ final class CommandRunner: CommandRunning {
processLock.unlock()
}

let fileHandle = pipe.fileHandleForReading
fileHandle.readabilityHandler = { handle in
let stdoutHandle = stdoutPipe.fileHandleForReading
let stderrHandle = stderrPipe.fileHandleForReading

stdoutHandle.readabilityHandler = { handle in
let chunkData = handle.availableData
guard !chunkData.isEmpty else { return }

dataLock.lock()
outputData.append(chunkData)
stdoutData.append(chunkData)
dataLock.unlock()

if let chunk = String(data: chunkData, encoding: .utf8), !chunk.isEmpty {
onOutput(chunk)
}
}

stderrHandle.readabilityHandler = { handle in
let chunkData = handle.availableData
guard !chunkData.isEmpty else { return }

dataLock.lock()
stderrData.append(chunkData)
dataLock.unlock()

if let chunk = String(data: chunkData, encoding: .utf8), !chunk.isEmpty {
Expand All @@ -68,31 +90,45 @@ final class CommandRunner: CommandRunning {
try process.run()
process.waitUntilExit()

fileHandle.readabilityHandler = nil
stdoutHandle.readabilityHandler = nil
stderrHandle.readabilityHandler = nil

let trailingStdout = stdoutHandle.readDataToEndOfFile()
if !trailingStdout.isEmpty {
dataLock.lock()
stdoutData.append(trailingStdout)
dataLock.unlock()

if let trailingChunk = String(data: trailingStdout, encoding: .utf8), !trailingChunk.isEmpty {
onOutput(trailingChunk)
}
}

let trailingData = fileHandle.readDataToEndOfFile()
if !trailingData.isEmpty {
let trailingStderr = stderrHandle.readDataToEndOfFile()
if !trailingStderr.isEmpty {
dataLock.lock()
outputData.append(trailingData)
stderrData.append(trailingStderr)
dataLock.unlock()

if let trailingChunk = String(data: trailingData, encoding: .utf8), !trailingChunk.isEmpty {
if let trailingChunk = String(data: trailingStderr, encoding: .utf8), !trailingChunk.isEmpty {
onOutput(trailingChunk)
}
}

let output = String(data: outputData, encoding: .utf8) ?? ""
let stdout = String(data: stdoutData, encoding: .utf8) ?? ""
let stderr = String(data: stderrData, encoding: .utf8) ?? ""

if process.terminationStatus != 0 {
throw CommandRunnerError.commandFailed(
command: command,
arguments: arguments,
exitCode: Int(process.terminationStatus),
output: output
stdout: stdout,
stderr: stderr
)
}

return output
return stdout + stderr
}

func cancelCurrentCommand() {
Expand Down
4 changes: 2 additions & 2 deletions Sources/Zero/Services/DockerService.swift
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ struct DockerService: DockerServiceProtocol {
return zeroError
}

if case let CommandRunnerError.commandFailed(binary, arguments, exitCode, output) = error {
let debugDetails = "\(context) [binary=\(binary)] [args=\(arguments.joined(separator: " "))] [script=\(command)] [exit=\(exitCode)] [output=\(output)]"
if case let CommandRunnerError.commandFailed(binary, arguments, exitCode, stdout, stderr) = error {
let debugDetails = "\(context) [binary=\(binary)] [args=\(arguments.joined(separator: " "))] [script=\(command)] [exit=\(exitCode)] [stdout=\(stdout)] [stderr=\(stderr)]"
return .runtimeCommandFailed(userMessage: context, debugDetails: debugDetails)
}

Expand Down
2 changes: 1 addition & 1 deletion Sources/Zero/Services/ExecutionService.swift
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ class ExecutionService: ObservableObject {
return "url_error_\(urlError.errorCode)"
}

if case let CommandRunnerError.commandFailed(_, _, exitCode, _) = error {
if case let CommandRunnerError.commandFailed(_, _, exitCode, _, _) = error {
return "command_failed_\(exitCode)"
}

Expand Down
24 changes: 22 additions & 2 deletions Tests/ZeroTests/CommandRunnerTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,35 @@ final class CommandRunnerTests: XCTestCase {
XCTAssertThrowsError(
try runner.execute(command: "/bin/sh", arguments: ["-c", "echo boom >&2; exit 7"])
) { error in
guard case let CommandRunnerError.commandFailed(command, arguments, exitCode, output) = error else {
guard case let CommandRunnerError.commandFailed(command, arguments, exitCode, stdout, stderr) = error else {
XCTFail("Expected CommandRunnerError.commandFailed")
return
}

XCTAssertEqual(command, "/bin/sh")
XCTAssertEqual(arguments, ["-c", "echo boom >&2; exit 7"])
XCTAssertEqual(exitCode, 7)
XCTAssertTrue(output.contains("boom"))
XCTAssertTrue(stdout.isEmpty)
XCTAssertTrue(stderr.contains("boom"))
}
}

func testExecuteThrowsErrorWithSeparatedStdoutAndStderr() {
// Given
let runner = CommandRunner()

// When & Then
XCTAssertThrowsError(
try runner.execute(command: "/bin/sh", arguments: ["-c", "echo out; echo err >&2; exit 3"])
) { error in
guard case let CommandRunnerError.commandFailed(_, _, exitCode, stdout, stderr) = error else {
XCTFail("Expected CommandRunnerError.commandFailed")
return
}

XCTAssertEqual(exitCode, 3)
XCTAssertTrue(stdout.contains("out"))
XCTAssertTrue(stderr.contains("err"))
}
}
}
12 changes: 7 additions & 5 deletions Tests/ZeroTests/DockerServiceTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,12 @@ final class DockerServiceTests: XCTestCase {
func testExecuteShellMapsRunnerFailureToStructuredZeroError() {
// Given
let mockRunner = MockCommandRunner()
mockRunner.mockError = NSError(
domain: "CommandRunner",
code: 127,
userInfo: [NSLocalizedDescriptionKey: "sh: npm: not found"]
mockRunner.mockError = CommandRunnerError.commandFailed(
command: "/usr/local/bin/docker",
arguments: ["exec", "zero-dev", "sh", "-c", "npm start"],
exitCode: 127,
stdout: "",
stderr: "sh: npm: not found"
)
let service = DockerService(runner: mockRunner)

Expand All @@ -204,7 +206,7 @@ final class DockerServiceTests: XCTestCase {

XCTAssertEqual(userMessage, "Docker shell command failed.")
XCTAssertTrue(debugDetails.contains("npm start"))
XCTAssertTrue(debugDetails.contains("not found"))
XCTAssertTrue(debugDetails.contains("stderr=sh: npm: not found"))
}
}
}