ratto 0.15.0

Ratatui-powered terminal primitives for shell dashboards: flicker-free repaints, progress bars, prompts, and portable time tools
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
mod common;

use assert_cmd::Command;

fn rat() -> Command {
    let mut cmd = common::rat();
    cmd.env_remove("NO_COLOR");
    cmd
}

/// Path to the rat binary, used as a portable child process: shell
/// utilities like sh, echo, and printf do not exist everywhere.
fn rat_bin() -> String {
    assert_cmd::cargo::cargo_bin("rat").display().to_string()
}

#[test]
fn once_prints_child_stdout_and_exits_zero() {
    rat()
        .args(["watch", "--once", "--", &rat_bin(), "style", "hi"])
        .assert()
        .success()
        .stdout(predicates::str::contains("hi"));
}

#[test]
fn piped_output_has_no_movement_or_cursor_escapes() {
    let assert = rat()
        .env("NO_COLOR", "1")
        .args(["watch", "--once", "--", &rat_bin(), "style", "hi"])
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    for escape in ["\x1b[?25l", "\x1b[?2026", "\x1b[0J", "\x1b[?2031h"] {
        assert!(!stdout.contains(escape), "found {escape:?} in {stdout:?}");
    }
}

#[test]
fn child_failure_does_not_fail_the_watch() {
    rat()
        .args(["watch", "--once", "--", &rat_bin(), "__exitcode", "3"])
        .assert()
        .success();
}

#[test]
fn missing_command_is_a_usage_error() {
    rat().args(["watch", "--once"]).assert().code(2);
}

#[test]
fn child_ansi_passes_through_verbatim() {
    rat()
        .env("TERM", "xterm-256color")
        .args([
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "--color",
            "always",
            "style",
            "--foreground",
            "212",
            "red",
        ])
        .assert()
        .success()
        .stdout(predicates::str::contains("\x1b[38;5;212mred\x1b[0m"));
}

#[test]
fn title_line_is_prepended() {
    rat()
        .env("NO_COLOR", "1")
        .args([
            "watch",
            "--once",
            "--title",
            "My Dashboard",
            "--",
            &rat_bin(),
            "style",
            "body",
        ])
        .assert()
        .success()
        .stdout(predicates::str::contains("My Dashboard"));
}

#[test]
fn bad_interval_is_an_error() {
    rat()
        .args([
            "watch",
            "-n",
            "bogus",
            "--once",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .code(1);
}

#[test]
fn spawn_failure_in_once_mode_fails_loudly() {
    rat()
        .args(["watch", "--once", "--", "definitely-no-such-binary-xyz"])
        .assert()
        .code(1)
        .stderr(predicates::str::contains("definitely-no-such-binary-xyz"));
}

// The --shell script is platform-specific by nature: sh on unix, the
// COMSPEC cmd on Windows.
#[cfg(unix)]
const SHELL_MATH: &str = "echo $((6 * 7))";
#[cfg(windows)]
const SHELL_MATH: &str = "set /a 6*7";

#[test]
fn shell_mode_runs_through_the_platform_shell() {
    rat()
        .args(["watch", "--once", "--shell", "--", SHELL_MATH])
        .assert()
        .success()
        .stdout(predicates::str::contains("42"));
}

#[cfg(unix)]
#[test]
fn a_named_shell_runs_the_command_through_it() {
    // sh exists on every unix, and the arithmetic only works via a
    // shell. Unix-only: this suite also runs on Windows, where a NAMED
    // `sh` does not exist — the windows twin names cmd instead.
    rat()
        .args(["watch", "--once", "--shell=sh", "--", "echo $((6 * 7))"])
        .assert()
        .success()
        .stdout(predicates::str::contains("42"));
}

#[test]
fn an_empty_shell_name_is_refused() {
    // An empty value is nearly always a variable that expanded to
    // nothing; silently taking the platform shell would hide it.
    for flag in ["--shell=", "--shell=   "] {
        rat()
            .args(["watch", "--once", flag, "--", "echo hi"])
            .assert()
            .code(1)
            .stderr(predicates::str::contains("names an empty shell"));
    }
}

#[test]
fn a_shell_name_needs_the_equals_sign() {
    // Without the equals requirement, `--shell fish` would swallow a
    // free-standing word as the shell name. Pin that it errors instead.
    rat()
        .args(["watch", "--once", "--shell", "fish", "--", "echo hi"])
        .assert()
        .failure()
        .stderr(predicates::str::contains("fish"));
}

#[cfg(windows)]
#[test]
fn a_named_cmd_computes_through_it() {
    // The windows twin of the unix `--shell=sh` arm: a NAMED cmd must
    // actually spawn and compute, not merely build a Command.
    rat()
        .args(["watch", "--once", "--shell=cmd", "--", "set /a 6*7"])
        .assert()
        .success()
        .stdout(predicates::str::contains("42"));
}

#[test]
fn a_shell_spawn_failure_names_the_shell() {
    // Under a shell mode the script is command[0]; the error must
    // blame the program that failed to start, not the script.
    rat()
        .args([
            "watch",
            "--once",
            "--shell=definitely-no-such-shell-xyz",
            "--",
            "date",
        ])
        .assert()
        .code(1)
        .stderr(predicates::str::contains("definitely-no-such-shell-xyz"));
}

#[test]
fn child_stderr_passes_through_when_piped() {
    rat()
        .env("NO_COLOR", "1")
        .args([
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "__exitcode",
            "0",
            "err",
        ])
        .assert()
        .success()
        .stderr(predicates::str::contains("err"));
}

#[test]
fn child_stderr_stays_off_stdout_when_piped() {
    let assert = rat()
        .env("NO_COLOR", "1")
        .args([
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "__exitcode",
            "0",
            "err",
        ])
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(
        !stdout.contains("err"),
        "stderr leaked into stdout: {stdout:?}"
    );
}

#[test]
fn clear_flag_stays_silent_when_piped() {
    let assert = rat()
        .env("NO_COLOR", "1")
        .args([
            "watch",
            "--clear",
            "--once",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(!stdout.contains("\x1b[2J"), "piped output must stay plain");
    assert!(stdout.contains("hi"));
}

#[test]
fn children_receive_the_frame_size_env() {
    rat()
        .env("NO_COLOR", "1")
        .args(["watch", "--once", "--", &rat_bin(), "__env", "RAT_WIDTH"])
        .assert()
        .success()
        .stdout(predicates::str::is_match(r"^[0-9]+\n$").unwrap());
    rat()
        .env("NO_COLOR", "1")
        .args(["watch", "--once", "--", &rat_bin(), "__env", "RAT_HEIGHT"])
        .assert()
        .success()
        .stdout(predicates::str::is_match(r"^[0-9]+\n$").unwrap());
}

#[test]
fn children_receive_the_appearance_env() {
    rat()
        .env("NO_COLOR", "1")
        .args([
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "__env",
            "RAT_APPEARANCE",
        ])
        .assert()
        .success()
        .stdout(predicates::str::is_match(r"^(light|dark)\n$").unwrap());
}

#[test]
fn the_parent_appearance_passes_through_to_children() {
    rat()
        .env("NO_COLOR", "1")
        .env("RAT_APPEARANCE", "light")
        .args([
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "__env",
            "RAT_APPEARANCE",
        ])
        .assert()
        .success()
        .stdout("light\n");
}

#[test]
fn an_explicit_parent_appearance_reaches_children() {
    rat()
        .env("NO_COLOR", "1")
        .args([
            "--appearance",
            "dark",
            "watch",
            "--once",
            "--",
            &rat_bin(),
            "__env",
            "RAT_APPEARANCE",
        ])
        .assert()
        .success()
        .stdout("dark\n");
}

#[test]
fn snapshot_flags_are_accepted() {
    // The flags ride along in scripted runs; --once has no input loop, so
    // no snapshot is ever taken and nothing lands in the directory.
    let dir = tempfile::tempdir().expect("tempdir");
    rat()
        .args([
            "watch",
            "--once",
            "--snapshot-dir",
            &dir.path().display().to_string(),
            "--snapshot-ansi",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .success()
        .stdout(predicates::str::contains("hi"));
    assert_eq!(
        std::fs::read_dir(dir.path()).expect("read tempdir").count(),
        0,
        "a snapshot appeared without the snapshot key"
    );
}

#[test]
fn no_wrap_is_accepted_and_leaves_piped_output_alone() {
    // The toggle is a tty-view feature: the piped branch prints lines raw
    // and never wrapped them in the first place, so --no-wrap changes
    // nothing there.
    let long_line = "x".repeat(200);
    rat()
        .args([
            "watch",
            "--once",
            "--no-wrap",
            "--",
            &rat_bin(),
            "style",
            &long_line,
        ])
        .assert()
        .success()
        .stdout(predicates::str::contains(long_line.as_str()));
}

/// The unified loop's piped-mode payoff: a signal lands between naps
/// instead of waiting out the child. The started file is child-side
/// evidence the slow tick is in flight before the signal is sent.
#[cfg(unix)]
#[test]
fn a_signal_ends_a_piped_watch_during_a_slow_child() {
    let dir = tempfile::tempdir().expect("tempdir");
    let started = dir.path().join("started");
    let script = format!(": > {}; /bin/sleep 5", started.display());
    let mut watch = std::process::Command::new(rat_bin())
        .args(["watch", "-n", "5s", "--shell", "--", &script])
        .stdout(std::process::Stdio::piped())
        .spawn()
        .expect("spawn rat watch piped");
    let deadline = std::time::Instant::now() + std::time::Duration::from_secs(3);
    while !started.exists() {
        assert!(
            std::time::Instant::now() < deadline,
            "the child never started"
        );
        std::thread::sleep(std::time::Duration::from_millis(20));
    }
    unsafe { libc::kill(watch.id() as i32, libc::SIGTERM) };
    // Reaped well inside the child's remaining ~5 s: the loop noticed
    // the flag between naps instead of waiting the child out.
    let deadline = std::time::Instant::now() + std::time::Duration::from_secs(3);
    loop {
        if let Some(status) = watch.try_wait().expect("try_wait") {
            assert!(status.success(), "the SIGTERM path returns Ok — exit 0");
            break;
        }
        assert!(
            std::time::Instant::now() < deadline,
            "SIGTERM waited out the child"
        );
        std::thread::sleep(std::time::Duration::from_millis(20));
    }
}

#[test]
fn a_trigger_conflicts_with_once() {
    rat()
        .args([
            "watch",
            "--once",
            "--trigger",
            "file:/tmp/x",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--once"));
}

#[test]
fn append_conflicts_with_fullscreen() {
    rat()
        .args([
            "watch",
            "--append",
            "--fullscreen",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--append"))
        .stderr(predicates::str::contains("cannot be used with"));
}

#[test]
fn append_conflicts_with_clear() {
    rat()
        .args([
            "watch",
            "--append",
            "--clear",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--append"))
        .stderr(predicates::str::contains("cannot be used with"));
}

#[test]
fn append_conflicts_with_mouse() {
    rat()
        .args([
            "watch",
            "--append",
            "--mouse",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--append"))
        .stderr(predicates::str::contains("cannot be used with"));
}

#[test]
fn append_conflicts_with_max_height() {
    rat()
        .args([
            "watch",
            "--append",
            "--max-height",
            "5",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--append"))
        .stderr(predicates::str::contains("cannot be used with"));
}

#[test]
fn append_conflicts_with_no_wrap() {
    rat()
        .args([
            "watch",
            "--append",
            "--no-wrap",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--append"))
        .stderr(predicates::str::contains("cannot be used with"));
}

#[test]
fn append_is_ignored_when_piped() {
    // A piped watch already IS the appended stream, so the flag changes
    // nothing there: byte-identical with
    // a_child_inside_the_bound_says_nothing_at_all's run.
    let assert = rat()
        .args([
            "watch",
            "--once",
            "--append",
            "--",
            &rat_bin(),
            "__lines",
            "3",
        ])
        .assert()
        .success();
    assert_eq!(
        String::from_utf8_lossy(&assert.get_output().stdout),
        "0\n1\n2\n"
    );
    assert_eq!(String::from_utf8_lossy(&assert.get_output().stderr), "");
}

#[test]
fn a_trigger_debounce_requires_a_trigger() {
    rat()
        .args([
            "watch",
            "--trigger-debounce",
            "1s",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("--trigger <SPEC>"));
}

#[test]
fn a_bare_path_trigger_spec_teaches_the_schemes() {
    rat()
        .args([
            "watch",
            "--trigger",
            "/tmp/x",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .failure()
        .stderr(predicates::str::contains("file:"));
}

/// Stream the piped watch's stdout through a channel so waiting for a
/// frame is bounded: a blocking read cannot swallow the deadline.
fn stdout_stream(stdout: std::process::ChildStdout) -> std::sync::mpsc::Receiver<Vec<u8>> {
    use std::io::Read;
    let (tx, rx) = std::sync::mpsc::channel();
    std::thread::spawn(move || {
        let mut stdout = stdout;
        let mut buf = [0u8; 4096];
        while let Ok(n) = stdout.read(&mut buf) {
            if n == 0 || tx.send(buf[..n].to_vec()).is_err() {
                return;
            }
        }
    });
    rx
}

/// Drain the stream until the needle appears — a missing frame is a
/// clean failure, never a hang.
fn read_until(stream: &std::sync::mpsc::Receiver<Vec<u8>>, seen: &mut String, needle: &str) {
    let deadline = std::time::Instant::now() + std::time::Duration::from_secs(10);
    loop {
        if seen.contains(needle) {
            return;
        }
        let left = deadline.saturating_duration_since(std::time::Instant::now());
        assert!(!left.is_zero(), "never saw {needle:?} in {seen:?}");
        match stream.recv_timeout(left) {
            Ok(chunk) => seen.push_str(&String::from_utf8_lossy(&chunk)),
            Err(_) => panic!("never saw {needle:?} in {seen:?}"),
        }
    }
}

/// Reap the watch even when an assertion panics: an orphaned watch
/// holds the harness's stdout pipe open and hangs the whole run.
struct KillOnDrop(std::process::Child);

impl Drop for KillOnDrop {
    fn drop(&mut self) {
        let _ = self.0.kill();
        let _ = self.0.wait();
    }
}

/// The portable trigger proof: a file change refreshes a PIPED watch —
/// the stat-poll runs before the non-interactive sleep, so event-driven
/// append-to-a-log works without a terminal, on every platform.
#[test]
fn a_file_trigger_refreshes_a_piped_watch() {
    let dir = tempfile::tempdir().expect("tempdir");
    let watched = dir.path().join("state");
    std::fs::write(&watched, "v0").expect("seed");
    // -n 1h parks the heartbeat out of the way: any second frame is the
    // trigger's doing, not the interval's.
    let watch = std::process::Command::new(rat_bin())
        .args([
            "watch",
            "-n",
            "1h",
            "--trigger",
            &format!("file:{}", watched.display()),
            "--trigger-debounce",
            "0ms",
            "--",
            &rat_bin(),
            "__cat",
            &watched.display().to_string(),
        ])
        .stdout(std::process::Stdio::piped())
        .spawn()
        .expect("spawn rat watch piped");
    let mut watch = KillOnDrop(watch);
    let stream = stdout_stream(watch.0.stdout.take().expect("piped stdout"));
    let mut seen = String::new();
    read_until(&stream, &mut seen, "v0"); // the immediate first tick
    std::fs::write(&watched, "v1").expect("mtime change");
    read_until(&stream, &mut seen, "v1"); // the trigger-driven frame
    // The guard's Drop kills and reaps — kill only SENDS the signal, and
    // an unreaped child would zombie (unix) and race tempdir cleanup.
}

#[test]
fn a_flooding_child_is_bounded_and_says_so_on_stderr() {
    // The plain path has no chrome row to carry a badge, and this is
    // the configuration the bound was reported against — so the marker
    // has to reach somewhere, and stdout is not available: it is the
    // data a consumer parses.
    let assert = rat()
        .args(["watch", "--once", "--", &rat_bin(), "__lines", "3000"])
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    let stderr = String::from_utf8_lossy(&assert.get_output().stderr).into_owned();

    let body: Vec<&str> = stdout.lines().collect();
    assert_eq!(body.len(), 1000, "the retained window is the bound");
    assert_eq!(body[0], "2000", "and it is the TAIL that survived");
    assert_eq!(body[999], "2999");

    assert!(
        stderr.contains("2.0k lines dropped"),
        "the drop must be reported somewhere; stderr was {stderr:?}"
    );
    assert!(
        !stdout.contains("dropped"),
        "and never in the data: {stdout:?}"
    );
}

#[test]
fn a_child_inside_the_bound_says_nothing_at_all() {
    // The common case stays byte-for-byte what it was: no marker, no
    // stderr, nothing added to a stream someone is parsing.
    let assert = rat()
        .args(["watch", "--once", "--", &rat_bin(), "__lines", "3"])
        .assert()
        .success();
    assert_eq!(
        String::from_utf8_lossy(&assert.get_output().stdout),
        "0\n1\n2\n"
    );
    assert_eq!(String::from_utf8_lossy(&assert.get_output().stderr), "");
}

#[test]
fn fullscreen_stays_silent_when_piped() {
    // Framing only makes sense on a terminal: a piped run must never
    // carry the alternate-screen escapes, exactly as --clear is
    // ignored piped.
    let assert = rat()
        .args([
            "watch",
            "--fullscreen",
            "--once",
            "--",
            &rat_bin(),
            "style",
            "hi",
        ])
        .assert()
        .success();
    let stdout = String::from_utf8_lossy(&assert.get_output().stdout).into_owned();
    assert!(
        !stdout.contains("\x1b[?1049"),
        "piped output must stay plain"
    );
    assert!(stdout.contains("hi"));
}