Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Feb 27, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b61b22
Throw `SSHClient.CommandFailed` when the status code is non-zero
Joannis Feb 27, 2024
54897d9
Add clauses for ExecCommandStream
Joannis Feb 27, 2024
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
21 changes: 19 additions & 2 deletions Sources/Citadel/TTY/Client/TTY.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
}
}
Expand All @@ -43,6 +49,7 @@ final class ExecCommandHandler: ChannelDuplexHandler {
case stdout(ByteBuffer)
case stderr(ByteBuffer)
case eof(Error?)
case exit(Int)
}

typealias InboundIn = SSHChannelData
Expand Down Expand Up @@ -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)
}
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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))
}
}
}

Expand Down