Merge pull request #58 from orlandos-nl/jo/throw-exit-code-nonzero

Throw `SSHClient.CommandFailed` when the status code is non-zero

Sources/Citadel/TTY/Client/TTY.swift

@@ -26,6 +26,12 @@ public struct ExecCommandStream {
                 stderr.finish(throwing: error)
             case .channelSuccess:
                 ()
+            case .exit(0):
+                stdout.finish()
+                stderr.finish()
+            case .exit(let status):
+                stdout.finish(throwing: SSHClient.CommandFailed(exitCode: status))
+                stderr.finish(throwing: SSHClient.CommandFailed(exitCode: status))
             }
         }
     }
@@ -43,6 +49,7 @@ final class ExecCommandHandler: ChannelDuplexHandler {
         case stdout(ByteBuffer)
         case stderr(ByteBuffer)
         case eof(Error?)
+        case exit(Int)
     }
 
     typealias InboundIn = SSHChannelData
@@ -70,8 +77,8 @@ final class ExecCommandHandler: ChannelDuplexHandler {
             onOutput(context.channel, .channelSuccess)
         case is NIOSSH.ChannelFailureEvent:
             onOutput(context.channel, .eof(CitadelError.channelFailure))
-        case is SSHChannelRequestEvent.ExitStatus:
-            ()
+        case let status as SSHChannelRequestEvent.ExitStatus:
+            onOutput(context.channel, .exit(status.exitStatus))
         default:
             context.fireUserInboundEventTriggered(event)
         }
@@ -106,6 +113,10 @@ final class ExecCommandHandler: ChannelDuplexHandler {
 }
 
 extension SSHClient {
+    public struct CommandFailed: Error {
+        public let exitCode: Int
+    }
+
     /// Executes a command on the remote server. This will return the output of the command (stdout). If the command fails, the error will be thrown. If the output is too large, the command will fail.
     /// - Parameters:
     /// - command: The command to execute.
@@ -165,6 +176,12 @@ extension SSHClient {
                     channel.writeAndFlush(commandData, promise: nil)
                     hasReceivedChannelSuccess = true
                 }
+            case .exit(let status):
+                if status == 0 {
+                    streamContinuation.finish()
+                } else {
+                    streamContinuation.finish(throwing: CommandFailed(exitCode: status))
+                }
             }
         }