Add process description to error output

marcoconti83 · Aug 10, 2016 · 5620771 · 5620771
1 parent bfb8e62
commit 5620771
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 16 deletions.
diff --git a/Sources/Subprocess+CompactAPI.swift b/Sources/Subprocess+CompactAPI.swift
@@ -40,13 +40,13 @@ extension Subprocess {
         _ arguments: String...,
         workingDirectory: String = ".") -> String {
 
-        guard let result = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory).execute(true) else {
-            Error.die("Can't execute \(executablePath) \(arguments.joinWithSeparator(" "))")
+        let process = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory)
+        guard let result = process.execute(true) else {
+            Error.die("Can't execute \"\(process)\"")
         }
         if result.status != 0 {
             let errorLines = result.errors == "" ? "" : "\n" + result.errors
-            Error.die("Process \(executablePath) returned non-zero status", errorLines, "\n",
-                      "with arguments: \(arguments.joinWithSeparator(" "))")
+            Error.die("Process \"\(process)\" returned status \(result.status)", errorLines)
         }
         return result.output
     }
@@ -63,8 +63,9 @@ extension Subprocess {
         _ arguments: String...,
         workingDirectory: String = ".") -> ExecutionResult {
 
-        guard let result = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory).execute(true) else {
-            Error.die("Can't execute \(executablePath) \(arguments.joinWithSeparator(" "))")
+        let process = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory)
+        guard let result = process.execute(true) else {
+            Error.die("Can't execute \"\(process)\"")
         }
         return result
     }
@@ -81,13 +82,13 @@ extension Subprocess {
         _ arguments: String...,
         workingDirectory: String = ".") -> [String] {
 
-        guard let result = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory).execute(true) else {
-            Error.die("Can't execute \(executablePath) \(arguments.joinWithSeparator(" "))")
+        let process = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory)
+        guard let result = process.execute(true) else {
+            Error.die("Can't execute \"\(process)\"")
         }
         if result.status != 0 {
             let errorLines = result.errors == "" ? "" : "\n" + result.errors
-            Error.die("Process \(executablePath) returned non-zero status", errorLines, "\n",
-                      "with arguments: \(arguments.joinWithSeparator(" "))")
+            Error.die("Process \"\(process)\" returned status \(result.status)", errorLines)
         }
         return result.outputLines
     }
@@ -104,8 +105,9 @@ extension Subprocess {
         _ arguments: String...,
         workingDirectory: String = ".") -> Int32 {
 
-        guard let result = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory).run() else {
-            Error.die("Can't execute \(executablePath) \(arguments.joinWithSeparator(" "))")
+        let process = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory)
+        guard let result = process.run() else {
+            Error.die("Can't execute \"\(process)\"")
         }
         return result
     }
@@ -121,12 +123,12 @@ extension Subprocess {
         _ arguments: String...,
         workingDirectory: String = ".") {
 
-        guard let result = Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory).run() else {
-            Error.die("Can't execute \(executablePath) \(arguments.joinWithSeparator(" "))")
+        let process =  Subprocess.init(executablePath: executablePath, arguments: arguments, workingDirectory: workingDirectory)
+        guard let result = process.run() else {
+            Error.die("Can't execute \"\(process)\"")
         }
         if result != 0 {
-            Error.die("Process \(executablePath) returned non-zero status\n",
-                      "with arguments: \(arguments.joinWithSeparator(" "))")
+            Error.die("Process \"\(process)\" returned status \(result)")
         }
     }
 }
diff --git a/Sources/Subprocess.swift b/Sources/Subprocess.swift
@@ -169,3 +169,18 @@ extension Subprocess {
         return TaskPipeline(task: task, captureOutput: captureOutput)
     }
 }
+
+// MARK: - Description
+extension Subprocess  : CustomStringConvertible {
+
+    public var description : String {
+        return self.executablePath
+            + (self.arguments.count > 0
+                ? " " + self.arguments
+                .map { $0.stringByReplacingOccurrencesOfString(" ", withString: "\\ ") }
+                .joinWithSeparator(" ")
+                : ""
+            )
+            + (self.pipeDestination != nil ? " | " + self.pipeDestination!.description : "" )
+    }
+}
diff --git a/Tests/SubprocessTests.swift b/Tests/SubprocessTests.swift
@@ -218,3 +218,51 @@ extension SubprocessTests {
         // then: not crashing
     }
 }
+
+// MARK: - Description
+extension SubprocessTests {
+
+    func testThatItDescribesExecutable() {
+
+        // given
+        let path = "/bin/ls"
+        let sut = Subprocess(path)
+
+        // then
+        XCTAssertEqual(sut.description, path)
+    }
+
+    func testThatItDescribesExecutableAndArguments() {
+
+        // given
+        let path = "/bin/ls"
+        let sut = Subprocess(path, "-l", "foo")
+
+        // then
+        XCTAssertEqual(sut.description, "\(path) -l foo")
+    }
+
+    func testThatItDescribesExecutableAndArgumentsWithSpace() {
+
+        // given
+        let path = "/bin/ls"
+        let sut = Subprocess(path, "-l", "My Documents")
+
+        // then
+        XCTAssertEqual(sut.description, "\(path) -l My\\ Documents")
+    }
+
+    func testThatItDescribesPipe() {
+
+        // given
+        let sut1 = Subprocess("/bin/echo", "That's it")
+        let sut2 = Subprocess("/usr/bin/grep", "it")
+        let sut3 = Subprocess("/usr/bin/sed", "s/it/not it/")
+
+        // when
+        let sut = sut1 | sut2 | sut3
+
+        // then
+        XCTAssertEqual(sut.description, "\(sut1.description) | \(sut2.description) | \(sut3.description)")
+    }
+}