patchsense 0.1.1

Prioritize vulnerabilities from lockfiles using OSV, EPSS, and CISA KEV
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

//! Scan progress on stderr. The bar exists only when stderr is a terminal.

use std::io::IsTerminal;
use std::time::Duration;

use indicatif::{ProgressBar, ProgressStyle};

/// Whether stderr is a terminal.
pub fn stderr_is_tty() -> bool {
    std::io::stderr().is_terminal()
}

/// Whether stdout is a terminal.
pub fn stdout_is_tty() -> bool {
    std::io::stdout().is_terminal()
}

/// Color is on only for a TTY, and off for `--no-color` or `NO_COLOR`.
pub fn colors_enabled(no_color_flag: bool, no_color_env: bool, stdout_tty: bool) -> bool {
    stdout_tty && !no_color_flag && !no_color_env
}

/// Progress is drawn only when stderr is a terminal.
pub fn show_progress(stderr_tty: bool) -> bool {
    stderr_tty
}

/// Spinner for the scan. `None` when progress must stay off.
pub fn start_scan_progress(stderr_tty: bool) -> Option<ProgressBar> {
    if !show_progress(stderr_tty) {
        return None;
    }
    let bar = ProgressBar::new_spinner();
    if let Ok(style) = ProgressStyle::with_template("{spinner} {msg}") {
        bar.set_style(style);
    }
    bar.set_message("scanning lockfiles");
    bar.enable_steady_tick(Duration::from_millis(120));
    Some(bar)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn progress_and_color_stay_off_without_a_tty() {
        assert!(!show_progress(false));
        assert!(show_progress(true));
        assert!(!colors_enabled(false, false, false));
        assert!(!colors_enabled(true, false, true));
        assert!(!colors_enabled(false, true, true));
        assert!(colors_enabled(false, false, true));
        assert!(start_scan_progress(false).is_none());
    }
}