proc-heim 0.1.5

Library for running and managing short-lived and long-lived processes using asynchronous API
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
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

use std::time::Duration;

use proc_heim::{
    manager::{GetLogsError, LogsQuery},
    model::command::{Cmd, CmdOptions, LoggingType},
};
use test_utils::cmd_collection::{
    bash_script, echo_cmd_with_options,
    std_io::{echo_all_args_script_path, echo_stderr_script},
};

use crate::common::create_process_manager;

mod common;
mod test_cases;

#[tokio::test]
async fn should_read_logs_from_stdout() {
    check_logs_from_stdout(LoggingType::StdoutOnly, true).await;
    check_logs_from_stdout(LoggingType::StdoutAndStderr, true).await;
    check_logs_from_stdout(LoggingType::StdoutAndStderrMerged, true).await;
    check_logs_from_stdout(LoggingType::StderrOnly, false).await;
}

#[tokio::test]
async fn should_read_logs_from_stderr() {
    check_logs_from_stderr(LoggingType::StdoutOnly, false).await;
    check_logs_from_stderr(LoggingType::StdoutAndStderr, true).await;
    check_logs_from_stderr(LoggingType::StdoutAndStderrMerged, true).await;
    check_logs_from_stderr(LoggingType::StderrOnly, true).await;
}

async fn check_logs_from_stdout(logging_type: LoggingType, should_logs_be_set: bool) {
    let (_dir, handle) = create_process_manager();
    let log = "just an example log data";
    let cmd = echo_cmd_with_logging(log, logging_type);
    let process_id = handle.spawn(cmd).await.unwrap();
    let _ = handle.wait(process_id, Duration::from_millis(100)).await;

    let query = LogsQuery::fetch_all();
    let result = handle.get_logs_stdout(process_id, query).await;
    assert_logs(result, log, should_logs_be_set);
}

async fn check_logs_from_stderr(logging_type: LoggingType, should_logs_be_set: bool) {
    let (_dir, handle) = create_process_manager();
    let log = "funny error log data";
    let cmd = echo_to_stderr_cmd_with_logging(log, logging_type);
    let process_id = handle.spawn(cmd).await.unwrap();

    let _ = handle.wait(process_id, Duration::from_millis(100)).await;

    let query = LogsQuery::fetch_all();
    let result = handle.get_logs_stderr(process_id, query).await;
    assert_logs(result, log, should_logs_be_set);
}

fn assert_logs(
    result: Result<Vec<String>, GetLogsError>,
    expected_log: &str,
    should_logs_be_set: bool,
) {
    if should_logs_be_set {
        let logs = result.unwrap();
        assert_eq!(1, logs.len());
        assert_eq!(expected_log, logs.first().unwrap());
    } else {
        assert!(result.is_err());

        assert!(matches!(
            result.err().unwrap(),
            GetLogsError::LoggingTypeWasNotConfigured(_)
        ))
    }
}

fn echo_cmd_with_logging(msg: &str, logging_type: LoggingType) -> Cmd {
    let options = CmdOptions::with_logging(logging_type);
    echo_cmd_with_options(msg, options)
}

fn echo_to_stderr_cmd_with_logging(msg: &str, logging_type: LoggingType) -> Cmd {
    let options = CmdOptions::with_logging(logging_type);
    bash_script(echo_stderr_script(), options, vec![msg.into()])
}

#[tokio::test]
async fn should_query_logs_with_offset_and_limit() {
    let (_dir, handle) = create_process_manager();
    let expected_logs = generate_logs();
    let cmd = echo_all_args_script(&expected_logs);
    let process_id = handle.spawn(cmd).await.unwrap();

    let _ = handle.wait(process_id, Duration::from_millis(100)).await;

    let query = LogsQuery::with_limit(2);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[0..2], logs);

    let query = LogsQuery::with_offset(3);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[3..10], logs);

    let query = LogsQuery::with_offset_and_limit(0, 2);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[0..2], logs);

    let query = LogsQuery::with_offset_and_limit(1, 2);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[1..3], logs);

    let query = LogsQuery::with_offset_and_limit(5, 4);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[5..9], logs);

    let query = LogsQuery::with_offset_and_limit(5, 20);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[5..10], logs);

    let query = LogsQuery::with_offset_and_limit(9, 20);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert_eq!(expected_logs[9..10], logs);

    let query = LogsQuery::with_offset_and_limit(10, 1);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert!(logs.is_empty());

    let query = LogsQuery::with_offset_and_limit(11, 1);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert!(logs.is_empty());

    let query = LogsQuery::with_offset_and_limit(11, 0);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert!(logs.is_empty());

    let query = LogsQuery::with_offset_and_limit(2, 0);
    let logs = handle.get_logs_stdout(process_id, query).await.unwrap();
    assert!(logs.is_empty());
}

fn generate_logs() -> Vec<String> {
    let mut logs = Vec::new();
    for i in 0..10 {
        logs.push(format!("log no. {i}"));
    }
    logs
}

fn echo_all_args_script(args: &[String]) -> Cmd {
    let options = CmdOptions::with_logging(LoggingType::StdoutAndStderr);
    bash_script(echo_all_args_script_path(), options, args.to_vec())
}