linetime 1.0.0

Linetime is a command line utility to add timestamps at the start of lines. The tool can either process lines from stdin or execute a command and process lines from the command's stdout and stderr. 
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

use super::paths::LINETIME_PATH;
use regex::Regex;
use std::process::Stdio;
use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::process::{Child, ChildStderr, ChildStdin, ChildStdout};

/// A wrapper to run the linetime program with some arguments. It provides functions to expect
/// output on stdout and stderr.
pub struct Linetime {
    process: Child,
    stdin: Option<ChildStdin>,
    stdout: ChildStdout,
    stderr: ChildStderr,
    timestamp_regex: Regex,
    delta_regex: Regex,
}

impl Drop for Linetime {
    fn drop(&mut self) {
        if self.process.try_wait().unwrap().is_none() {
            eprintln!("Linetime process left by test. Attempting to kill!");
            // Use synchronous start_kill()/try_wait() since drop is not async
            self.process.start_kill().unwrap();
            for _ in 0..100 {
                if self.process.try_wait().unwrap().is_some() {
                    eprintln!("Linetime process killed successfully!");
                    return;
                }
                // Synchronous sleep with std, locks async runtime
                std::thread::sleep(Duration::from_millis(100));
            }
            eprintln!("Failed to kill linetime process");
        }
    }
}

impl Linetime {
    /// Runs linetime with the provided arguments
    pub fn run(args: Vec<std::ffi::OsString>) -> Self {
        Self::run_with_env(args, vec![])
    }

    /// Runs linetime with the provided arguments and environment variables
    pub fn run_with_env(
        args: Vec<std::ffi::OsString>,
        env_vars: Vec<(std::ffi::OsString, std::ffi::OsString)>,
    ) -> Self {
        let mut process = tokio::process::Command::new(LINETIME_PATH.as_path())
            .args(args)
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .envs(env_vars)
            .spawn()
            .expect("Should be able to run linetime");
        let stdin = Some(process.stdin.take().unwrap());
        let stdout = process.stdout.take().unwrap();
        let stderr = process.stderr.take().unwrap();
        Self {
            process,
            stdin,
            stdout,
            stderr,
            timestamp_regex: Regex::new("([0-9]+):([0-9]+).([0-9]+)").unwrap(),
            delta_regex: Regex::new(" \\(([0-9]+):([0-9]+).([0-9]+)\\)").unwrap(),
        }
    }

    /// Writes to the program's stdin
    pub async fn write_stdin(&mut self, text: &str) {
        let Some(stdin) = &mut self.stdin else {
            panic!("Linetime stdin has already been closed!");
        };
        stdin
            .write_all(text.as_bytes())
            .await
            .expect("Could not write to linetime stdin");
        stdin.flush().await.expect("Could not flush linetime stdin");
    }

    pub fn close_stdin(&mut self) {
        self.stdin = None;
    }

    /// Reads a timestamp from the program's stdout and returns it as a Duration
    pub async fn read_stdout_timestamp(&mut self) -> Result<Duration, std::io::Error> {
        Self::read_timestamp(&mut self.stdout, &self.timestamp_regex, "stdout", false).await
    }

    /// Reads a timestamp from the program's stdout and returns it as a Duration
    pub async fn read_stderr_timestamp(&mut self) -> Result<Duration, std::io::Error> {
        Self::read_timestamp(&mut self.stderr, &self.timestamp_regex, "stderr", false).await
    }

    /// Reads a timestamp from the program's stdout and returns it as a Duration
    pub async fn read_stdout_microsecond_timestamp(&mut self) -> Result<Duration, std::io::Error> {
        Self::read_timestamp(&mut self.stdout, &self.timestamp_regex, "stdout", true).await
    }

    /// Reads a delta time from the program's stdout and returns it as a Duration
    pub async fn read_stdout_delta(&mut self) -> Result<Duration, std::io::Error> {
        Self::read_delta(&mut self.stdout, &self.delta_regex, "stdout").await
    }

    /// Reads a delta time from the program's stderr and returns it as a Duration
    pub async fn read_stderr_delta(&mut self) -> Result<Duration, std::io::Error> {
        Self::read_delta(&mut self.stderr, &self.delta_regex, "stderr").await
    }

    /// Reads some text from the program's stdout and checks that it matches the expected text,
    /// otherwise it returns an error
    pub async fn read_stdout(&mut self, expected_text: &str) -> Result<(), std::io::Error> {
        let read_text = Self::read(&mut self.stdout, expected_text.len(), "stdout").await?;
        if read_text == expected_text {
            Ok(())
        } else {
            Err(std::io::Error::other(format!(
                "Expected to read '{expected_text}' from stdout but read '{read_text}'"
            )))
        }
    }

    /// Reads some text from the program's stderr and checks that it matches the expected text,
    /// otherwise it returns an error
    pub async fn read_stderr(&mut self, expected_text: &str) -> Result<(), std::io::Error> {
        let read_text = Self::read(&mut self.stderr, expected_text.len(), "stderr").await?;
        if read_text == expected_text {
            Ok(())
        } else {
            Err(std::io::Error::other(format!(
                "Expected to read '{expected_text}' from stderr but read '{read_text}'"
            )))
        }
    }

    /// Waits for program to end and checks that nothing more can be read from its stdout and stderr
    pub async fn wait(&mut self) -> std::process::ExitStatus {
        let mut stdout_rest = String::new();
        if self
            .stdout
            .read_to_string(&mut stdout_rest)
            .await
            .expect("Could not convert left-overs on linetime stdout to UTF-8")
            != 0
        {
            panic!("Nothing should be left on linetime stdout, but found '{stdout_rest}'");
        }

        let mut stderr_rest = String::new();
        if self
            .stderr
            .read_to_string(&mut stderr_rest)
            .await
            .expect("Could not convert left-overs on linetime stderr to UTF-8")
            != 0
        {
            panic!("Nothing should be left on linetime stderr, but found '{stderr_rest}'");
        }

        self.process
            .wait()
            .await
            .expect("Could not wait for linetime process to exit")
    }

    async fn read<R>(
        reader: &mut R,
        size: usize,
        reader_name: &str,
    ) -> Result<String, std::io::Error>
    where
        R: AsyncReadExt,
        R: Unpin,
    {
        let mut buffer = vec![0; size];
        reader.read_exact(&mut buffer).await?;
        Ok(String::from_utf8(buffer).unwrap_or_else(|error| panic!("Read {size} bytes from linetime {reader_name} but could not convert to UTF-8: {error}")))
    }

    async fn read_timestamp<R>(
        reader: &mut R,
        regex: &Regex,
        reader_name: &str,
        microseconds: bool,
    ) -> Result<Duration, std::io::Error>
    where
        R: AsyncReadExt,
        R: Unpin,
    {
        let expected_length = if microseconds { 12 } else { 9 };
        let read_text = Self::read(reader, expected_length, reader_name).await?;
        let Some(captures) = regex.captures(read_text.as_str()) else {
            return Err(std::io::Error::other(format!(
                "Could not find timestamp in linetime {reader_name} text '{read_text}'"
            )));
        };
        assert_eq!(4, captures.len());
        Ok(
            Duration::from_secs(60 * get_u64(&captures, 1) + get_u64(&captures, 2))
                + Duration::from_millis(get_u64(&captures, 3)),
        )
    }

    async fn read_delta<R>(
        reader: &mut R,
        regex: &Regex,
        reader_name: &str,
    ) -> Result<Duration, std::io::Error>
    where
        R: AsyncReadExt,
        R: Unpin,
    {
        let read_text = Self::read(reader, 12, reader_name).await?;
        let Some(captures) = regex.captures(read_text.as_str()) else {
            return Err(std::io::Error::other(format!(
                "Could not find delta time in linetime {reader_name} text '{read_text}'"
            )));
        };
        assert_eq!(4, captures.len());
        Ok(
            Duration::from_secs(60 * get_u64(&captures, 1) + get_u64(&captures, 2))
                + Duration::from_millis(get_u64(&captures, 3)),
        )
    }
}

fn get_u64(captures: &regex::Captures, i: usize) -> u64 {
    captures.get(i).unwrap().as_str().parse::<u64>().unwrap()
}