keyhog 0.5.40

keyhog: detects leaked credentials in source trees, git history, and cloud storage
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

//! Invariant: an unknown flag is rejected cleanly for EVERY subcommand under
//! EVERY profile. clap parses before the subcommand runs, so this is safe even
//! for daemon/watch/tui/scan-system (no long-running work executes).
//!
//! A premium CLI: exits 2 (usage error), names the offending flag or prints a
//! usage hint, never panics, never leaks ANSI. 16 × 16 = 256 distinct tests.

use crate::reliability::harness::{
    assert_clean_exit, assert_no_ansi, assert_no_panic, run, Profile,
};

const BOGUS_FLAG: &str = "--definitely-not-a-real-keyhog-flag";

pub fn badflag_invariant(profile: Profile, sub: &str) {
    let o = run(profile, &[sub, BOGUS_FLAG]);
    assert_clean_exit(&o);
    assert_no_panic(&o);
    assert_eq!(
        o.code,
        Some(2),
        "{}: an unknown flag must exit 2 (usage error), got {:?}\nstdout:\n{}\nstderr:\n{}",
        o.what,
        o.code,
        o.stdout.chars().take(200).collect::<String>(),
        o.stderr.chars().take(400).collect::<String>()
    );
    // clap routes errors to stderr; stdout must stay empty so a wrapper piping
    // stdout doesn't capture an error as data.
    assert!(
        o.stdout.trim().is_empty(),
        "{}: usage error wrote to stdout (should be stderr-only):\n{}",
        o.what,
        o.stdout.chars().take(300).collect::<String>()
    );
    let hint = o.stderr.to_lowercase();
    assert!(
        hint.contains("unexpected")
            || hint.contains("unknown")
            || hint.contains("usage")
            || hint.contains("help")
            || hint.contains("error"),
        "{}: usage error gave no actionable hint:\n{}",
        o.what,
        o.stderr.chars().take(300).collect::<String>()
    );
    // Under CLICOLOR_FORCE clap colors its error output by design; only treat
    // ANSI as a leak when color was not force-requested.
    if !profile.forces_color() {
        assert_no_ansi(&o);
    }
}

crate::kh_matrix!(
    crate::reliability::surface_badflag::badflag_invariant,
    scan => "scan",
    hook => "hook",
    detectors => "detectors",
    explain => "explain",
    diff => "diff",
    calibrate => "calibrate",
    watch => "watch",
    completion => "completion",
    backend => "backend",
    doctor => "doctor",
    update => "update",
    repair => "repair",
    uninstall => "uninstall",
    scan_system => "scan-system",
    daemon => "daemon",
    tui => "tui",
);