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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
use std::path::PathBuf;
use std::sync::Arc;
use distant_net::client::Mailbox;
use distant_net::common::{Request, Response};
use log::*;
use tokio::io;
use tokio::sync::mpsc::error::{TryRecvError, TrySendError};
use tokio::sync::{mpsc, RwLock};
use tokio::task::JoinHandle;
use crate::client::DistantChannel;
use crate::constants::CLIENT_PIPE_CAPACITY;
use crate::protocol::{self, Cmd, Environment, ProcessId, PtySize};
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct RemoteOutput {
pub success: bool,
pub code: Option<i32>,
pub stdout: Vec<u8>,
pub stderr: Vec<u8>,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct RemoteStatus {
pub success: bool,
pub code: Option<i32>,
}
impl From<(bool, Option<i32>)> for RemoteStatus {
fn from((success, code): (bool, Option<i32>)) -> Self {
Self { success, code }
}
}
type StatusResult = io::Result<RemoteStatus>;
/// A [`RemoteProcess`] builder providing support to configure
/// before spawning the process on a remote machine
pub struct RemoteCommand {
pty: Option<PtySize>,
environment: Environment,
current_dir: Option<PathBuf>,
}
impl Default for RemoteCommand {
fn default() -> Self {
Self::new()
}
}
impl RemoteCommand {
/// Creates a new set of options for a remote process
pub fn new() -> Self {
Self {
pty: None,
environment: Environment::new(),
current_dir: None,
}
}
/// Configures the process to leverage a PTY with the specified size
pub fn pty(&mut self, pty: Option<PtySize>) -> &mut Self {
self.pty = pty;
self
}
/// Replaces the existing environment variables with the given collection
pub fn environment(&mut self, environment: Environment) -> &mut Self {
self.environment = environment;
self
}
/// Configures the process with an alternative current directory
pub fn current_dir(&mut self, current_dir: Option<PathBuf>) -> &mut Self {
self.current_dir = current_dir;
self
}
/// Spawns the specified process on the remote machine using the given `channel` and `cmd`
pub async fn spawn(
&mut self,
mut channel: DistantChannel,
cmd: impl Into<String>,
) -> io::Result<RemoteProcess> {
let cmd = cmd.into();
// Submit our run request and get back a mailbox for responses
let mut mailbox = channel
.mail(Request::new(protocol::Msg::Single(
protocol::Request::ProcSpawn {
cmd: Cmd::from(cmd),
pty: self.pty,
environment: self.environment.clone(),
current_dir: self.current_dir.clone(),
},
)))
.await?;
// Wait until we get the first response, and get id from proc started
let (id, origin_id) = match mailbox.next().await {
Some(res) => {
let origin_id = res.origin_id;
match res.payload {
protocol::Msg::Single(protocol::Response::ProcSpawned { id }) => {
(id, origin_id)
}
protocol::Msg::Single(protocol::Response::Error(x)) => return Err(x.into()),
protocol::Msg::Single(x) => {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!("Got response type of {}", x.as_ref()),
))
}
protocol::Msg::Batch(_) => {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
"Got batch instead of single response",
));
}
}
}
None => return Err(io::Error::from(io::ErrorKind::ConnectionAborted)),
};
// Create channels for our stdin/stdout/stderr
let (stdin_tx, stdin_rx) = mpsc::channel(CLIENT_PIPE_CAPACITY);
let (stdout_tx, stdout_rx) = mpsc::channel(CLIENT_PIPE_CAPACITY);
let (stderr_tx, stderr_rx) = mpsc::channel(CLIENT_PIPE_CAPACITY);
let (resize_tx, resize_rx) = mpsc::channel(1);
// Used to terminate request task, either explicitly by the process or internally
// by the response task when it terminates
let (kill_tx, kill_rx) = mpsc::channel(1);
let kill_tx_2 = kill_tx.clone();
// Now we spawn a task to handle future responses that are async
// such as ProcStdout, ProcStderr, and ProcDone
let (abort_res_task_tx, mut abort_res_task_rx) = mpsc::channel::<()>(1);
let res_task = tokio::spawn(async move {
tokio::select! {
_ = abort_res_task_rx.recv() => {
panic!("killed");
}
res = process_incoming_responses(id, mailbox, stdout_tx, stderr_tx, kill_tx_2) => {
res
}
}
});
// Spawn a task that takes stdin from our channel and forwards it to the remote process
let (abort_req_task_tx, mut abort_req_task_rx) = mpsc::channel::<()>(1);
let req_task = tokio::spawn(async move {
tokio::select! {
_ = abort_req_task_rx.recv() => {
panic!("killed");
}
res = process_outgoing_requests( id, channel, stdin_rx, resize_rx, kill_rx) => {
res
}
}
});
let status = Arc::new(RwLock::new(None));
let status_2 = Arc::clone(&status);
let wait_task = tokio::spawn(async move {
let res = match tokio::try_join!(req_task, res_task) {
Ok((_, res)) => res.map(RemoteStatus::from),
Err(x) => Err(io::Error::new(io::ErrorKind::Interrupted, x)),
};
status_2.write().await.replace(res);
});
Ok(RemoteProcess {
id,
origin_id,
abort_req_task_tx,
abort_res_task_tx,
stdin: Some(RemoteStdin(stdin_tx)),
stdout: Some(RemoteStdout(stdout_rx)),
stderr: Some(RemoteStderr(stderr_rx)),
resizer: RemoteProcessResizer(resize_tx),
killer: RemoteProcessKiller(kill_tx),
wait_task,
status,
})
}
}
/// Represents a process on a remote machine
#[derive(Debug)]
pub struct RemoteProcess {
/// Id of the process
id: ProcessId,
/// Id used to map back to mailbox
origin_id: String,
// Sender to abort req task
abort_req_task_tx: mpsc::Sender<()>,
// Sender to abort res task
abort_res_task_tx: mpsc::Sender<()>,
/// Sender for stdin
pub stdin: Option<RemoteStdin>,
/// Receiver for stdout
pub stdout: Option<RemoteStdout>,
/// Receiver for stderr
pub stderr: Option<RemoteStderr>,
/// Sender for resize events
resizer: RemoteProcessResizer,
/// Sender for kill events
killer: RemoteProcessKiller,
/// Task that waits for the process to complete
wait_task: JoinHandle<()>,
/// Handles the success and exit code for a completed process
status: Arc<RwLock<Option<StatusResult>>>,
}
impl RemoteProcess {
/// Returns the id of the running process
pub fn id(&self) -> ProcessId {
self.id
}
/// Returns the id of the request that spawned this process
pub fn origin_id(&self) -> &str {
&self.origin_id
}
/// Checks if the process has completed, returning the exit status if it has, without
/// consuming the process itself. Note that this does not include join errors that can
/// occur when aborting and instead converts any error to a status of false. To acquire
/// the actual error, you must call `wait`
pub async fn status(&self) -> Option<RemoteStatus> {
self.status.read().await.as_ref().map(|x| match x {
Ok(status) => *status,
Err(_) => RemoteStatus {
success: false,
code: None,
},
})
}
/// Waits for the process to terminate, returning the success status and an optional exit code
pub async fn wait(self) -> io::Result<RemoteStatus> {
// Wait for the process to complete before we try to get the status
let _ = self.wait_task.await;
// NOTE: If we haven't received an exit status, this lines up with the UnexpectedEof error
self.status
.write()
.await
.take()
.unwrap_or_else(|| Err(errors::unexpected_eof()))
}
/// Waits for the process to terminate, returning the success status, an optional exit code,
/// and any remaining stdout and stderr (if still attached to the process)
pub async fn output(mut self) -> io::Result<RemoteOutput> {
let maybe_stdout = self.stdout.take();
let maybe_stderr = self.stderr.take();
let status = self.wait().await?;
let mut stdout = Vec::new();
if let Some(mut reader) = maybe_stdout {
while let Ok(data) = reader.read().await {
stdout.extend(&data);
}
}
let mut stderr = Vec::new();
if let Some(mut reader) = maybe_stderr {
while let Ok(data) = reader.read().await {
stderr.extend(&data);
}
}
Ok(RemoteOutput {
success: status.success,
code: status.code,
stdout,
stderr,
})
}
/// Resizes the pty of the remote process if it is attached to one
pub async fn resize(&self, size: PtySize) -> io::Result<()> {
self.resizer.resize(size).await
}
/// Clones a copy of the remote process pty resizer
pub fn clone_resizer(&self) -> RemoteProcessResizer {
self.resizer.clone()
}
/// Submits a kill request for the running process
pub async fn kill(&mut self) -> io::Result<()> {
self.killer.kill().await
}
/// Clones a copy of the remote process killer
pub fn clone_killer(&self) -> RemoteProcessKiller {
self.killer.clone()
}
/// Aborts the process by forcing its response task to shutdown, which means that a call
/// to `wait` will return an error. Note that this does **not** send a kill request, so if
/// you want to be nice you should send the request before aborting.
pub fn abort(&self) {
let _ = self.abort_req_task_tx.try_send(());
let _ = self.abort_res_task_tx.try_send(());
}
}
/// A handle to the channel to kill a remote process
#[derive(Clone, Debug)]
pub struct RemoteProcessResizer(mpsc::Sender<PtySize>);
impl RemoteProcessResizer {
/// Resizes the pty of the remote process if it is attached to one
pub async fn resize(&self, size: PtySize) -> io::Result<()> {
self.0
.send(size)
.await
.map_err(|_| errors::dead_channel())?;
Ok(())
}
}
/// A handle to the channel to kill a remote process
#[derive(Clone, Debug)]
pub struct RemoteProcessKiller(mpsc::Sender<()>);
impl RemoteProcessKiller {
/// Submits a kill request for the running process
pub async fn kill(&mut self) -> io::Result<()> {
self.0.send(()).await.map_err(|_| errors::dead_channel())?;
Ok(())
}
}
/// A handle to a remote process' standard input (stdin)
#[derive(Clone, Debug)]
pub struct RemoteStdin(mpsc::Sender<Vec<u8>>);
impl RemoteStdin {
/// Creates a disconnected remote stdin
pub fn disconnected() -> Self {
Self(mpsc::channel(1).0)
}
/// Tries to write to the stdin of the remote process, returning ok if immediately
/// successful, `WouldBlock` if would need to wait to send data, and `BrokenPipe`
/// if stdin has been closed
pub fn try_write(&mut self, data: impl Into<Vec<u8>>) -> io::Result<()> {
match self.0.try_send(data.into()) {
Ok(data) => Ok(data),
Err(TrySendError::Full(_)) => Err(io::Error::from(io::ErrorKind::WouldBlock)),
Err(TrySendError::Closed(_)) => Err(io::Error::from(io::ErrorKind::BrokenPipe)),
}
}
/// Same as `try_write`, but with a string
pub fn try_write_str(&mut self, data: impl Into<String>) -> io::Result<()> {
self.try_write(data.into().into_bytes())
}
/// Writes data to the stdin of a specific remote process
pub async fn write(&mut self, data: impl Into<Vec<u8>>) -> io::Result<()> {
self.0
.send(data.into())
.await
.map_err(|x| io::Error::new(io::ErrorKind::BrokenPipe, x))
}
/// Same as `write`, but with a string
pub async fn write_str(&mut self, data: impl Into<String>) -> io::Result<()> {
self.write(data.into().into_bytes()).await
}
/// Checks if stdin has been closed
pub fn is_closed(&self) -> bool {
self.0.is_closed()
}
}
/// A handle to a remote process' standard output (stdout)
#[derive(Debug)]
pub struct RemoteStdout(mpsc::Receiver<Vec<u8>>);
impl RemoteStdout {
/// Tries to receive latest stdout for a remote process, yielding `None`
/// if no stdout is available, and `BrokenPipe` if stdout has been closed
pub fn try_read(&mut self) -> io::Result<Option<Vec<u8>>> {
match self.0.try_recv() {
Ok(data) => Ok(Some(data)),
Err(TryRecvError::Empty) => Ok(None),
Err(TryRecvError::Disconnected) => Err(io::Error::from(io::ErrorKind::BrokenPipe)),
}
}
/// Same as `try_read`, but returns a string
pub fn try_read_string(&mut self) -> io::Result<Option<String>> {
self.try_read().and_then(|x| match x {
Some(data) => String::from_utf8(data)
.map(Some)
.map_err(|x| io::Error::new(io::ErrorKind::InvalidData, x)),
None => Ok(None),
})
}
/// Retrieves the latest stdout for a specific remote process, and `BrokenPipe` if stdout has
/// been closed
pub async fn read(&mut self) -> io::Result<Vec<u8>> {
self.0
.recv()
.await
.ok_or_else(|| io::Error::from(io::ErrorKind::BrokenPipe))
}
/// Same as `read`, but returns a string
pub async fn read_string(&mut self) -> io::Result<String> {
self.read().await.and_then(|data| {
String::from_utf8(data).map_err(|x| io::Error::new(io::ErrorKind::InvalidData, x))
})
}
}
/// A handle to a remote process' stderr
#[derive(Debug)]
pub struct RemoteStderr(mpsc::Receiver<Vec<u8>>);
impl RemoteStderr {
/// Tries to receive latest stderr for a remote process, yielding `None`
/// if no stderr is available, and `BrokenPipe` if stderr has been closed
pub fn try_read(&mut self) -> io::Result<Option<Vec<u8>>> {
match self.0.try_recv() {
Ok(data) => Ok(Some(data)),
Err(TryRecvError::Empty) => Ok(None),
Err(TryRecvError::Disconnected) => Err(io::Error::from(io::ErrorKind::BrokenPipe)),
}
}
/// Same as `try_read`, but returns a string
pub fn try_read_string(&mut self) -> io::Result<Option<String>> {
self.try_read().and_then(|x| match x {
Some(data) => String::from_utf8(data)
.map(Some)
.map_err(|x| io::Error::new(io::ErrorKind::InvalidData, x)),
None => Ok(None),
})
}
/// Retrieves the latest stderr for a specific remote process, and `BrokenPipe` if stderr has
/// been closed
pub async fn read(&mut self) -> io::Result<Vec<u8>> {
self.0
.recv()
.await
.ok_or_else(|| io::Error::from(io::ErrorKind::BrokenPipe))
}
/// Same as `read`, but returns a string
pub async fn read_string(&mut self) -> io::Result<String> {
self.read().await.and_then(|data| {
String::from_utf8(data).map_err(|x| io::Error::new(io::ErrorKind::InvalidData, x))
})
}
}
/// Helper function that loops, processing outgoing stdin requests to a remote process as well as
/// supporting a kill request to terminate the remote process
async fn process_outgoing_requests(
id: ProcessId,
mut channel: DistantChannel,
mut stdin_rx: mpsc::Receiver<Vec<u8>>,
mut resize_rx: mpsc::Receiver<PtySize>,
mut kill_rx: mpsc::Receiver<()>,
) -> io::Result<()> {
let result = loop {
tokio::select! {
data = stdin_rx.recv() => {
match data {
Some(data) => channel.fire(
Request::new(
protocol::Msg::Single(protocol::Request::ProcStdin { id, data })
)
).await?,
None => break Err(errors::dead_channel()),
}
}
size = resize_rx.recv() => {
match size {
Some(size) => channel.fire(
Request::new(
protocol::Msg::Single(protocol::Request::ProcResizePty { id, size })
)
).await?,
None => break Err(errors::dead_channel()),
}
}
msg = kill_rx.recv() => {
if msg.is_some() {
channel.fire(Request::new(
protocol::Msg::Single(protocol::Request::ProcKill { id })
)).await?;
break Ok(());
} else {
break Err(errors::dead_channel());
}
}
}
};
trace!("Process outgoing channel closed");
result
}
/// Helper function that loops, processing incoming stdout & stderr requests from a remote process
async fn process_incoming_responses(
proc_id: ProcessId,
mut mailbox: Mailbox<Response<protocol::Msg<protocol::Response>>>,
stdout_tx: mpsc::Sender<Vec<u8>>,
stderr_tx: mpsc::Sender<Vec<u8>>,
kill_tx: mpsc::Sender<()>,
) -> io::Result<(bool, Option<i32>)> {
while let Some(res) = mailbox.next().await {
let payload = res.payload.into_vec();
// Check if any of the payload data is the termination
let exit_status = payload.iter().find_map(|data| match data {
protocol::Response::ProcDone { id, success, code } if *id == proc_id => {
Some((*success, *code))
}
_ => None,
});
// Next, check for stdout/stderr and send them along our channels
// TODO: What should we do about unexpected data? For now, just ignore
for data in payload {
match data {
protocol::Response::ProcStdout { id, data } if id == proc_id => {
let _ = stdout_tx.send(data).await;
}
protocol::Response::ProcStderr { id, data } if id == proc_id => {
let _ = stderr_tx.send(data).await;
}
_ => {}
}
}
// If we got a termination, then exit accordingly
if let Some((success, code)) = exit_status {
// Flag that the other task should conclude
let _ = kill_tx.try_send(());
return Ok((success, code));
}
}
// Flag that the other task should conclude
let _ = kill_tx.try_send(());
trace!("Process incoming channel closed");
Err(errors::unexpected_eof())
}
mod errors {
use std::io;
pub fn dead_channel() -> io::Error {
io::Error::new(io::ErrorKind::BrokenPipe, "Channel is dead")
}
pub fn unexpected_eof() -> io::Error {
io::Error::from(io::ErrorKind::UnexpectedEof)
}
}
#[cfg(test)]
mod tests {
use std::time::Duration;
use distant_net::common::{FramedTransport, InmemoryTransport, Response};
use distant_net::Client;
use test_log::test;
use super::*;
use crate::client::DistantClient;
use crate::protocol::{Error, ErrorKind};
fn make_session() -> (FramedTransport<InmemoryTransport>, DistantClient) {
let (t1, t2) = FramedTransport::pair(100);
(t1, Client::spawn_inmemory(t2, Default::default()))
}
#[test(tokio::test)]
async fn spawn_should_return_invalid_data_if_received_batch_response() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Batch(vec![protocol::Response::ProcSpawned { id: 1 }]),
))
.await
.unwrap();
// Get the spawn result and verify
match spawn_task.await.unwrap() {
Err(x) if x.kind() == io::ErrorKind::InvalidData => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn spawn_should_return_invalid_data_if_did_not_get_a_indicator_that_process_started() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::Error(Error {
kind: ErrorKind::BrokenPipe,
description: String::from("some error"),
})),
))
.await
.unwrap();
// Get the spawn result and verify
match spawn_task.await.unwrap() {
Err(x) if x.kind() == io::ErrorKind::BrokenPipe => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn kill_should_return_error_if_internal_tasks_already_completed() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then abort it to make kill fail
let mut proc = spawn_task.await.unwrap().unwrap();
proc.abort();
// Ensure that the other tasks are aborted before continuing
tokio::task::yield_now().await;
match proc.kill().await {
Err(x) if x.kind() == io::ErrorKind::BrokenPipe => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn kill_should_send_proc_kill_request_and_then_cause_stdin_forwarding_to_close() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then kill it
let mut proc = spawn_task.await.unwrap().unwrap();
assert!(proc.kill().await.is_ok(), "Failed to send kill request");
// Verify the kill request was sent
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
match req.payload {
protocol::Msg::Single(protocol::Request::ProcKill { id: proc_id }) => {
assert_eq!(proc_id, id)
}
x => panic!("Unexpected request: {:?}", x),
}
// Verify we can no longer write to stdin anymore
assert_eq!(
proc.stdin
.as_mut()
.unwrap()
.write("some stdin")
.await
.unwrap_err()
.kind(),
io::ErrorKind::BrokenPipe
);
}
#[test(tokio::test)]
async fn stdin_should_be_forwarded_from_receiver_field() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then send stdin
let mut proc = spawn_task.await.unwrap().unwrap();
proc.stdin
.as_mut()
.unwrap()
.write("some input")
.await
.unwrap();
// Verify that a request is made through the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
match req.payload {
protocol::Msg::Single(protocol::Request::ProcStdin { id, data }) => {
assert_eq!(id, 12345);
assert_eq!(data, b"some input");
}
x => panic!("Unexpected request: {:?}", x),
}
}
#[test(tokio::test)]
async fn stdout_should_be_forwarded_to_receiver_field() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then read stdout
let mut proc = spawn_task.await.unwrap().unwrap();
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcStdout {
id,
data: b"some out".to_vec(),
}),
))
.await
.unwrap();
let out = proc.stdout.as_mut().unwrap().read().await.unwrap();
assert_eq!(out, b"some out");
}
#[test(tokio::test)]
async fn stderr_should_be_forwarded_to_receiver_field() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then read stderr
let mut proc = spawn_task.await.unwrap().unwrap();
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcStderr {
id,
data: b"some err".to_vec(),
}),
))
.await
.unwrap();
let out = proc.stderr.as_mut().unwrap().read().await.unwrap();
assert_eq!(out, b"some err");
}
#[test(tokio::test)]
async fn status_should_return_none_if_not_done() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then check its status
let proc = spawn_task.await.unwrap().unwrap();
let result = proc.status().await;
assert_eq!(result, None, "Unexpectedly got proc status: {:?}", result);
}
#[test(tokio::test)]
async fn status_should_return_false_for_success_if_internal_tasks_fail() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then abort it to make internal tasks fail
let proc = spawn_task.await.unwrap().unwrap();
proc.abort();
// Wait a bit to ensure the other tasks abort
tokio::time::sleep(Duration::from_millis(100)).await;
// Peek at the status to confirm the result
let result = proc.status().await;
match result {
Some(status) => {
assert!(!status.success, "Status unexpectedly reported success");
assert!(
status.code.is_none(),
"Status unexpectedly reported exit code"
);
}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn status_should_return_process_status_when_done() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then spawn a task for it to complete
let proc = spawn_task.await.unwrap().unwrap();
// Send a process completion response to pass along exit status and conclude wait
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcDone {
id,
success: true,
code: Some(123),
}),
))
.await
.unwrap();
// Wait a bit to ensure the status gets transmitted
tokio::time::sleep(Duration::from_millis(100)).await;
// Finally, verify that we complete and get the expected results
assert_eq!(
proc.status().await,
Some(RemoteStatus {
success: true,
code: Some(123)
})
);
}
#[test(tokio::test)]
async fn wait_should_return_error_if_internal_tasks_fail() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then abort it to make internal tasks fail
let proc = spawn_task.await.unwrap().unwrap();
proc.abort();
match proc.wait().await {
Err(x) if x.kind() == io::ErrorKind::Interrupted => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn wait_should_return_error_if_connection_terminates_before_receiving_done_response() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then terminate session connection
let proc = spawn_task.await.unwrap().unwrap();
// Ensure that the spawned task gets a chance to wait on stdout/stderr
tokio::task::yield_now().await;
drop(transport);
// Ensure that the other tasks are cancelled before continuing
tokio::task::yield_now().await;
match proc.wait().await {
Err(x) if x.kind() == io::ErrorKind::UnexpectedEof => {}
x => panic!("Unexpected result: {:?}", x),
}
}
#[test(tokio::test)]
async fn receiving_done_response_should_result_in_wait_returning_exit_information() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then spawn a task for it to complete
let proc = spawn_task.await.unwrap().unwrap();
let proc_wait_task = tokio::spawn(proc.wait());
// Send a process completion response to pass along exit status and conclude wait
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcDone {
id,
success: false,
code: Some(123),
}),
))
.await
.unwrap();
// Finally, verify that we complete and get the expected results
assert_eq!(
proc_wait_task.await.unwrap().unwrap(),
RemoteStatus {
success: false,
code: Some(123)
}
);
}
#[test(tokio::test)]
async fn receiving_done_response_should_result_in_output_returning_exit_information() {
let (mut transport, session) = make_session();
// Create a task for process spawning as we need to handle the request and a response
// in a separate async block
let spawn_task = tokio::spawn(async move {
RemoteCommand::new()
.spawn(session.clone_channel(), String::from("cmd arg"))
.await
});
// Wait until we get the request from the session
let req: Request<protocol::Msg<protocol::Request>> =
transport.read_frame_as().await.unwrap().unwrap();
// Send back a response through the session
let id = 12345;
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcSpawned { id }),
))
.await
.unwrap();
// Receive the process and then spawn a task for it to complete
let proc = spawn_task.await.unwrap().unwrap();
let proc_output_task = tokio::spawn(proc.output());
// Send some stdout
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcStdout {
id,
data: b"some out".to_vec(),
}),
))
.await
.unwrap();
// Send some stderr
transport
.write_frame_for(&Response::new(
req.id.clone(),
protocol::Msg::Single(protocol::Response::ProcStderr {
id,
data: b"some err".to_vec(),
}),
))
.await
.unwrap();
// Send a process completion response to pass along exit status and conclude wait
transport
.write_frame_for(&Response::new(
req.id,
protocol::Msg::Single(protocol::Response::ProcDone {
id,
success: false,
code: Some(123),
}),
))
.await
.unwrap();
// Finally, verify that we complete and get the expected results
assert_eq!(
proc_output_task.await.unwrap().unwrap(),
RemoteOutput {
success: false,
code: Some(123),
stdout: b"some out".to_vec(),
stderr: b"some err".to_vec(),
}
);
}
}