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
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

mod assertions;
mod marionette_control;
mod paths;
mod program_under_test;

use assertions::{
    assert_command_output_end, assert_input_end, assert_near, assert_ok, assert_timeout,
};
use program_under_test::Linetime;

use std::time::Duration;
use tokio::time::timeout;

fn to_os(strings: Vec<&str>) -> Vec<std::ffi::OsString> {
    strings.into_iter().map(|s| s.to_string().into()).collect()
}

#[tokio::test]
async fn stdin_is_read_when_no_command_is_executed() {
    let mut put = Linetime::run(vec![]);

    put.write_stdin("hello\n").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(": hello\n"));

    put.close_stdin();
    assert_input_end!(put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn stdout_from_command_is_read_when_command_is_executed() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    control.stdout("hello\n").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: hello\n"));

    control.exit(0).await;
    assert_command_output_end!(put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn stderr_from_command_is_read_when_command_is_executed() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    control.stderr("hello\n").await;
    assert_ok!(put.read_stderr_timestamp());
    assert_ok!(put.read_stderr(" stderr: hello\n"));

    control.exit(0).await;
    assert_command_output_end!(put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn output_lines_get_ordererd_timestamps() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    control.stdout("hello\n").await;
    let t1 = assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: hello\n"));

    control.stdout("world\n").await;
    let t2 = assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: world\n"));
    assert!(t2 >= t1);

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn microsecond_precison_can_be_enabled() {
    let mut put = Linetime::run(to_os(vec!["--micros"]));

    put.write_stdin("hello\n").await;
    let t1 = assert_ok!(put.read_stdout_microsecond_timestamp());
    assert_ok!(put.read_stdout(": hello\n"));

    put.write_stdin("world\n").await;
    let t2 = assert_ok!(put.read_stdout_microsecond_timestamp());
    assert_ok!(put.read_stdout(": world\n"));
    assert!(t2 >= t1);

    put.close_stdin();
    let t3 = assert_ok!(put.read_stdout_microsecond_timestamp());
    assert_ok!(put.read_stdout(": ⏱ End\n"));
    assert!(t3 >= t2);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn delta_times_can_be_shown_after_timestamp() {
    let mut put = Linetime::run(to_os(vec!["--show-delta"]));

    put.write_stdin("hello\n").await;
    let t1 = assert_ok!(put.read_stdout_timestamp());
    // Blank space left for first line instead of delta time
    assert_ok!(put.read_stdout("            : hello\n"));

    put.write_stdin("world\n").await;
    let t2 = assert_ok!(put.read_stdout_timestamp());
    let d2 = assert_ok!(put.read_stdout_delta());
    assert_ok!(put.read_stdout(": world\n"));

    assert!(t2 >= t1);
    // Allow 1 ms rounding error
    assert_near!(t2 - t1, d2, Duration::from_millis(1));

    put.close_stdin();
    let t3 = assert_ok!(put.read_stdout_timestamp());
    let d3 = assert_ok!(put.read_stdout_delta());
    assert_ok!(put.read_stdout(": ⏱ End\n"));
    assert!(t3 >= t2);
    assert_near!(t3 - t2, d3, Duration::from_millis(1));

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn delta_times_are_common_for_stderr_and_stdout() {
    let mut args = to_os(vec!["--show-delta"]);
    args.append(&mut marionette_control::app_path_and_args(vec![]));
    let mut put = Linetime::run(args);
    let mut control = marionette_control::Bar::new().await;

    control.stdout("hello\n").await;
    let t1 = assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout("             stdout: hello\n"));

    control.stderr("some\n").await;
    let t2 = assert_ok!(put.read_stderr_timestamp());
    let d2 = assert_ok!(put.read_stderr_delta());
    assert_ok!(put.read_stderr(" stderr: some\n"));
    assert!(t2 >= t1);
    assert_near!(t2 - t1, d2, Duration::from_millis(1));

    control.stdout("world\n").await;
    let t3 = assert_ok!(put.read_stdout_timestamp());
    let d3 = assert_ok!(put.read_stdout_delta());
    assert_ok!(put.read_stdout(" stdout: world\n"));
    assert!(t3 >= t2);
    assert_near!(t3 - t2, d3, Duration::from_millis(1));

    control.exit(0).await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout_delta());
    assert_ok!(put.read_stdout(" ------: ⏱ End\n"));

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn input_from_stdin_is_not_buffered_to_print_complete_lines_if_flushed() {
    let mut put = Linetime::run(to_os(vec!["--flush-all"]));

    put.write_stdin("hello").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(": hello"));

    put.write_stdin("world!\n").await;
    assert_ok!(put.read_stdout("world!\n"));

    put.close_stdin();
    assert_input_end!(put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn input_from_stdout_is_not_buffered_to_print_complete_lines_if_flushed() {
    let mut args = to_os(vec!["--flush-all"]);
    args.append(&mut marionette_control::app_path_and_args(vec![]));
    let mut put = Linetime::run(args);
    let mut control = marionette_control::Bar::new().await;

    control.stdout("hello").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: hello"));

    control.stdout("world!\n").await;
    assert_ok!(put.read_stdout("world!\n"));

    control.exit(0).await;
    assert_command_output_end!(put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn input_from_command_is_buffered_to_print_complete_lines_even_for_stderr() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    control.stdout("aaa").await;
    assert_timeout!(put.read_stdout_timestamp());
    control.stderr("bbb\n").await;
    assert_ok!(put.read_stderr_timestamp());
    assert_ok!(put.read_stderr(" stderr: bbb\n"));
    control.stdout("ccc\n").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: aaaccc\n"));

    control.stderr("aaa").await;
    assert_timeout!(put.read_stderr_timestamp());
    control.stdout("bbb\n").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: bbb\n"));
    control.stderr("ccc\n").await;
    assert_ok!(put.read_stderr_timestamp());
    assert_ok!(put.read_stderr(" stderr: aaaccc\n"));

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn input_from_command_is_not_buffered_to_print_complete_lines_without_line_buffering() {
    let mut args = to_os(vec!["--no-line-buffering"]);
    args.append(&mut marionette_control::app_path_and_args(vec![]));
    let mut put = Linetime::run(args);
    let mut control = marionette_control::Bar::new().await;

    control.stderr("hello").await;
    assert_ok!(put.read_stderr_timestamp());
    assert_ok!(put.read_stderr(" stderr: hello"));
    control.stdout("hola\n").await;
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(" stdout: hola\n"));
    control.stderr("world\n").await;
    assert_ok!(put.read_stderr("world\n"));

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn application_exits_with_same_exit_code_as_command() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    control.exit(17).await;
    assert_command_output_end!(&mut put);
    assert_ok!(put.read_stderr("Command exited with 17\n"));

    let exit_status = put.wait().await;
    assert!(!exit_status.success());
    assert_eq!(Some(17), exit_status.code());
}

#[tokio::test]
async fn arguments_are_forwarded_to_command() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![
        "--option", "value",
    ]));
    let mut control = marionette_control::Bar::new().await;

    let args = control.args().await;
    // Ignore program name and port argument
    assert_eq!(vec!["--option", "value"], args[2..]);

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn environment_variables_are_forwarded_to_command() {
    let mut put = Linetime::run_with_env(
        marionette_control::app_path_and_args(vec![]),
        vec![("variable".into(), "value".into())],
    );
    let mut control = marionette_control::Bar::new().await;

    assert_eq!(
        vec![("variable".to_string(), "value".to_string())],
        control
            .env()
            .await
            .into_iter()
            .filter(|(var, _)| var == "variable")
            .collect::<Vec<_>>()
    );

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn stdin_is_ignored_when_command_is_executed() {
    let mut put = Linetime::run(marionette_control::app_path_and_args(vec![]));
    let mut control = marionette_control::Bar::new().await;

    put.write_stdin("ignored line").await;
    assert_timeout!(put.read_stdout_timestamp());

    control.exit(0).await;
    assert_command_output_end!(&mut put);

    assert!(put.wait().await.success());
}

#[tokio::test]
async fn escape_sequence_to_move_cursor_is_swallowed_to_unfold_lines() {
    let mut put = Linetime::run(vec![]);

    put.write_stdin("hello").await;
    // ESC[2K = erase entire line
    put.write_stdin("\x1b[2K").await;
    // ESC[H = move cursor home
    put.write_stdin("\x1b[H").await;
    put.write_stdin("world\n").await;

    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(": hello\n"));
    // New line and timestamp, since unfolding instead of printing erase or cursor escape sequences
    assert_ok!(put.read_stdout_timestamp());
    assert_ok!(put.read_stdout(": world\n"));

    put.close_stdin();
    assert_input_end!(put);

    assert!(put.wait().await.success());
}