tokio-process-tools 0.9.0

Correctness-focused async subprocess orchestration for Tokio: bounded output, multi-consumer streams, output detection, guaranteed cleanup and graceful termination.
Documentation 
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

use super::*;
use crate::output_stream::backend::broadcast::BroadcastOutputStream;
use crate::test_support::{ScriptedOutput, long_running_command};
use crate::{
    BestEffortDelivery, DEFAULT_MAX_BUFFERED_CHUNKS, DEFAULT_READ_CHUNK_SIZE, NoReplay, NumBytesExt,
};
use assertr::prelude::*;

mod error_types;
mod kill;
mod preflight_reap;
mod signal_failures;
mod terminate;
#[cfg(windows)]
mod windows;

pub(super) fn immediately_exiting_command() -> tokio::process::Command {
    ScriptedOutput::builder().build()
}

pub(super) fn spawn_long_running_process()
-> ProcessHandle<BroadcastOutputStream<BestEffortDelivery, NoReplay>> {
    crate::Process::new(long_running_command(Duration::from_secs(5)))
        .name("long-running")
        .stdout_and_stderr(|stream| {
            stream
                .broadcast()
                .best_effort_delivery()
                .no_replay()
                .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
        })
        .spawn()
        .unwrap()
}

pub(super) fn spawn_immediately_exiting_process()
-> ProcessHandle<BroadcastOutputStream<BestEffortDelivery, NoReplay>> {
    crate::Process::new(immediately_exiting_command())
        .name("immediate-exit")
        .stdout_and_stderr(|stream| {
            stream
                .broadcast()
                .best_effort_delivery()
                .no_replay()
                .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
        })
        .spawn()
        .unwrap()
}

pub(super) fn successful_exit_status() -> ExitStatus {
    #[cfg(unix)]
    {
        use std::os::unix::process::ExitStatusExt;
        ExitStatus::from_raw(0)
    }

    #[cfg(windows)]
    {
        use std::os::windows::process::ExitStatusExt;
        ExitStatus::from_raw(0)
    }

    #[cfg(all(not(windows), not(unix)))]
    {
        unimplemented!("test exit status construction is only implemented on Unix and Windows")
    }
}

pub(super) fn assert_attempt_error(
    attempt_error: &TerminationAttemptError,
    expected_phase: TerminationAttemptPhase,
    expected_operation: TerminationAttemptOperation,
    expected_signal_name: Option<&'static str>,
    expected_kind: io::ErrorKind,
    expected_message: &str,
) {
    assert_that!(attempt_error.phase).is_equal_to(expected_phase);
    assert_that!(attempt_error.operation).is_equal_to(expected_operation);
    assert_that!(attempt_error.signal_name).is_equal_to(expected_signal_name);

    let io_error = attempt_error
        .source
        .downcast_ref::<io::Error>()
        .expect("diagnostic should preserve the original io::Error");

    assert_that!(io_error.kind()).is_equal_to(expected_kind);
    assert_that!(io_error.to_string().as_str()).contains(expected_message);
}